AbstractImageRegistration Class Reference

#include <ImFusion/Reg/AbstractImageRegistration.h>

The AbstractImageRegistration class is an interface for all image-based registrations. More...

Inheritance diagram for AbstractImageRegistration:

Detailed Description

The AbstractImageRegistration class is an interface for all image-based registrations.

Each registration always targets two independend images.

Public Types
enum	PreProcessingFilter { None , LC2_GradientMagnitude }
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	AbstractImageRegistration (SharedImageSet *image1, SharedImageSet *image2)
virtual void	initializeTransformationModel ()=0
virtual PreProcessingFilter	requiredPreprocessingFilter () const
	Returns which pre-processing is required for the current registration settings.
virtual SharedImageSet *	image1 () const
virtual SharedImageSet *	image2 () const
virtual SharedImageSet *	reference () const =0
	Returns the image that will be iterated during the registration.
virtual void	setImage1 (SharedImageSet *img)
virtual void	setImage2 (SharedImageSet *img)
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.
virtual void	reset ()=0
	Resets the registration of both images to the initial state.
virtual bool	isDeformable () const =0
	Returns if the registration is non-linear or not.
virtual double	bestSimilarityValue () const =0
	Returns the best value of the similarity measure after optimization (may return NaN if algorithm is not intialized)
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	compute ()=0
	Execute the algorithm.
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
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

Protected Member Functions
bool	complainAboutDeformationOnFixedImage ()
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.

Protected Attributes
SharedImageSet *	m_image1
	First image of the registration.
SharedImageSet *	m_image2
	Second image of the registration.
PointCorrAlgorithm *	m_pcAlg
	Optional point correspondences for evaluation.
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Member Function Documentation

initializeTransformationModel()

virtual void initializeTransformationModel ( )

pure virtual

Implemented in GatedLinear4DImageRegistration, and LinearImageRegistration.

requiredPreprocessingFilter()

virtual PreProcessingFilter requiredPreprocessingFilter ( ) const

virtual

Returns which pre-processing is required for the current registration settings.

The default implementation returns None.

Reimplemented in ParametricImageRegistration.

reference()

virtual SharedImageSet * reference ( ) const

pure virtual

Returns the image that will be iterated during the registration.

Implemented in DemonsImageRegistration, and ParametricImageRegistration.

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.

Reimplemented in DemonsImageRegistration, FFDImageRegistration, ParametricDeformableRegistration, ParametricImageRegistration, and PolyRigidImageRegistration.

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.

Reimplemented in DemonsImageRegistration, FFDImageRegistration, ParametricDeformableRegistration, ParametricImageRegistration, and PolyRigidImageRegistration.

reset()

virtual void reset ( )

pure virtual

Resets the registration of both images to the initial state.

Warning

Algorithms may not support this fully and only partially reset to the initial state, e.g. because they do not store the initial deformation.

Implemented in DemonsImageRegistration, GatedLinear4DImageRegistration, LinearGridRegistration, LinearImageRegistration, and ParametricDeformableRegistration.

isDeformable()

virtual bool isDeformable ( ) const

pure virtual

Returns if the registration is non-linear or not.

Implemented in DemonsImageRegistration, GatedLinear4DImageRegistration, LinearGridRegistration, LinearImageRegistration, and ParametricDeformableRegistration.

bestSimilarityValue()

virtual double bestSimilarityValue ( ) const

pure virtual

Returns the best value of the similarity measure after optimization (may return NaN if algorithm is not intialized)

Implemented in DemonsImageRegistration, and ParametricImageRegistration.

---

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

• ImFusion/Reg/AbstractImageRegistration.h