ImFusion::ASCRegistrationMethods::ReturnError Class Reference

#include <AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCRegistrationMethods/ReturnError.h>

Meta ASCRegistrationMethod that just returns an error. More...

Inheritance diagram for ImFusion::ASCRegistrationMethods::ReturnError:

Detailed Description

Meta ASCRegistrationMethod that just returns an error.

This exists to cleanly and transparently indicate to the user that a given step in the registration sequence creation has failed and to protect against subsequent evaluation of the registration sequence.

Public Member Functions
	ReturnError (const std::string &errorString)
std::string	identifier () const override
	Machine-readable identifier for the registration method. Must be unique to the type.
std::string	name () const override
	Human-readable name for the registration method.
bool	computeRegistration (AnatomicalStructureCollection &fixed, AnatomicalStructureCollection &moving) override
	Computes the registration of moving to fixed.
Public Member Functions inherited from ImFusion::ASCRegistrationMethod
virtual std::pair< Status, ASCDeformation >	computeRegistrationAsDeformation (AnatomicalStructureCollection &fixed, AnatomicalStructureCollection &moving, AnatomicalStructureCollection &movingInitial)
	Computes ASCDeformation from movingInitial to fixed. The moving parameter is provided to be used as initialization to the registration.
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 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
Public Member Functions inherited from ImFusion::SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Additional Inherited Members
Public Types inherited from ImFusion::ASCRegistrationMethod
enum class	Status { Success , Error , NotImplemented }
Static Public Member Functions inherited from ImFusion::ASCRegistrationMethod
static Factory &	factory ()
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from ImFusion::Utils::NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default
NotCopyable &	operator= (NotCopyable &&) noexcept=default
	NotCopyable (const NotCopyable &)=delete
NotCopyable &	operator= (const NotCopyable &)=delete
Protected Member Functions inherited from ImFusion::SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Attributes inherited from ImFusion::ASCRegistrationMethod
bool	m_rigid = false
	If this is true, registrations should be (per-anatomy) rigid, but implementations may choose to ignore this.
Progress *	m_progress = nullptr
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

identifier()

std::string ImFusion::ASCRegistrationMethods::ReturnError::identifier ( ) const

inlineoverridevirtual

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

Implements ImFusion::ASCRegistrationMethod.

name()

std::string ImFusion::ASCRegistrationMethods::ReturnError::name ( ) const

inlineoverridevirtual

Human-readable name for the registration method.

Reimplemented from ImFusion::ASCRegistrationMethod.

computeRegistration()

bool ImFusion::ASCRegistrationMethods::ReturnError::computeRegistration ( AnatomicalStructureCollection & fixed, AnatomicalStructureCollection & moving )

inlineoverridevirtual

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.

Implements ImFusion::ASCRegistrationMethod.

---

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

• AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCRegistrationMethods/ReturnError.h