cmtk::DeformationField Class Reference [cmtkBase Library]

Class for pixel-wise deformation field. More...

#include <cmtkDeformationField.h>

Inheritance diagram for cmtk::DeformationField:

Collaboration diagram for cmtk::DeformationField:

List of all members.

Public Types
typedef DeformationField	Self
	This class.
typedef WarpXform	Superclass
	Parent class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to DeformationField.
Public Member Functions
	DeformationField (const UniformVolume *volume)
	Constructor.
	DeformationField (const FixedVector< 3, Types::Coordinate > &domain, const DataGrid::IndexType &dims, const Types::Coordinate *offset=NULL)
	Constructor.
virtual	~DeformationField ()
	Destructor.
virtual void	InitGrid (const FixedVector< 3, Types::Coordinate > &domain, const DataGrid::IndexType &dims)
	Initialized internal data structures for new control point grid.
void	InitControlPoints (const AffineXform *affineXform=NULL)
	Initialize control point positions, potentially with affine displacement.
virtual void	ApplyInPlace (Self::SpaceVectorType &) const
	Apply transformation to vector in-place.
virtual bool	ApplyInverse (const Self::SpaceVectorType &, Self::SpaceVectorType &, const Types::Coordinate=0.01) const
	Return origin of warped vector.
virtual bool	ApplyInverseInPlace (Self::SpaceVectorType &, const Types::Coordinate=0.01) const
	Return origin of warped vector.
virtual void	GetTransformedGrid (Self::SpaceVectorType &v, const int idxX, const int idxY, const int idxZ) const
	Get a grid point from the deformed grid.
virtual void	GetTransformedGridRow (Self::SpaceVectorType *const v, const int numPoints, const int idxX, const int idxY, const int idxZ) const
	Get a sequence of grid points from the deformed grid.
virtual void	GetJacobian (const Self::SpaceVectorType &v, CoordinateMatrix3x3 &J) const
	Get Jacobian matrix.
virtual Types::Coordinate	GetJacobianDeterminant (const Self::SpaceVectorType &v) const
	Compute Jacobian determinant at a certain location.
virtual Types::Coordinate	GetParamStep (const size_t, const Self::SpaceVectorType &, const Types::Coordinate mmStep=1) const
	Return 1.0 since deformation field DOFs are always direct deformations in space units.
Protected Member Functions
virtual Self *	CloneVirtual () const
	Clone transformation.

---

Detailed Description

Class for pixel-wise deformation field.

Author:

Torsten Rohlfing

Definition at line 57 of file cmtkDeformationField.h.

---

Member Typedef Documentation

typedef DeformationField cmtk::DeformationField::Self

This class.

Reimplemented from cmtk::WarpXform.

Definition at line 63 of file cmtkDeformationField.h.

typedef SmartPointer<Self> cmtk::DeformationField::SmartPtr

Smart pointer to DeformationField.

Reimplemented from cmtk::WarpXform.

Definition at line 69 of file cmtkDeformationField.h.

typedef WarpXform cmtk::DeformationField::Superclass

Parent class.

Definition at line 66 of file cmtkDeformationField.h.

---

Constructor & Destructor Documentation

cmtk::DeformationField::DeformationField

(

const UniformVolume *

volume )

[inline]

Constructor.

Definition at line 73 of file cmtkDeformationField.h.

References cmtk::DataGrid::m_Dims, cmtk::Volume::m_Offset, and cmtk::Volume::Size.

cmtk::DeformationField::DeformationField	(	const FixedVector< 3, Types::Coordinate > &	domain,
		const DataGrid::IndexType &	dims,
		const Types::Coordinate *	offset = NULL
	)		[inline]

Constructor.

Definition at line 80 of file cmtkDeformationField.h.

virtual cmtk::DeformationField::~DeformationField

(

)

[inline, virtual]

Destructor.

Definition at line 91 of file cmtkDeformationField.h.

---

Member Function Documentation

virtual bool cmtk::DeformationField::ApplyInverse	(	const Self::SpaceVectorType &	,
		Self::SpaceVectorType &	,
		const Types::Coordinate	= 0.01
	)		const [inline, virtual]

Return origin of warped vector.

Implements cmtk::Xform.

Definition at line 116 of file cmtkDeformationField.h.

virtual bool cmtk::DeformationField::ApplyInverseInPlace	(	Self::SpaceVectorType &	,
		const Types::Coordinate	= 0.01
	)		const [inline, virtual]

Return origin of warped vector.

Implements cmtk::Xform.

Definition at line 124 of file cmtkDeformationField.h.

virtual Self* cmtk::DeformationField::CloneVirtual

(

)

const [inline, protected, virtual]

Clone transformation.

Todo:

This still needs to be implemented.

Implements cmtk::Xform.

Definition at line 157 of file cmtkDeformationField.h.

References NULL.

virtual Types::Coordinate cmtk::DeformationField::GetJacobianDeterminant

(

const Self::SpaceVectorType &

v )

const [inline, virtual]

Compute Jacobian determinant at a certain location.

Implements cmtk::Xform.

Definition at line 140 of file cmtkDeformationField.h.

References cmtk::Matrix3x3< T >::Determinant().

virtual Types::Coordinate cmtk::DeformationField::GetParamStep	(	const	size_t,
		const Self::SpaceVectorType &	,
		const Types::Coordinate	mmStep = 1
	)		const [inline, virtual]

Return 1.0 since deformation field DOFs are always direct deformations in space units.

Reimplemented from cmtk::WarpXform.

Definition at line 148 of file cmtkDeformationField.h.

virtual void cmtk::DeformationField::InitGrid	(	const FixedVector< 3, Types::Coordinate > &	domain,
		const DataGrid::IndexType &	dims
	)		[inline, virtual]

Initialized internal data structures for new control point grid.

Definition at line 94 of file cmtkDeformationField.h.

---

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

• libs/Base/cmtkDeformationField.h
• libs/Base/cmtkDeformationField.cxx
• libs/Base/cmtkDeformationField_Jacobian.cxx