ReferencedInstancesComponent Class Reference

#include <ImFusion/Dicom/DicomDataComponents.h>

DataComponent to store DICOM instances that are referenced by the dataset. More...

Inheritance diagram for ReferencedInstancesComponent:

Detailed Description

DataComponent to store DICOM instances that are referenced by the dataset.

A DICOM dataset can reference a number of other DICOM datasets that are somehow related. The references in this component are determined by the ReferencedSeriesSequence.

This component is currently only created for DICOM Segmentation and RTStruct SOPs.

Classes
struct	ReferencedInstance

Public Types
using	SeriesInstanceUID = std::string

Public Member Functions
bool	operator== (const ReferencedInstancesComponent &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	setSeries (std::map< SeriesInstanceUID, std::set< ReferencedInstance > > series)
	Overwrite the current references with the given references.
void	addSeries (const std::map< SeriesInstanceUID, std::set< ReferencedInstance > > &series)
	Add the given references to the existing references.
bool	isReferencing (const SourceInfoComponent &sic) const
	Returns true if the instances of the given SourceInfoComponent are referenced by this component.
bool	isReferencing (const SharedImageSet &sis) const
	Convenient method that calls the above method with SourceInfoComponent of sis.
const std::map< SeriesInstanceUID, std::set< ReferencedInstance > > &	series () const
	Returns all referenced series instance UIDs together with the referenced instances.
Public Member Functions inherited from DataComponent< ReferencedInstancesComponent >
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.

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.

isReferencing() [1/2]

bool isReferencing

(

const SourceInfoComponent &

sic

)

const

Returns true if the instances of the given SourceInfoComponent are referenced by this component.

The instances and references have to only intersect for this to return true. This way, e.g. a segmentation would be considered referencing a CT if it only overlaps in a view slices.

isReferencing() [2/2]

bool isReferencing

(

const SharedImageSet &

sis

)

const

Convenient method that calls the above method with SourceInfoComponent of sis.

Only returns true if all elementwise SourceInfoComponents are referenced.

---

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

• ImFusion/Dicom/DicomDataComponents.h