Detailed Description

Registers a SharedImageSet of multiple images.

The images in the set are registered to each other, either to a fixed frame or to the predecessor of each frame. Internally an ImFusion::ImageRegistration to register two frames. The registration is only performed on the current selection.

Public Types
enum	ReferenceFrameMode { FixedFrame , PreviousFrame }

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
	ImageSequenceRegistration (SharedImageSet *is)

void	compute () override
	Execute the algorithm.

void	reset ()
	Resets the transformation of the sequence to its initial transformation (matrix and FFD)

const ImageRegistration *	registrationObject () const
	Returns the ImFusion::ImageRegistration object used for the per-frame registration.

ImageRegistration *	registrationObject ()

SharedImageSet *	image () const
	Returns the input image.

void	setReferenceMode (ReferenceFrameMode refMode)

ReferenceFrameMode	referenceMode () const

void	setReferenceFrame (int frame)
	Sets the reference frame for the FixedFrame mode.

int	referenceFrame () const

void	setBackwards (bool backwards)
	Sets if the registration should start with the last frame or not.

bool	isBackwards () const

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.

Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().

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

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)

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.

Additional Inherited Members
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.

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 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.

Member Enumeration Documentation

◆ ReferenceFrameMode

enum ReferenceFrameMode

Enumerator
FixedFrame	Registers all frames to fixed frame (by default the first frame)
PreviousFrame	Registers each frame to its predecessor.

Member Function Documentation

◆ compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

◆ registrationObject()

const ImageRegistration * registrationObject ( ) const

Returns the ImFusion::ImageRegistration object used for the per-frame registration.

The object is persistent and is used for all frames. The ImFusion::ImageRegistration is created with two dummy SharedImageSets that are filled with the current registering frames.

◆ setBackwards()

void setBackwards ( bool backwards )

Sets if the registration should start with the last frame or not.

By default the registration starts with the first frame of the selection.

◆ 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.

◆ 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.

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

ImFusion/Reg/ImageSequenceRegistration.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ ReferenceFrameMode

Member Function Documentation

◆ compute()

◆ registrationObject()

◆ setBackwards()

◆ configure()

◆ configuration()