ImFusion SDK 4.3
InvertDeformationAlgorithm Class Reference

#include <ImFusion/GL/InvertDeformationAlgorithm.h>

Algorithm to compute the inverse of a deformation. More...

+ Inheritance diagram for InvertDeformationAlgorithm:

Detailed Description

Algorithm to compute the inverse of a deformation.

Public Member Functions

 InvertDeformationAlgorithm (const SharedImageSet &img, SharedImageSet *imgOut=nullptr)
 Creates the algorithm instance with a data, and optional output image.
 
 InvertDeformationAlgorithm (const SharedImageSet &img, std::shared_ptr< Deformation > deformation)
 Creates the algorithm instance with a image descriptor and a given deformation.
 
 ~InvertDeformationAlgorithm () override
 Deletes owned resources.
 
std::unique_ptr< GlDenseDeformationinverseDeformation ()
 take the GlDenseDeformation
 
void setInverseDeformation (std::unique_ptr< GlDenseDeformation > inverse)
 Set the GlDenseDeformation that will be filled with the inverse If not set, a GlDenseDeformation with the size of the input image is created automatically.
 
- Public Member Functions inherited from Algorithm
 Algorithm ()
 Default constructor will registers a single "compute" action that calls compute() and returns status().
 
virtual void setProgress (Progress *progress)
 Sets a Progress interface the algorithm can use to notify observers about its computing progress.
 
Progressprogress () 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 FactoryInfofactoryInfo () 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Methods implementing the algorithm interface

void configure (const Properties *p) override
 Set one or multiple properties.
 
void configuration (Properties *p) const override
 Retrieve the properties of this object.
 
void compute () override
 Applies the processing.
 
OwningDataList takeOutput () override
 If new data was created, make it available here.
 
static bool createCompatible (const DataList &data, Algorithm **a=nullptr)
 

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...
 
- 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.
 
- 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.
 
Progressm_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< Actionm_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< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ createCompatible()

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

Factory method to check for applicability or to create the algorithm

◆ configure()

void configure ( const Properties * p)
overridevirtual

Set one or multiple properties.

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Retrieve the properties of this object.

Reimplemented from Configurable.

◆ compute()

void compute ( )
overridevirtual

Applies the processing.

Implements Algorithm.

◆ takeOutput()

OwningDataList takeOutput ( )
overridevirtual

If new data was created, make it available here.

Reimplemented from Algorithm.


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