RTStructureDataComponent Class Reference

#include <ImFusion/Dicom/RTStructureDataComponent.h>

DataComponent for PointClouds loaded from a DICOM RTStructureSet. More...

Inheritance diagram for RTStructureDataComponent:

Detailed Description

DataComponent for PointClouds loaded from a DICOM RTStructureSet.

Provides information about the original structure/grouping of the points. See RTStructureIoAlgorithm for details about how RTStructureSets are loaded.

WARNING: Since this component uses fixed indices into the PointCloud's points structure, it can only be used if the PointCloud remains unchanged!

Classes
struct	Contour
	Represents a single item in the original 'Contour Sequence' (3006,0040). More...

Public Member Functions
bool	operator== (const RTStructureDataComponent &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.
Public Member Functions inherited from DataComponent< RTStructureDataComponent >
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::vector< Contour >	contours
	List containing information of the original 'Contour Sequence' items.
vec3	color = vec3::Zero()
	Color of the contours.
std::string	referencedFrameOfReferenceUID
	Dataset (identified by FrameOfReferenceUID) in which the contours are defined.
ROIGenerationAlgorithm	generationAlgorithm = ROIGenerationAlgorithm::Unknown
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

referencedFrameOfReferenceUID

std::string referencedFrameOfReferenceUID

Dataset (identified by FrameOfReferenceUID) in which the contours are defined.

The frameOfReferenceUID is usually stored in the ImFusion::ImageInfoDataComponent.

---

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

• ImFusion/Dicom/RTStructureDataComponent.h