Public Member Functions | List of all members
mirtk::MultiLevelFreeFormTransformation Class Reference

#include <MultiLevelFreeFormTransformation.h>

Inheritance diagram for mirtk::MultiLevelFreeFormTransformation:
Inheritance graph
Collaboration diagram for mirtk::MultiLevelFreeFormTransformation:
Collaboration graph

Public Member Functions

virtual double Approximate (const ImageAttributes &, double *, double *, double *, int=1, double=.0)
 
virtual double Approximate (const double *, const double *, const double *, double *, double *, double *, int, int=1, double=.0)
 
virtual double Approximate (const double *, const double *, const double *, const double *, double *, double *, double *, int, int=1, double=.0)
 
virtual double ApproximateAsNew (const ImageAttributes &, double *, double *, double *, int=1, double=.0)
 
virtual double ApproximateAsNew (const double *, const double *, const double *, double *, double *, double *, int, int=1, double=.0)
 
virtual double ApproximateAsNew (const double *, const double *, const double *, const double *, double *, double *, double *, int, int=1, double=.0)
 
virtual void ApproximateDOFs (const double *, const double *, const double *, const double *, const double *, const double *, const double *, int)
 
virtual void ApproximateDOFsGradient (const double *, const double *, const double *, const double *, const double *, const double *, const double *, int, double *, double=1.0) const
 
double Bending (double, double, double) const
 Bending of multi-level free-form deformation.
 
virtual bool CanModifyDisplacement (int=-1) const
 
virtual void CombineLocalTransformation ()
 Combine local transformations on stack.
 
virtual void DeriveJacobianWrtDOF (Matrix &, int, double, double, double, double=0, double=NaN) const
 Calculates the derivative of the Jacobian of the transformation (w.r.t. world coordinates) w.r.t. a transformation parameter.
 
