ImageInfoDataComponent Class Reference

#include <ImFusion/Base/ImageInfoDataComponent.h>

DataComponent storing general information on the image origin. More...

Inheritance diagram for ImageInfoDataComponent:

Detailed Description

DataComponent storing general information on the image origin.

Modeled after the DICOM patient-study-series hierarchy, it stores information on the patient, study and series the data set belongs to.

Public Types
enum class	PatientSex { Unknown , Male , Female , Other }
	Gender of the patient.
enum class	Laterality { Unknown , Left , Right }
	Laterality of (paired) body part examined.
enum class	AnatomicalOrientationType { Unknown , Biped , Quadruped }
	DICOM Anatomical Orientation Type.

Public Member Functions
	ImageInfoDataComponent (const ImageInfoDataComponent &other)=default
ImageInfoDataComponent &	operator= (const ImageInfoDataComponent &other)=default
bool	operator== (const ImageInfoDataComponent &other) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
void	setModality (Data::Modality modality)
Public Member Functions inherited from DataComponent< ImageInfoDataComponent >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Public Attributes
std::string	m_patientId
	DICOM Patient ID.
std::string	m_patientName
	Patient name.
std::string	m_responsiblePerson
	Name of person with medical or welfare decision making authority for the Patient.
std::string	m_patientBirthDate
	Patient date of birth in yyyyMMdd format.
PatientSex	m_patientSex = PatientSex::Unknown
	Patient sex.
std::string	m_patientComment
	Additional information about the Patient.
std::string	m_patientPosition
	Specifies position of the Patient relative to the imaging equipment.
std::string	m_studyId
	DICOM Study ID.
std::string	m_studyDate
	Study date in yyyyMMdd format.
std::string	m_studyTime
	Study time in HHmmss format, optionally with time zone offset &ZZXX.
std::chrono::microseconds	m_studyTimeExact
	Study time in microseconds. 0 if the original study time was empty.
std::string	m_studyTimezone
	Study time zone abbreviation.
std::string	m_studyDescription
	Study description.
std::string	m_studyInstanceUID
	Unique identifier for the Study.
std::string	m_seriesNumber
	DICOM Series number. The value of this attribute should be unique for all Series in a Study created on the same equipment.
std::string	m_seriesDate
	Series date in yyyyMMdd format.
std::string	m_seriesTime
	Series time in HHmmss format.
std::chrono::microseconds	m_seriesTimeExact
	Series time in microseconds. 0 if the original series time was empty.
std::string	m_seriesDescription
	Series description.
std::string	m_seriesInstanceUID
	Unique identifier of the Series.
std::string	m_modality
	DICOM modality string specifying the method used to create this series.
Laterality	m_laterality = Laterality::Unknown
	Laterality of (paired) body part examined.
std::string	m_photometricInterpretation
	Specifies the intended interpretation of the pixel data (e.g. RGB, HSV, ...).
std::string	m_frameOfReferenceUID
	Uniquely identifies the Frame of Reference for a Series. Multiple Series within a Study may share a Frame of Reference UID.
AnatomicalOrientationType	m_orientationType = AnatomicalOrientationType::Unknown
	DICOM Anatomical Orientation Type.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

Member Data Documentation

m_studyTimeExact

std::chrono::microseconds m_studyTimeExact

Initial value:

=
            std::chrono::microseconds(0)

Study time in microseconds. 0 if the original study time was empty.

m_seriesTimeExact

std::chrono::microseconds m_seriesTimeExact

Initial value:

=
            std::chrono::microseconds(0)

Series time in microseconds. 0 if the original series time was empty.

---

The documentation for this class was generated from the following file:

• ImFusion/Base/ImageInfoDataComponent.h