ImFusion::CT::DetectorPropertiesDataComponent Class Reference

#include <ImFusion/CT/Geometry/DetectorPropertiesDataComponent.h>

Data component for detector properties and configuration Stores detector-specific parameters and settings for cone-beam systems. More...

Inheritance diagram for ImFusion::CT::DetectorPropertiesDataComponent:

Detailed Description

Data component for detector properties and configuration Stores detector-specific parameters and settings for cone-beam systems.

Public Types
enum class	Curvature { FLAT , CYLINDRICAL , FANFLAT }

Public Member Functions
std::string	id () const override
	Returns a unique string identifier for this type of data component.
bool	operator== (const DetectorPropertiesDataComponent &other) const
	Compares members for equality, for the geometry member only matrices for all frames are compared.
Public Member Functions inherited from ImFusion::DataComponent< DetectorPropertiesDataComponent >
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 ImFusion::Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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

Static Public Member Functions
static const DetectorPropertiesDataComponent &	getOrCreate (const SharedImageSet &sis)
	Shortcut to get or create DetectorPropertiesDataComponent from a SharedImageSet.
static DetectorPropertiesDataComponent &	getOrCreate (SharedImageSet &sis)
	Shortcut to get or create DetectorPropertiesDataComponent from a SharedImageSet.
static const DetectorPropertiesDataComponent *	get (const SharedImageSet &sis)
	Shortcut to get DetectorPropertiesDataComponent from a SharedImageSet.
static DetectorPropertiesDataComponent *	get (SharedImageSet &sis)
	Shortcut to get DetectorPropertiesDataComponent from a SharedImageSet.
static DetectorPropertiesDataComponent	copyOrCreateFromLegacyGeometry (const SharedImageSet &sis)
	This function offers a unified approach to get a suitable DetectorPropertiesDataComponent from a SharedImageSet.

Public Attributes
Parameter< Curvature >	p_curvature = {"curvature", Curvature::FLAT, *this}
Parameter< std::vector< vec2 > >	p_curvedOffsets = {"curvedOffsets", std::vector<vec2>(), *this}
	The per frame offsets (in mm) on the curved detector to the center of the image.
Parameter< std::optional< std::vector< float > > >	p_radii = {"radius", std::nullopt, *this}
	Radii of the curvature per frame, if not set the source-detector-distance will be used.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

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

Member Function Documentation

getOrCreate() [1/2]

const DetectorPropertiesDataComponent & ImFusion::CT::DetectorPropertiesDataComponent::getOrCreate ( const SharedImageSet & sis )

static

Shortcut to get or create DetectorPropertiesDataComponent from a SharedImageSet.

It will get or create the DetectorPropertiesDataComponent in sis.components()

getOrCreate() [2/2]

DetectorPropertiesDataComponent & ImFusion::CT::DetectorPropertiesDataComponent::getOrCreate ( SharedImageSet & sis )

static

Shortcut to get or create DetectorPropertiesDataComponent from a SharedImageSet.

It will get or create the DetectorPropertiesDataComponent in sis.components()

get() [1/2]

const DetectorPropertiesDataComponent * ImFusion::CT::DetectorPropertiesDataComponent::get ( const SharedImageSet & sis )

static

Shortcut to get DetectorPropertiesDataComponent from a SharedImageSet.

It will get the DetectorPropertiesDataComponent in sis.components() if exists, otherwise return a nullptr.

get() [2/2]

DetectorPropertiesDataComponent * ImFusion::CT::DetectorPropertiesDataComponent::get ( SharedImageSet & sis )

static

Shortcut to get DetectorPropertiesDataComponent from a SharedImageSet.

It will get the DetectorPropertiesDataComponent in sis.components() if exists, otherwise return a nullptr.

copyOrCreateFromLegacyGeometry()

DetectorPropertiesDataComponent ImFusion::CT::DetectorPropertiesDataComponent::copyOrCreateFromLegacyGeometry ( const SharedImageSet & sis )

static

This function offers a unified approach to get a suitable DetectorPropertiesDataComponent from a SharedImageSet.

For legacy geometry (i.e. ConeBeamGeometry), a new DetectorPropertiesDataComponent will be created and initialized from ConeBeamGeometry::useFanBeam Else if a DetectorPropertiesDataComponent exists, a copy of this is returned.

id()

std::string ImFusion::CT::DetectorPropertiesDataComponent::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 ImFusion::DataComponentBase.

---

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

• ImFusion/CT/Geometry/DetectorPropertiesDataComponent.h