virtual void Displacement (int, int, GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void Displacement (int, int, GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void DisplacementAfterDOFChange (int dof, double dv, GenericImage< double > &dx, double t, double t0=-1, const WorldCoordsImage *i2w=NULL) const
 
bool DOFBoundingBox (const Image *, int, int &, int &, int &, int &, int &, int &, double=1) const
 
virtual void Hessian (int, int, Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the transformation w.r.t world coordinates.
 
virtual int InverseDisplacement (int, int, GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual int InverseDisplacement (int, int, GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void Jacobian (int, int, Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the transformation w.r.t world coordinates.
 
virtual void LocalTransform (int, int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the local transformation component only.
 
virtual void MergeGlobalIntoLocalDisplacement ()
 
 MultiLevelFreeFormTransformation ()
 Default constructor.
 
 MultiLevelFreeFormTransformation (const RigidTransformation &)
 Construct multi-level transformation given a rigid transformation.
 
 MultiLevelFreeFormTransformation (const AffineTransformation &)
 Construct multi-level transformation given an affine transformation.
 
 MultiLevelFreeFormTransformation (const MultiLevelFreeFormTransformation &)
 Copy constructor.
 
virtual void ParametricGradient (const GenericImage< double > *, double *, const WorldCoordsImage *=NULL, const WorldCoordsImage *=NULL, double=NaN, double=1) const
 
virtual void ParametricGradient (const PointSet &, const Vector3D< double > *, double *, double=0, double=NaN, double=1) const
 
virtual void Print (ostream &, Indent=0) const
 Prints the parameters of the transformation.
 
virtual void Transform (int, int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point.
 
virtual ~MultiLevelFreeFormTransformation ()
 Destructor.
 
- Public Member Functions inherited from mirtk::MultiLevelTransformation
virtual void Add (const DOFValue *)
 Add change to transformation parameters.
 
virtual double BendingEnergy (int, int, double, double, double, double=0, double=NaN, bool=true) const
 Calculates the bending energy of the transformation.
 
virtual double BendingEnergy (int, double, double, double, double=0, double=NaN, bool=true) const
 Calculates the bending energy of the transformation.
 
virtual double BendingEnergy (double, double, double, double=0, double=NaN, bool=true) const
 Calculates the bending energy of the transformation.
 
virtual void Clear ()
 Reset transformation and remove all local transformations.
 
virtual bool CopyFrom (const Transformation *)
 
virtual void Displacement (int, int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point.
 
virtual void Displacement (int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point.
 
virtual void Displacement (int, int, GenericImage< double > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
virtual void Displacement (int, int, GenericImage< float > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
virtual void Displacement (int, GenericImage< double > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
virtual void Displacement (int, GenericImage< float > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
virtual void Displacement (int, GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void Displacement (int, GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void Displacement (GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual void Displacement (GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual double DOFGradientNorm (const double *) const
 Get norm of the gradient vector.
 
virtual double Get (int) const
 Get value of transformation parameter.
 
virtual void Get (DOFValue *) const
 Get values of transformation parameters.
 
virtual AffineTransformationGetGlobalTransformation ()
 Gets global transformation.
 
virtual const AffineTransformationGetGlobalTransformation () const
 Get global transformation.
 
virtual FreeFormTransformationGetLocalTransformation (int)
 Gets local transformation.
 
virtual const FreeFormTransformationGetLocalTransformation (int) const
 Gets local transformation.
 
virtual DOFStatus GetStatus (int) const
 Get status of transformation parameter.
 
virtual void GlobalHessian (Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the global transformation w.r.t world coordinates.
 
virtual void GlobalInverse (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the global transformation only.
 
virtual void GlobalJacobian (Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the global transformation w.r.t world coordinates.
 
virtual void GlobalTransform (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the global transformation component only.
 
virtual bool HasSameDOFsAs (const Transformation *) const
 Checks whether transformation depends on the same vector of parameters.
 
virtual void Hessian (int, Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the transformation w.r.t world coordinates.
 
virtual void Hessian (Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the transformation w.r.t world coordinates.
 
virtual void InsertLocalTransformation (FreeFormTransformation *, int=0, bool=true)
 Insert local transformation.
 
virtual bool Inverse (int, int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the transformation.
 
virtual bool Inverse (int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the transformation.
 
virtual bool Inverse (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the transformation.
 
virtual bool InverseDisplacement (int, int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the transformation.
 
virtual bool InverseDisplacement (int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the transformation.
 
virtual int InverseDisplacement (int, GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual int InverseDisplacement (int, GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual int InverseDisplacement (GenericImage< double > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual int InverseDisplacement (GenericImage< float > &, double, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual bool IsIdentity () const
 Checks whether transformation is an identity mapping.
 
virtual void Jacobian (int, Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the transformation w.r.t world coordinates.
 
virtual void Jacobian (Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the transformation w.r.t world coordinates.
 
virtual double Jacobian (int, int, double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the transformation w.r.t world coordinates.
 
virtual double Jacobian (int, double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the transformation w.r.t world coordinates.
 
virtual void JacobianDOFs (double [3], int, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the transformation w.r.t the transformation parameters.
 
virtual void LocalDisplacement (int, int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the local transformation component only.
 
virtual void LocalDisplacement (int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the local transformation component only.
 
virtual void LocalHessian (int, Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the local transformation w.r.t world coordinates.
 
virtual void LocalHessian (Matrix [3], double, double, double, double=0, double=NaN) const
 Calculates the Hessian for each component of the local transformation w.r.t world coordinates.
 
virtual bool LocalInverse (int, int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the local transformation only.
 
virtual bool LocalInverse (int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the local transformation only.
 
virtual bool LocalInverse (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the inverse of the local transformation only.
 
virtual bool LocalInverseDisplacement (int, int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the local transformation only.
 
virtual bool LocalInverseDisplacement (int, double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the local transformation only.
 
virtual void LocalJacobian (int, Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the local transformation w.r.t world coordinates.
 
virtual void LocalJacobian (Matrix &, double, double, double, double=0, double=NaN) const
 Calculates the Jacobian of the local transformation w.r.t world coordinates.
 
virtual double LocalJacobian (int, double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the local transformation w.r.t world coordinates.
 
virtual void LocalTransform (int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the local transformation component only.
 
virtual void LocalTransform (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point using the local transformation component only.
 
virtual bool LocalTransformationIsActive (int) const
 Get whether local transformation is active.
 
virtual void LocalTransformationStatus (int, FFDStatus)
 Put status of local transformation.
 
virtual FFDStatus LocalTransformationStatus (int) const
 Get status of local transformation.
 
virtual int NumberOfActiveCPs () const
 Returns the total number of active control points on all active levels.
 
virtual int NumberOfActiveLevels () const
 Returns the number of active levels.
 
virtual int NumberOfCPs (bool=false) const
 Returns the total number of control points.
 
virtual int NumberOfDOFs () const
 Get number of transformation parameters.
 
virtual int NumberOfLevels () const
 Returns the number of levels.
 
virtual int NumberOfPassiveLevels () const
 Returns the number of passive levels.
 
virtual ParameterList Parameter () const
 Get (non-DoF) parameters as key/value as string map.
 
virtual FreeFormTransformationPopLocalTransformation ()
 Pop local transformation from stack (remove last transformation)
 
virtual void PushLocalTransformation (FreeFormTransformation *, bool=true)
 Push local transformation on stack (append transformation)
 
virtual void Put (int, double)
 Put value of transformation parameter.
 
virtual void Put (const DOFValue *)
 Put values of transformation parameters.
 
virtual FreeFormTransformationPutLocalTransformation (FreeFormTransformation *, int, bool=true)
 Put local transformation and return pointer to previous one (needs to be deleted if not used)
 
virtual void PutStatus (int, DOFStatus)
 Put status of transformation parameter.
 
virtual FreeFormTransformationRemoveLocalTransformation (int=0)
 Remove local transformation and return the pointer (need to be deleted if not used)
 
virtual bool RequiresCachingOfDisplacements () const
 
virtual void Reset ()
 Reset transformation (does not remove local transformations)
 
virtual bool Set (const char *, const char *)
 Set named (non-DoF) parameter from value as string.
 
virtual void Transform (int, double &, double &, double &, double=0, double=NaN) const
 Transforms a single point.
 
virtual void Transform (double &, double &, double &, double=0, double=NaN) const
 Transforms a single point.
 
virtual void Transform (int, int, Point &, double=0, double=NaN) const
 Transforms a single point.
 
virtual void Transform (int, Point &, double=0, double=NaN) const
 Transforms a single point.
 
virtual void Transform (int, int, PointSet &, double=0, double=NaN) const
 Transforms a set of points.
 
virtual void Transform (int, PointSet &, double=0, double=NaN) const
 Transforms a set of points.
 
virtual double Update (const DOFValue *)
 Update transformation parameters given parametric gradient.
 
virtual ~MultiLevelTransformation ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Transformation
virtual double Approximate (const ImageAttributes &, const Transformation *, int=1, double=.0)
 Approximate another transformation and return approximation error.
 
virtual double Approximate (GenericImage< double > &, int=1, double=.0)
 
virtual double ApproximateAsNew (const ImageAttributes &, const Transformation *, int=1, double=.0)
 Approximate another transformation and return approximation error.
 
virtual double ApproximateAsNew (GenericImage< double > &, int=1, double=.0)
 
virtual void ApproximateGradient (const ImageAttributes &, const double *, const double *, const double *, double *, double=1.0) const
 
virtual void ApproximateGradient (const double *, const double *, const double *, const double *, const double *, const double *, int, double *, double=1.0) const
 
virtual void ApproximateGradient (const double *, const double *, const double *, const double *, const double *, const double *, const double *, int, double *, double=1.0) const
 
virtual bool CanRead (TransformationType) const
 Whether this transformation can read a file of specified type (i.e. format)
 
virtual void Displacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point.
 
virtual void Displacement (const ImageAttributes &, double *, double *, double *) const
 
virtual void Displacement (GenericImage< double > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
virtual void Displacement (GenericImage< float > &, double=NaN, const WorldCoordsImage *=NULL) const
 Calculates the displacement vectors for a whole image domain.
 
double EvaluateRMSError (const ImageAttributes &, const Transformation *) const
 Evaluates RMS error of transformation compared to another.
 
double EvaluateRMSError (const ImageAttributes &, double *, double *) const
 
double EvaluateRMSError (const ImageAttributes &, double *, double *, double *) const
 
double EvaluateRMSError (const double *, const double *, const double *, double, double *, double *, double *, int no) const
 Evaluates RMS error of transformation compared to displacement field.
 
double EvaluateRMSError (const double *, const double *, const double *, const double *, double *, double *, double *, int no) const
 Evaluates RMS error of transformation compared to given displacement field.
 
virtual void GlobalDisplacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the global transformation component only.
 
virtual void GlobalInverseDisplacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the global transformation only.
 
virtual double GlobalJacobian (double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the global transformation w.r.t world coordinates.
 
virtual bool Inverse (Point &, double=0, double=NaN) const
 Transforms a single point using the inverse of the transformation.
 
virtual int Inverse (PointSet &, double=0, double=NaN) const
 
virtual bool InverseDisplacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the transformation.
 
virtual int InverseDisplacement (const ImageAttributes &, double *, double *, double *) const
 
virtual int InverseDisplacement (GenericImage< double > &, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual int InverseDisplacement (GenericImage< float > &, double=NaN, const WorldCoordsImage *=NULL) const
 
virtual double Jacobian (double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the transformation w.r.t world coordinates.
 
virtual void LocalDisplacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the local transformation component only.
 
virtual bool LocalInverseDisplacement (double &, double &, double &, double=0, double=NaN) const
 Calculates the displacement of a single point using the inverse of the local transformation only.
 
virtual double LocalJacobian (double, double, double, double=0, double=NaN) const
 Calculates the determinant of the Jacobian of the local transformation w.r.t world coordinates.
 
int NumberOfActiveDOFs () const
 Get number of active transformation parameters.
 
int NumberOfPassiveDOFs () const
 Get number of passive transformation parameters.
 
void ParametricGradient (const GenericImage< double > *, double *, const WorldCoordsImage *, double=NaN, double=1) const
 
void ParametricGradient (const GenericImage< double > *, double *, double=NaN, double=1) const
 
virtual void ParametricGradient (const GenericImage< double > **, int, double *, const WorldCoordsImage *, const WorldCoordsImage *, const double *=NULL, double=1) const
 
void ParametricGradient (const GenericImage< double > **, int, double *, const WorldCoordsImage *, const double *=NULL, double=1) const
 
void ParametricGradient (const GenericImage< double > **, int, double *, const double *=NULL, double=1) const
 
void Print (Indent=0) const
 Prints information about the transformation.
 
virtual void Read (const char *)
 Reads a transformation from a file.
 
virtual CifstreamRead (Cifstream &)
 Reads a transformation from a file stream.
 
virtual void Transform (Point &, double=0, double=NaN) const
 Transforms a single point.
 
virtual void Transform (PointSet &, double=0, double=NaN) const
 Transforms a set of points.
 
virtual void Transform (int, double *, double *, double *, double=0, double=NaN) const
 Transforms a set of points.
 
virtual void Transform (int, double *, double *, double *, const double *, double=NaN) const
 Transforms a set of points.
 
virtual void Transform (WorldCoordsImage &, double=NaN) const
 Transforms world coordinates of image voxels.
 
virtual TransformationType TypeOfClass () const
 Returns type ID of the instantiated transformation class.
 
virtual void Verify ()
 
virtual void Write (const char *) const
 Writes a transformation to a file.
 
virtual CofstreamWrite (Cofstream &) const
 Writes a transformation to a file stream.
 
virtual ~Transformation ()
 Default destructor.
 
- Public Member Functions inherited from mirtk::Observable
void AddObserver (Observer &)
 Add observer.
 
void Broadcast (Event, const void *=NULL)
 Broadcast event to observers.
 
void ClearObservers ()
 Delete all observers.
 
void DeleteObserver (Observer &)
 Delete observer.
 
void NotifyObservers (Event, const void *=NULL)
 Notify all observers about given event if this object has changed.
 
int NumberOfObservers () const
 Number of current observers.
 
virtual ~Observable ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Object
virtual const char * NameOfClass () const =0
 Get name of class, which this object is an instance of.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual ~Object ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from mirtk::MultiLevelTransformation
typedef Status FFDStatus
 Type of local transformation status.
 
- Public Types inherited from mirtk::Transformation
typedef Status DOFStatus
 Type of transforamtion parameter status.
 
typedef double DOFValue
 Type of transformation parameter value.
 
- Static Public Member Functions inherited from mirtk::Transformation
static bool CheckHeader (const char *)
 Whether magic number in header of given file.
 
static TransformationNew (TransformationType)
 
static TransformationNew (const Transformation *)
 
static TransformationNew (const char *)
 
static TransformationType TypeOfClass (const char *)
 Returns type ID corresponding to transformations of the named class.
 
- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 
- Protected Member Functions inherited from mirtk::MultiLevelTransformation
virtual void CheckTransformation (FreeFormTransformation *) const
 Checks whether a given transformation is supported as local transformation.
 
void InterpolateGlobalDisplacement (FreeFormTransformation *)
 Helper function for MergeGlobalIntoLocalDisplacement.
 
 MultiLevelTransformation ()
 Default constructor.
 
 MultiLevelTransformation (const RigidTransformation &)
 Construct multi-level transformation given a rigid transformation.
 
 MultiLevelTransformation (const AffineTransformation &)
 Construct multi-level transformation given an affine transformation.
 
 MultiLevelTransformation (const MultiLevelTransformation &)
 Copy constructor.
 
virtual CifstreamReadDOFs (Cifstream &, TransformationType)
 Reads transformation parameters from a file stream.
 
virtual CofstreamWriteDOFs (Cofstream &) const
 Writes transformation parameters to a file stream.
 
- Protected Member Functions inherited from mirtk::Transformation
void InitializeDOFs (int)
 Initialize transformation parameters.
 
void InitializeDOFs (const Transformation &, int=-1)
 Copy transformation parameters (DoFs) and their status.
 
 Transformation (int=0)
 Default constructor.
 
 Transformation (const Transformation &)
 Copy constructor.
 
 Transformation (const Transformation &, int)
 Copy constructor.
 
- Protected Member Functions inherited from mirtk::Observable
 Observable ()
 Default constructor.
 
 Observable (const Observable &)
 Copy constructor.
 
Observableoperator= (const Observable &)
 Assignment operator.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 
- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 
- Protected Attributes inherited from mirtk::MultiLevelTransformation
AffineTransformation _GlobalTransformation
 Global transformation.
 
FreeFormTransformation_LocalTransformation [MAX_TRANS]
 Local transformations.
 
bool _LocalTransformationOwner [MAX_TRANS]
 Whether this class is responsible for destructing the local transformation.
 
FFDStatus _LocalTransformationStatus [MAX_TRANS]
 Status of local transformations.
 
int _NumberOfLevels
 Number of local transformations.
 
- Protected Attributes inherited from mirtk::Transformation
int _NumberOfDOFs
 Number of transformation parameters.
 
DOFValue_Param
 Value of each transformation parameter.
 
DOFStatus_Status
 Status of each transformation parameter (Active or Passive)
 

Detailed Description

Class for multi-level FFD where global and local transformations are summed up.

T_mffd(x) = T_global(x) + sum_i T_local^i(x)

Definition at line 35 of file MultiLevelFreeFormTransformation.h.

Member Function Documentation

§ Approximate() [1/3]

virtual double mirtk::MultiLevelFreeFormTransformation::Approximate ( const ImageAttributes ,
double *  ,
double *  ,
double *  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function does not change the global transformation and passive levels. Use ApproximateAsNew to also approximate a new global transformation.

Reimplemented from mirtk::MultiLevelTransformation.

§ Approximate() [2/3]

virtual double mirtk::MultiLevelFreeFormTransformation::Approximate ( const double *  ,
const double *  ,
const double *  ,
double *  ,
double *  ,
double *  ,
int  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function does not change the global transformation and passive levels. Use ApproximateAsNew to also approximate a new global transformation.

Reimplemented from mirtk::MultiLevelTransformation.

§ Approximate() [3/3]

virtual double mirtk::MultiLevelFreeFormTransformation::Approximate ( const double *  ,
const double *  ,
const double *  ,
const double *  ,
double *  ,
double *  ,
double *  ,
int  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function does not change the global transformation and passive levels. Use ApproximateAsNew to also approximate a new global transformation.

Reimplemented from mirtk::MultiLevelTransformation.

§ ApproximateAsNew() [1/3]

virtual double mirtk::MultiLevelFreeFormTransformation::ApproximateAsNew ( const ImageAttributes ,
double *  ,
double *  ,
double *  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a !new! transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function also modifies the global transformation. Use Reset and Approximate instead if this is not desired.

Reimplemented from mirtk::MultiLevelTransformation.

§ ApproximateAsNew() [2/3]

virtual double mirtk::MultiLevelFreeFormTransformation::ApproximateAsNew ( const double *  ,
const double *  ,
const double *  ,
double *  ,
double *  ,
double *  ,
int  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a !new! transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function also modifies the global transformation. Use Reset and Approximate instead if this is not desired.

Reimplemented from mirtk::MultiLevelTransformation.

§ ApproximateAsNew() [3/3]

virtual double mirtk::MultiLevelFreeFormTransformation::ApproximateAsNew ( const double *  ,
const double *  ,
const double *  ,
const double *  ,
double *  ,
double *  ,
double *  ,
int  ,
int  = 1,
double  = .0 
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds a !new! transformation which approximates these displacements. After approximation, the displacements are replaced by the residual displacement errors at the points.

Note
This function also modifies the global transformation. Use Reset and Approximate instead if this is not desired.

Reimplemented from mirtk::MultiLevelTransformation.

§ ApproximateDOFs()

virtual void mirtk::MultiLevelFreeFormTransformation::ApproximateDOFs ( const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
int   
)
virtual

Approximate displacements: This function takes a set of points and a set of displacements and finds !new! parameters such that the resulting transformation approximates the displacements as good as possible.

Reimplemented from mirtk::MultiLevelTransformation.

§ ApproximateDOFsGradient()

virtual void mirtk::MultiLevelFreeFormTransformation::ApproximateDOFsGradient ( const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
const double *  ,
int  ,
double *  ,
double  = 1.0 
) const
virtual

Finds gradient of approximation error: This function takes a set of points and a set of errors. It finds a gradient w.r.t. the transformation parameters which minimizes the L2 norm of the approximation error and adds it to the input gradient with the given weight.

Reimplemented from mirtk::MultiLevelTransformation.

§ CanModifyDisplacement()

virtual bool mirtk::MultiLevelFreeFormTransformation::CanModifyDisplacement ( int  = -1) const
virtual

Whether this transformation implements a more efficient update of a given displacement field given the desired change of a transformation parameter

Reimplemented from mirtk::Transformation.

§ Displacement() [1/2]

virtual void mirtk::MultiLevelFreeFormTransformation::Displacement ( int  ,
int  ,
GenericImage< double > &  ,
double  ,
double  = NaN,
const WorldCoordsImage = NULL 
) const
virtual

Calculates the displacement vectors for a whole image domain

Attention
The displacements are computed at the positions after applying the current displacements at each voxel. These displacements are then added to the current displacements. Therefore, set the input displacements to zero if only interested in the displacements of this transformation at the voxel positions.

Reimplemented from mirtk::MultiLevelTransformation.

§ Displacement() [2/2]

virtual void mirtk::MultiLevelFreeFormTransformation::Displacement ( int  ,
int  ,
GenericImage< float > &  ,
double  ,
double  = NaN,
const WorldCoordsImage = NULL 
) const
virtual

Calculates the displacement vectors for a whole image domain

Attention
The displacements are computed at the positions after applying the current displacements at each voxel. These displacements are then added to the current displacements. Therefore, set the input displacements to zero if only interested in the displacements of this transformation at the voxel positions.

Reimplemented from mirtk::MultiLevelTransformation.

§ DisplacementAfterDOFChange()

virtual void mirtk::MultiLevelFreeFormTransformation::DisplacementAfterDOFChange ( int  dof,
double  dv,
GenericImage< double > &  dx,
double  t,
double  t0 = -1,
const WorldCoordsImage i2w = NULL 
) const
virtual

Updates the displacement vectors for a whole image domain

Parameters
[in]dofTransformation parameter.
[in]dvChange of transformation parameter value.
[in,out]dxDisplacement field to be updated.
[in]tTime point of start point.
[in]t0Time point of end point.
[in]i2wPre-computed world coordinates.

Reimplemented from mirtk::Transformation.

§ DOFBoundingBox()

bool mirtk::MultiLevelFreeFormTransformation::DOFBoundingBox ( const Image image,
int  dof,
int &  i1,
int &  j1,
int &  k1,
int &  i2,
int &  j2,
int &  k2,
double  fraction = 1 
) const
inlinevirtual

Gets the spatial bounding box for a transformation parameter in image coordinates. The last parameter specifies what fraction of the bounding box to return. The default is 1 which equals 100% of the bounding box.

Reimplemented from mirtk::Transformation.

Definition at line 302 of file MultiLevelFreeFormTransformation.h.

§ InverseDisplacement() [1/2]

virtual int mirtk::MultiLevelFreeFormTransformation::InverseDisplacement ( int  ,
int  ,
GenericImage< double > &  ,
double  ,
double  = NaN,
const WorldCoordsImage = NULL 
) const
virtual

Calculates the inverse displacement vectors for a whole image domain

Attention
The displacements are computed at the positions after applying the current displacements at each voxel. These displacements are then added to the current displacements. Therefore, set the input displacements to zero if only interested in the displacements of this transformation at the voxel positions.
Returns
Number of points for which transformation is non-invertible.

Reimplemented from mirtk::MultiLevelTransformation.

§ InverseDisplacement() [2/2]

virtual int mirtk::MultiLevelFreeFormTransformation::InverseDisplacement ( int  ,
int  ,
GenericImage< float > &  ,
double  ,
double  = NaN,
const WorldCoordsImage = NULL 
) const
virtual

Calculates the inverse displacement vectors for a whole image domain

Attention
The displacements are computed at the positions after applying the current displacements at each voxel. These displacements are then added to the current displacements. Therefore, set the input displacements to zero if only interested in the displacements of this transformation at the voxel positions.
Returns
Number of points for which transformation is non-invertible.

Reimplemented from mirtk::MultiLevelTransformation.

§ MergeGlobalIntoLocalDisplacement()

virtual void mirtk::MultiLevelFreeFormTransformation::MergeGlobalIntoLocalDisplacement ( )
virtual

Convert the global transformation from a matrix representation to a FFD and incorporate it with any existing local transformation

Reimplemented from mirtk::MultiLevelTransformation.

§ ParametricGradient() [1/2]

virtual void mirtk::MultiLevelFreeFormTransformation::ParametricGradient ( const GenericImage< double > *  ,
double *  ,
const WorldCoordsImage = NULL,
const WorldCoordsImage = NULL,
double  = NaN,
double  = 1 
) const
virtual

Applies the chain rule to convert spatial non-parametric gradient to a gradient w.r.t the parameters of this transformation.

If the transformation itself is non-parametric, the gradient will be passed through unchanged. The default implementation uses the full Jacobian matrix computed for each DoF separately (i.e., calls JacobianDOFs for each DoF).

For 4D transformations, the temporal coordinate t used for the computation of the Jacobian of the transformation w.r.t the transformation parameters for all spatial (x, y, z) voxel coordinates in world units, is assumed to correspond to the temporal origin of the given gradient image. For 4D transformations parameterized by velocities, a second time for the upper integration bound can be provided as last argument to this method. This last argument is ignored by transformations parameterized by displacements.

See also
ImageSimilarityMetric::EvaluateGradient

Reimplemented from mirtk::Transformation.

§ ParametricGradient() [2/2]

virtual void mirtk::MultiLevelFreeFormTransformation::ParametricGradient ( const PointSet ,
const Vector3D< double > *  ,
double *  ,
double  = 0,
double  = NaN,
double  = 1 
) const
virtual

Applies the chain rule to convert point-wise non-parametric gradient to a gradient w.r.t the parameters of this transformation.

Reimplemented from mirtk::Transformation.


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