ImFusion C++ SDK 4.4.0
ImFusion::CT::DetectorDataComponent Class Reference

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

DataComponent to store the transformation from world to detector space for a single frame. More...

Inheritance diagram for ImFusion::CT::DetectorDataComponent:

Detailed Description

DataComponent to store the transformation from world to detector space for a single frame.

The detector coordinate space is defined as the image coordinate space of the detector image. I.e. a right handed coordinate system with the x-axis pointing to the right, the y-axis pointing down and the z-axis pointing into the detector.

Public Member Functions

 DetectorDataComponent (const DetectorDataComponent &)=default
DetectorDataComponent & operator= (const DetectorDataComponent &)=default
 DetectorDataComponent (DetectorDataComponent &&)=default
DetectorDataComponent & operator= (DetectorDataComponent &&)=default
bool operator== (const DetectorDataComponent &other) const
std::string id () const override
 Returns a unique string identifier for this type of data component.
Public Member Functions inherited from ImFusion::DataComponent< DetectorDataComponent >
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 DetectorDataComponent & getOrCreate (SharedImageSet &sis, int frame)
 Get or create the DetectorDataComponent for a given frame in a SharedImageSet.
static const DetectorDataComponent * get (const SharedImageSet &sis, int frame)
 Get the DetectorDataComponent for a given frame in a SharedImageSet.
static DetectorDataComponent * get (SharedImageSet &sis, int frame)
 Get the DetectorDataComponent for a given frame in a SharedImageSet.

Public Attributes

Parameter< mat4 > p_matrixWorldToDetector = {"matrixWorldToDetector", mat4::Identity(), this}
 Matrix that transforms from world to detector space. In order to get to the image, the image matrix has to be multiplied.
Parameter< vec2i > p_persistentIndexAndRange = {"persistentIndexAndRange", vec2i::Constant(-1), this}
 Persistent parameter to compute the matrix from a GeometryGenerator.
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< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ get()

DetectorDataComponent * ImFusion::CT::DetectorDataComponent::get ( SharedImageSet & sis,
int frame )
static

Get the DetectorDataComponent for a given frame in a SharedImageSet.

◆ id()

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

Member Data Documentation

◆ p_persistentIndexAndRange

Parameter<vec2i> ImFusion::CT::DetectorDataComponent::p_persistentIndexAndRange = {"persistentIndexAndRange", vec2i::Constant(-1), this}

Persistent parameter to compute the matrix from a GeometryGenerator.

The index of the frame is stored in the x-component and the range in the y-component. Generators can create these parameters to keep track of the original index of the frame.


The documentation for this class was generated from the following file:
  • ImFusion/CT/Geometry/GeometryDataComponents.h
Search Tab / S to search, Esc to close