ImFusion SDK 4.3
GlFreeFormDeformation Class Reference

#include <ImFusion/GL/GlFreeFormDeformation.h>

Free Form Deformation. More...

+ Inheritance diagram for GlFreeFormDeformation:

Detailed Description

Free Form Deformation.

Public Types

enum  DeformationType { CubicBSpline }
 
- 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

 GlFreeFormDeformation (SharedImage *img, SharedImage *out=0)
 
int dimension () const
 
void setSubdivisions (const vec3 &n)
 Set number of control points (without border needed for interpolation)
 
vec3 subdivisions () const
 Get number of internal subdivisions.
 
void setGridSpacing (const vec3 &s)
 Set grid spacing in pixels.
 
vec3 gridSpacing () const
 Get grid spacing in pixels.
 
std::vector< vec3 > gridPoints () const
 Get current grid point locations (including displacement)
 
vec3i gridSize () const
 
void setDeformationType (DeformationType type)
 Set deformation type.
 
DeformationType deformationType () const
 Get deformation type.
 
void setTransformation (const mat4 &T)
 Set transformation to be applied to the control points in world coordinate system.
 
mat4 transformation () const
 Get control point transformation in world coordinate system.
 
void setDisplacement (const std::vector< vec3f > &d)
 Set displacement in pixels for every control points.
 
void setDisplacement (const std::vector< vec2f > &d)
 Set displacement in pixels for every control points. Convenience function for 2D images.
 
void setInnerDisplacement (int n, const double *d, int borderXY=0, int borderZ=-1, std::vector< vec3 > *cpOut=0)
 Set the 3D world displacement for all inner control points (the outer ones are kept unchanged) using single linearized array.
 
const std::vector< vec3f > & displacement () const
 Get displacement in pixels.
 
SharedImageSetdisplacementField ()
 Creates and returns a dense displacement field.
 
SharedImagegetOutput () const
 
void applyToProgram (GL::Program *prog) override
 Apply the FFD variables to a shader program.
 
GL::ProgramcreateSliceProgram ()
 Create a shader program for deformed slice visualization.
 
void compute () override
 Apply free form deformation to image imgIn and imgOut have to be two different images.
 
void compute (SharedImage *imgIn)
 Apply free form deformation to the given image imgIn and imgOut have to be two different images.
 
vec3 transformPoint (const vec3 &p) const
 Transform point given in output image world coordinate system to input image world coordinate system.
 
- 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.
 
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 configure (const Properties *p)
 Configure this object instance by de-serializing the given Properties.
 
virtual void configuration (Properties *p) const
 Serialize the current object configuration into the given Properties object.
 
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
 

Static Public Member Functions

static bool createCompatible (const DataList &data, Algorithm **a=0)
 If data is compatible with algorithm return true. If a is not zero, create algorithm with input data.
 
- 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.
 
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

◆ setDisplacement()

void setDisplacement ( const std::vector< vec3f > & d)

Set displacement in pixels for every control points.

For 2D images the z-coordinate of the displacement is ignored.

◆ applyToProgram()

void applyToProgram ( GL::Program * prog)
overridevirtual

Apply the FFD variables to a shader program.

Implements ProgramDecorator.

◆ compute()

void compute ( )
overridevirtual

Apply free form deformation to image imgIn and imgOut have to be two different images.

Implements Algorithm.


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