RealWorldMappingDataComponent Class Reference

#include <ImFusion/Base/RealWorldMappingDataComponent.h>

The RealWorldMappingDataComponent stores information about an image's real world values. More...

Inheritance diagram for RealWorldMappingDataComponent:

Detailed Description

The RealWorldMappingDataComponent stores information about an image's real world values.

The data component can provide multiple mappings that are usually derived from DICOM.

Classes
struct	Mapping

Public Types
enum class	MappingType { RealWorldValues = 0 , StandardizedUptakeValues = 1 }

Public Member Functions
	RealWorldMappingDataComponent (const RealWorldMappingDataComponent &other)=default
RealWorldMappingDataComponent &	operator= (const RealWorldMappingDataComponent &other)=default
bool	operator== (const RealWorldMappingDataComponent &other) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
std::string	rescaleUnit () const
	Returns the real world unit of the intensities.
void	setRescaleType (const std::string &rescaleType)
	Sets the DICOM RescaleType of the image.
bool	addRealWorldValueMapping (const SharedImageSet &parent, const std::string &unit, double intercept, double slope)
	Add a Real-World-Value-Mapping for the given unit.
bool	addStandardizedUptakeValueMapping (const SharedImageSet &parent, double patientWeightKg, double radionuclideHalfLife, double radionuclideTotalDose, std::chrono::seconds timeDifference)
	Add a Standardized Uptake Value based on body weight mapping.
const std::vector< Mapping > &	getMappings () const
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.
Public Member Functions inherited from DataComponent< RealWorldMappingDataComponent >
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

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
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.

rescaleUnit()

std::string rescaleUnit

(

)

const

Returns the real world unit of the intensities.

An example would be 'HU' for Hounsfield units in CT images or 'Bq/ml' in PET images. The returned value does not garantuee a specific formatting or scheme and should only be used for display purposes. Returns an empty string if no unit is available.

addRealWorldValueMapping()

bool addRealWorldValueMapping	(	const SharedImageSet &	parent,
		const std::string &	unit,
		double	intercept,
		double	slope )

Add a Real-World-Value-Mapping for the given unit.

The intercept and slope values map from Storage Values (SV) to Real-World Values (RWV): Internally the mapping will be transformed to apply from Original Values (OV) to RWV. Like this, the mapping remains valid even when the storage values change. Mappings can only be added if the parent image has the same shift and scale for each image. If this is not the case, no mapping is added.

addStandardizedUptakeValueMapping()

bool addStandardizedUptakeValueMapping	(	const SharedImageSet &	parent,
		double	patientWeightKg,
		double	radionuclideHalfLife,
		double	radionuclideTotalDose,
		std::chrono::seconds	timeDifference )

Add a Standardized Uptake Value based on body weight mapping.

This mapping is usually only used for PET data.

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.

---

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

• ImFusion/Base/RealWorldMappingDataComponent.h