DeformationEditor Class Reference

#include <ImFusion/GL/DeformationEditor.h>

The DeformationEditor algorithm modifiers the deformation property of a SharedImageSet. More...

Inheritance diagram for DeformationEditor:

Detailed Description

The DeformationEditor algorithm modifiers the deformation property of a SharedImageSet.

It can add a specific deformation model or remove all deformations. If the input SharedImageSet contains multiple images, the deformation is expected to have the same properties on all images (e.g. same model and same grid size but not necessarly the same deformation).

Public Types
enum	DeformationModel {   None , FFD , TPS , Dense ,   Parametric }
	Enumeration of supported deformation types. More...
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
	DeformationEditor (SharedImageSet *image)
	Creates a DeformationEditor that modifies the deformation object of the given input image.
const std::shared_ptr< Deformation >	deformation (int which=-1) const
	Retrieve the deformation of the image.
const std::shared_ptr< FreeFormDeformation >	deformationFFD (int which=-1) const
	Convenience method to retrieve the deformation of the image and cast it to FreeFormDeformation.
const std::shared_ptr< GlTPSDeformation >	deformationTPS (int which=-1) const
	Convenience method to retrieve the deformation of the image and cast it to GlTPSDeformation.
const std::shared_ptr< GlDenseDeformation >	deformationDense (int which=-1) const
	Convenience method to retrieve the deformation of the image and cast it to GlDenseDeformation.
const std::shared_ptr< ParametricDeformation >	deformationParametric (int which=-1) const
	Convenience method to retrieve the deformation of the image and cast it to ParametricDeformation.
std::vector< std::shared_ptr< Deformation > >	deformations () const
	Returns all deformations of the SharedImageSet.
SharedImageSet *	image () const
	Returns the input image.
void	setDeformationModel (DeformationModel model)
	Sets the deformation model for the specified frame.
DeformationModel	deformationModel () const
void	setSubdivisions (const vec3i &sub)
	Sets the number of subdivisions for FFDs or does nothing if deformation model is not FFD.
void	setTransformation (const mat4 &m)
	Sets the world transformation of the FFD grid or does nothing if deformation model is not FFD.
void	setRegularizationWeight (double w)
	Sets the regularization weight of the TPS.
void	setUseLocalModel (bool use)
	Sets wether to use the local model of the TPS.
void	updateFromDeformation ()
	Updates all parameters from the currently set deformation.
void	compute () override
	Creates or deletes the deformation accordings to the current model and updates the properties of the deformation.
std::string	toString (DeformationModel model) const
	Converts a DeformationModel to a string.
DeformationModel	fromString (const std::string str) const
	Converts a string to a DeformationModel.
void	configure (const Properties *p) override
	Configures the algorithm and may create a deformation object for the input data depending on the 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=nullptr)
	Only created for single images that have no deformation or a FreeFormDeformation.
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

DeformationModel

enum DeformationModel

Enumeration of supported deformation types.

Enumerator
None	No deformation model (also used to remove other models)
FFD	Free-Form deformations.
TPS	Thin Plate Spline deformations.
Dense	Dense deformation field.
Parametric	Other parametric deformation model not known by the controller.

Member Function Documentation

deformations()

std::vector< std::shared_ptr< Deformation > > deformations

(

)

const

Returns all deformations of the SharedImageSet.

Never contains nullptr. Not guaranteed that the order is the same as the in the SharedImageSet.

setDeformationModel()

void setDeformationModel

(

DeformationModel

model

)

Sets the deformation model for the specified frame.

If the current deformation model differs, a new deformation object is created and the old object is replaced. To remove an exist deformation use DeformationModel::None.

compute()

void compute ( )

overridevirtual

Creates or deletes the deformation accordings to the current model and updates the properties of the deformation.

Implements Algorithm.

fromString()

DeformationModel fromString

(

const std::string

str

)

const

Converts a string to a DeformationModel.

If the string is not a string generated by toString, returns None

configure()

void configure ( const Properties * p )

overridevirtual

Configures the algorithm and may create a deformation object for the input data depending on the properties.

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/GL/DeformationEditor.h