#include <ImFusion/Reg/RegistrationResultsAlgorithm.h>

Store registration results for data combinations. More...

Inheritance diagram for RegistrationResultsAlgorithm:

Detailed Description

Store registration results for data combinations.

This class allows for storage of registration results, where a result includes the transformation matrix of one or multiple (image) data sets - the most typical scenario will be data pairs. In addition, deformation instances and parameters can be kept track of. No input data is provided here, pointers to the data instances are provided through the corresponding controller. Saving and loading through workspaces / properties uses the name string of each involved data set.

Public Member Functions
RegistrationResults &	results ()

DataList	setSelected (int index)
	Select the result at `index` and apply it, returning affected data.

int	selected () const
	Return the index of the selected (last applied) result.

bool	add (const DataList &data, bool checkIfChanged, const std::string &name="")
	Add a registration result using the state of the data provided if checkIfChanged is enabled, the result is only added if it is different from the selected one.

void	remove (int index)
	Remove the registration result at the given index.

DataList	apply (int index)
	Apply result at the given index, returning affected data.

void	setName (int index, const std::string &name)
	Set the name of the result at the given index.

std::string	name (int index) const
	Return the name of result at the given index.

int	findResult (const DataList &data) const
	Returns the index of a result if its data and transformation all match, or -1 if none is found.

int	size () const

void	resolveDataAfterConfigure (DataModel &dataModel)

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

Public Member Functions inherited from 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.

Static Public Member Functions
static std::string	suggestedName (const Optimizer *opt)
	Tool method to describe a registration result from an optimizer instance.

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
Parameter< Filesystem::Path >	p_deformationStorageDir = {"deformationStorageDir", "", *this}
	Filepath to store dense deformations upon serialization / load from in resolveDataAfterConfigure.

Parameter< bool >	p_restoreDeformationsByHashId = {"restoreDeformationsByHashId", false, *this}
	Use hash value of data to map data and dense deformation.

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
const RegistrationResults::DataResult *	getCurrentDataResult (const Data *data) const

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 Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes
std::unique_ptr< RegistrationResults >	m_resultsOwn

RegistrationResults	m_results

int	m_selected = -1
	Index of selected (i.e. last applied) result.

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.

Methods implementing the Algorithm interface
void	compute () override
	Empty compute method.

void	configure (const Properties *p) override
	Configure registration results, data is retrieved with name strings.

void	configuration (Properties *p) const override
	Store configuration with all registration results.

static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)

Methods operating on the currently selected registration result
void	copyToClipboard (const Data *data, bool asParameters) const

bool	setOnOtherData (const Data *srcData, const DataList &dstData, bool checkOnly=false)
	Set the transformation of the chosen data on other data sets.

int	moveOtherResults (const Data *data, bool checkOnly=false)
	Move the chosen data on other suited results to the active transformation, return on how many.

DataList	selectedData () const
	Return the datasets of the currently selected registration result.

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

Member Function Documentation

◆ createCompatible()

static bool createCompatible	(	const DataList &	data,
		Algorithm **	a = nullptr )

static

Factory create method, data must be empty

◆ compute()

void compute ( )

overridevirtual

Empty compute method.

Implements Algorithm.

◆ configure()

void configure ( const Properties * p )

overridevirtual

Configure registration results, data is retrieved with name strings.

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p ) const

overridevirtual

Store configuration with all registration results.

Reimplemented from Configurable.

◆ add()

bool add	(	const DataList &	data,
		bool	checkIfChanged,
		const std::string &	name = "" )

Add a registration result using the state of the data provided if checkIfChanged is enabled, the result is only added if it is different from the selected one.

Optionally, a name of the result can be provided. The method returns true if the result was added.

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ remove()

void remove ( int index )

inline

Remove the registration result at the given index.

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ apply()

DataList apply ( int index )

inline

Apply result at the given index, returning affected data.

Deprecated: "Use `setSelected(index)` instead"

◆ setName()

void setName	(	int	index,
		const std::string &	name )

inline

Set the name of the result at the given index.

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ name()

std::string name ( int index ) const

inline

Return the name of result at the given index.

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ findResult()

int findResult ( const DataList & data ) const

inline

Returns the index of a result if its data and transformation all match, or -1 if none is found.

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ size()

int size ( ) const

inline

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ resolveDataAfterConfigure()

void resolveDataAfterConfigure ( DataModel & dataModel )

Deprecated: "Use `RegistrationResults` directly or access it through `results()`"

◆ copyToClipboard()

void copyToClipboard	(	const Data *	data,
		bool	asParameters ) const

Copy the transformation of the provided data to the clipboard, as matrix or parameters

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

ImFusion/Reg/RegistrationResultsAlgorithm.h

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Methods implementing the Algorithm interface

Methods operating on the currently selected registration result

Additional Inherited Members

Member Function Documentation

◆ createCompatible()

◆ compute()

◆ configure()

◆ configuration()

◆ add()

◆ remove()

◆ apply()

◆ setName()

◆ name()

◆ findResult()

◆ size()

◆ resolveDataAfterConfigure()

◆ copyToClipboard()