#include <PartialBSplineFreeFormTransformationSV.h>

Inheritance diagram for mirtk::PartialBSplineFreeFormTransformationSV:

Collaboration diagram for mirtk::PartialBSplineFreeFormTransformationSV:

Public Member Functions
virtual void	Add (const DOFValue *)
	Add change to transformation parameters.

virtual bool	CopyFrom (const class Transformation *)

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	Get (int) const
	Get value of transformation parameter.

virtual void	Get (DOFValue *) const
	Get values of transformation parameters.

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 class Transformation *) const
	Checks whether transformation depends on the same vector of parameters.

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 bool	Inverse (double &, double &, double &, double=0, double=NaN) const
	Transforms a single point using the inverse of the transformation.

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 the transformation is an identity mapping.

virtual void	Jacobian (Matrix &, double, double, double, double=0, double=NaN) const
	Calculates 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	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 (double &, double &, double &, double=0, double=NaN) const
	Transforms a single point using the inverse of the local transformation only.

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 void	LocalTransform (double &, double &, double &, double=0, double=NaN) const
	Transforms a single point using the local transformation component only.

virtual int	NumberOfDOFs () const
	Get number of transformation parameters.

virtual ParameterList	Parameter () const
	Get (non-DoF) parameters as key/value as string map.

virtual void	ParametricGradient (const GenericImage< double > , double , const WorldCoordsImage , const WorldCoordsImage , double=NaN, double=1) const

virtual void	ParametricGradient (const GenericImage< double > *, int, double , const WorldCoordsImage , const WorldCoordsImage , const double *=NULL, double=1) const

	PartialBSplineFreeFormTransformationSV (BSplineFreeFormTransformationSV *=NULL, double=1.0)
	Constructor.

	PartialBSplineFreeFormTransformationSV (const PartialBSplineFreeFormTransformationSV &)
	Copy constructor.

virtual void	Print (ostream &, Indent=0) const
	Prints information about the transformation.

virtual void	Put (int, double)
	Put value of transformation parameter.

virtual void	Put (const DOFValue *)
	Put values of transformation parameters.

virtual void	PutStatus (int, DOFStatus)
	Put status of transformation parameter.

virtual Cifstream &	Read (Cifstream &)
	Reads transformation from a file stream.

virtual bool	RequiresCachingOfDisplacements () const

virtual bool	Set (const char , const char )
	Set named (non-DoF) parameter from value as string.

virtual void	Transform (double &, double &, double &, double=0, double=NaN) const
	Transforms a single point.

virtual double	Update (const DOFValue *)
	Update transformation parameters given parametric gradient.

virtual Cofstream &	Write (Cofstream &) const
	Writes transformation to a file stream.

virtual	~PartialBSplineFreeFormTransformationSV ()
	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	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 &, const Transformation *, int=1, double=.0)
	Approximate another transformation and return approximation error.

virtual double	ApproximateAsNew (GenericImage< double > &, 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

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	CanModifyDisplacement (int=-1) const

virtual bool	CanRead (TransformationType) const
	Whether this transformation can read a file of specified type (i.e. format)

virtual bool	CopyFrom (const Transformation *)

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 (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.

virtual void	DisplacementAfterDOFChange (int dof, double dv, GenericImage< double > &dx, double t, double t0=NaN, const WorldCoordsImage *i2w=NULL) const

virtual bool	DOFBoundingBox (const Image *, int, int &, int &, int &, int &, int &, int &, double=1) const

virtual double	DOFGradientNorm (const double *) const
	Get norm of the gradient vector.

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	HasSameDOFsAs (const Transformation *) const
	Checks whether transformation depends on the same vector of parameters.

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

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

virtual void	ParametricGradient (const PointSet &, const Vector3D< double > , double , double=0, double=NaN, 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 void	Reset ()
	Reset transformation.

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	~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::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 Transformation *	New (TransformationType)

static Transformation *	New (const Transformation *)

static Transformation *	New (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::Transformation
void	InitializeDOFs (int)
	Initialize transformation parameters.

void	InitializeDOFs (const Transformation &, int=-1)
	Copy transformation parameters (DoFs) and their status.

virtual Cifstream &	ReadDOFs (Cifstream &, TransformationType)
	Reads transformation parameters from a file stream.

	Transformation (int=0)
	Default constructor.

	Transformation (const Transformation &)
	Copy constructor.

	Transformation (const Transformation &, int)
	Copy constructor.

virtual Cofstream &	WriteDOFs (Cofstream &) const
	Writes transformation parameters to a file stream.

Protected Member Functions inherited from mirtk::Observable
	Observable ()
	Default constructor.

	Observable (const Observable &)
	Copy constructor.

Observable &	operator= (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::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

Decorator for SV FFD transformation.

This decorator wraps a SV FFD transformation but defines it's own attributes regarding integration and whether or not to invert the transformation by default. As the SV FFD is parameterized by stationary velocities, inverting the transformation is simply achieved by a negative upper integration limit. Two instances of this decorator are in particular used by SymmetricBSplineFreeFormTransformation for the two half transformations to deform both input images.

Definition at line 41 of file PartialBSplineFreeFormTransformationSV.h.

Member Function Documentation

§ CopyFrom()

virtual bool mirtk::PartialBSplineFreeFormTransformationSV::CopyFrom ( const class Transformation * )

virtual

Copy active transformation parameters (DoFs) from given transformation if possible and return false, otherwise

§ Displacement() [1/2]

virtual void mirtk::PartialBSplineFreeFormTransformationSV::Displacement	(	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::Transformation.

§ Displacement() [2/2]

virtual void mirtk::PartialBSplineFreeFormTransformationSV::Displacement	(	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::Transformation.

§ InverseDisplacement() [1/2]

virtual int mirtk::PartialBSplineFreeFormTransformationSV::InverseDisplacement	(	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: Always zero.

Reimplemented from mirtk::Transformation.

§ InverseDisplacement() [2/2]

virtual int mirtk::PartialBSplineFreeFormTransformationSV::InverseDisplacement	(	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: Always zero.

Reimplemented from mirtk::Transformation.

§ ParametricGradient() [1/2]

virtual void mirtk::PartialBSplineFreeFormTransformationSV::ParametricGradient	(	const GenericImage< double > *	,
		double *	,
		const WorldCoordsImage *	,
		const WorldCoordsImage *	,
		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.

Reimplemented from mirtk::Transformation.

§ ParametricGradient() [2/2]

virtual void mirtk::PartialBSplineFreeFormTransformationSV::ParametricGradient	(	const GenericImage< double > **	,
		int	,
		double *	,
		const WorldCoordsImage *	,
		const WorldCoordsImage *	,
		const double *	= `NULL`,
		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.

Reimplemented from mirtk::Transformation.

§ RequiresCachingOfDisplacements()

virtual bool mirtk::PartialBSplineFreeFormTransformationSV::RequiresCachingOfDisplacements ( ) const

virtual

Whether the caching of the transformation displacements is required (or preferred) by this transformation. For some transformations such as those parameterized by velocities, caching of the displacements for each target voxel results in better performance or is needed for example for the scaling and squaring method.

Reimplemented from mirtk::Transformation.

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

PartialBSplineFreeFormTransformationSV.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

§ CopyFrom()

§ Displacement() [1/2]

§ Displacement() [2/2]

§ InverseDisplacement() [1/2]

§ InverseDisplacement() [2/2]

§ ParametricGradient() [1/2]

§ ParametricGradient() [2/2]

§ RequiresCachingOfDisplacements()