ImFusion SDK 4.3
ASCRegistrationMethod Class Referenceabstract

#include <AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCRegistrationMethod.h>

Abstract base class for registration of AnatomicalStructureCollection objects to each other. More...

+ Inheritance diagram for ASCRegistrationMethod:

Detailed Description

Abstract base class for registration of AnatomicalStructureCollection objects to each other.

The (entire) moving object is moved to best fit the fixed object.

Classes

class  Factory
 Global and local factories for ASCRegistrationMethod objects. More...
 

Public Member Functions

virtual bool computeRegistration (AnatomicalStructureCollection &fixed, AnatomicalStructureCollection &moving)=0
 Computes the registration of moving to fixed.
 
virtual std::string identifier () const =0
 Machine-readable identifier for the registration method. Must be unique to the type.
 
virtual std::string name () const
 Human-readable name for the registration method.
 
void setRigid (bool rigid)
 Getter for the rigid parameter. If this is true, registrations should be (per-anatomy) rigid, but implementations may choose to ignore this.
 
bool rigid () const
 Setter for the rigid parameter. If this is true, registrations should be (per-anatomy) rigid, but implementations may choose to ignore this.
 
void setProgress (Progress *progress)
 
- Public Member Functions inherited from 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Static Public Member Functions

static Factoryfactory ()
 

Protected Attributes

bool m_rigid = false
 If this is true, registrations should be (per-anatomy) rigid, but implementations may choose to ignore this.
 
Progressm_progress = nullptr
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

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 NotCopyable
 NotCopyable (NotCopyable &&) noexcept=default
 
NotCopyableoperator= (NotCopyable &&) noexcept=default
 
 NotCopyable (const NotCopyable &)=delete
 
NotCopyableoperator= (const NotCopyable &)=delete
 

Member Function Documentation

◆ computeRegistration()

virtual bool computeRegistration ( AnatomicalStructureCollection & fixed,
AnatomicalStructureCollection & moving )
pure virtual

Computes the registration of moving to fixed.

Warning
it is important for the structure to update all objects contained by the structure to the new position. Registrations will construct an ASCDeformation by directly mapping the initial state of moving to its final state. If some objects (e.g. graphs) are not updated, the resulting linear part of the deformation will not match the linear part of the registration as computed.

Implemented in AlignStructuresByTranslation, ICP, ModifyBehavior, PerAnatomy< IndividualRegistrationMethod >, PerAnatomy< ASImageBasedRefine >, PerAnatomyImageBasedRefine, and ReturnError.

◆ identifier()

virtual std::string identifier ( ) const
pure virtual

Machine-readable identifier for the registration method. Must be unique to the type.

Implemented in AlignStructuresByTranslation, ICP, ModifyBehavior, PerAnatomy< IndividualRegistrationMethod >, PerAnatomy< ASImageBasedRefine >, and ReturnError.

◆ name()

virtual std::string name ( ) const
inlinevirtual

The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close