mitkTransform Class Reference

mitkTransform - an abstract class to perform coordinates transformation More...

#include <mitkTransform.h>

Inherits mitkProcessObject.

Inherited by mitkAffineTransform, mitkBSplineFreeFormTransform, mitkRigidTransform, mitkScaleTransform, mitkSimilarityTransform, mitkThinPlateSplineTransform, mitkTranslationTransform, mitkVersorRigid3DTransform, and mitkVersorSimilarity3DTransform.

Inheritance diagram for mitkTransform:

[legend]Collaboration diagram for mitkTransform:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
virtual void	SetParameters (const VectorParameterType &parameters)
virtual VectorParameterType &	GetParameters ()
void	SetDimensions (int d[3])
const VectorIndexType &	GetDimensions () const
unsigned int	GetSpaceDimension ()
void	SetSpacings (float s[3])
const VectorParameterType &	GetSpacings () const
mitkVolume *	GetOutput ()
unsigned int	GetNumberOfParameters ()
void	SetCentreTransformFlag (bool flag)
void	SetRegion (const VectorIndexType &r)
virtual bool	Update ()
virtual const MatrixType &	GetJacobian (const VectorParameterType &inPoint)
virtual void	TransformPoint (const ScalarIndexType &x, const ScalarIndexType &y, const ScalarIndexType &z, float *outPoint)
virtual void	TransformPoint (const ScalarParameterType &x, const ScalarParameterType &y, const ScalarParameterType &z, ScalarParameterType *outPoint)
void	SetIdentityMatrix ()
virtual void	ComputeTransformMatrix ()
void	SetComputeMatrixFlag (bool flag)
void	SetComputeJacobianFlag (bool flag)
void	SetComputeTransformParametersFlag (bool flag)
void	SetTransformMatrix (mitkMatrixScalarType *matrix, bool ToCentered=true)
void	SetTransformMatrix (mitkMatrixType *matrix, bool ToCentered=true)
mitkMatrixType *	GetTransformMatrix ()
void	ConcatenationTransform (mitkMatrixType *matrix, bool ToCentered=true)
bool	GetConcatenationTransformFlag ()
virtual void	SetTransformMode (int transformMode, unsigned int dim)
int	GetTransformMode ()
virtual void	ConvertTransformMaxtrixToVector ()
virtual void	ConvertTransformVectorToMatrix ()
bool	TransformPointSet (mitkPointSet *p)
bool	TransformPointSet (mitkPointSet *p1, mitkPointSet *p2)
void	SetOutputDatatype (int dataType)

---

Detailed Description

mitkTransform - an abstract class to perform coordinates transformation

mitkTransform is an abstract class to perform coordinates transformation, which will convert one point from the Reference object space to the Target object space.

---

Member Function Documentation

virtual void mitkTransform::ComputeTransformMatrix (   )  [virtual]

Calculate the transform matrix. Returns: Return true if the computation is performed without error. Reimplemented in mitkAffineTransform, mitkRigidTransform, mitkScaleTransform, mitkSimilarityTransform, mitkThinPlateSplineTransform, mitkTranslationTransform, mitkVersorRigid3DTransform, and mitkVersorSimilarity3DTransform.

void mitkTransform::ConcatenationTransform (  mitkMatrixType *  matrix, bool  ToCentered = true )

Compute PreTransformMatrix in order to perform concatenate transform. Parameters: matrix  The pointer to the matrix which multiplies with PreTransformMatrix.

virtual void mitkTransform::ConvertTransformMaxtrixToVector (   )  [virtual]

Convert transform matrix to transform parameter vector. Reimplemented in mitkAffineTransform, mitkRigidTransform, mitkScaleTransform, mitkSimilarityTransform, mitkThinPlateSplineTransform, mitkTranslationTransform, mitkVersorRigid3DTransform, and mitkVersorSimilarity3DTransform.

virtual void mitkTransform::ConvertTransformVectorToMatrix (   )  [virtual]

Convert transform parameter vector to transform matrix.

bool mitkTransform::GetConcatenationTransformFlag (   )  [inline]

Get the Concatenation Transform Flag. Returns: Return the flag value.

const VectorIndexType& mitkTransform::GetDimensions (   )  const [inline]

Get dimension in x, y, z direction of fixed volume. Parameters: d[0]  Get the dimension in x direction. d[1]  Get the dimension in y direction. d[2]  Get the dimension in z direction.

virtual const MatrixType& mitkTransform::GetJacobian (  const VectorParameterType &  inPoint  )  [virtual]

Get the Jacobian matrix. Parameters: x  The x index of the point in image. y  The y index of the point in image. z  The z index of the point in image. Returns: Return the pointer to the Jacobian matrix. Reimplemented in mitkAffineTransform, mitkRigidTransform, mitkScaleTransform, mitkSimilarityTransform, mitkTranslationTransform, mitkVersorRigid3DTransform, and mitkVersorSimilarity3DTransform.

unsigned int mitkTransform::GetNumberOfParameters (   )  [inline]

Get number of transform parameters. Returns: Return the number of transform parameters.

mitkVolume* mitkTransform::GetOutput (   )

Get the output volume. Returns: Return the output volume.

virtual VectorParameterType& mitkTransform::GetParameters (   )  [virtual]

Get Transform Parameters. Returns: Return the transform parameters.

unsigned int mitkTransform::GetSpaceDimension (   )  [inline]

Get transform space dimension. Returns: Return the space dimension.

const VectorParameterType& mitkTransform::GetSpacings (   )  const [inline]

Get spacing information in x, y and z axis of the fixed volume, the unit is mm. Parameters: s[0]  Return the spacing (mm) in two adjacent voxels in x axis. It is equal to the return value of GetSpacingX() s[1]  Return the spacing (mm) in two adjacent voxels in y axis. It is equal to the return value of GetSpacingY() s[2]  Return the spacing (mm) in two adjacent voxels in z axis. It is equal to the return value of GetSpacingZ()

mitkMatrixType* mitkTransform::GetTransformMatrix (   )

Get the transform matrix. Returns: Return the pointer to the transform matrix.

int mitkTransform::GetTransformMode (   )  [inline]

Get the transform mode. Returns: Return the mode of transform.

virtual void mitkTransform::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkProcessObject. Reimplemented in mitkAffineTransform, mitkRigidTransform, mitkScaleTransform, mitkSimilarityTransform, mitkThinPlateSplineTransform, mitkTranslationTransform, mitkVersorRigid3DTransform, and mitkVersorSimilarity3DTransform.

void mitkTransform::SetCentreTransformFlag (  bool  flag  )  [inline]

Set the flag of center transform. Parameters: flag  The flag of center transform.

void mitkTransform::SetComputeJacobianFlag (  bool  flag  )  [inline]

Set the compute Jacobian parameters flag. Parameters: flag  Compute Jacobian parameters if the flag is true.

void mitkTransform::SetComputeMatrixFlag (  bool  flag  )  [inline]

Set the compute matrix flag. Parameters: flag  Compute transform matrix if the flag is true.

void mitkTransform::SetComputeTransformParametersFlag (  bool  flag  )  [inline]

Set the compute transform parameter vector flag. Parameters: flag  Compute transform parameter vector if the flag is true.

void mitkTransform::SetDimensions (  int  d[3]  )

Set dimension in x, y, z direction of fixed volume. Parameters: dims[0]  The dimension in x direction. dims[1]  The dimension in y direction. dims[2]  The dimension in z direction.

void mitkTransform::SetIdentityMatrix (   )

Set the transform matrix to identity.

void mitkTransform::SetOutputDatatype (  int  dataType  )  [inline]

Set the data type for output volume. Parameters: dataType  Specify the output volume's data type.

virtual void mitkTransform::SetParameters (  const VectorParameterType &  parameters  )  [virtual]

Set the transform parameters. Parameters: parameters  The transform parameters.

void mitkTransform::SetRegion (  const VectorIndexType &  r  )

Set the region of transform Parameters: r[0]  The first (smaller) index in x axis, the unit is pixel. r[1]  The second (bigger) index in x axis, the unit is pixel. r[2]  The first (smaller) index in y axis, the unit is pixel. r[3]  The second (bigger) index in y axis, the unit is pixel. r[4]  The first (smaller) index in z axis, the unit is pixel. r[5]  The second (bigger) index in z axis, the unit is pixel.

void mitkTransform::SetSpacings (  float  s[3]  )

Set spacing information in x, y and z axis of the fixed volume, the unit is mm. Parameters: s[0]  Set the spacing (mm) in two adjacent voxels in x axis. s[1]  Set the spacing (mm) in two adjacent voxels in y axis. s[2]  Set the spacing (mm) in two adjacent voxels in z axis.

void mitkTransform::SetTransformMatrix (  mitkMatrixType *  matrix, bool  ToCentered = true )

Initialize transform matrix using a matrix. Parameters: matrix  The pointer to the transform matrix user defined.

void mitkTransform::SetTransformMatrix (  mitkMatrixScalarType *  matrix, bool  ToCentered = true )

Initialize transform matrix using an array. Parameters: matrix  The pointer to the transform matrix user defined.

virtual void mitkTransform::SetTransformMode (  int  transformMode, unsigned int  dim )  [virtual]

Set the transform mode. param mode Specify the transform mode. Reimplemented in mitkScaleTransform.

virtual void mitkTransform::TransformPoint (  const ScalarParameterType &  x, const ScalarParameterType &  y, const ScalarParameterType &  z, ScalarParameterType *  outPoint )  [virtual]

Perform a point transform. (point transform) /param point The transformed point need to be compute /param x The x index of the point in image. /param y The y index of the point in image. /param z The z index of the point in image. /return Return true if the transformation is performed without errors.

virtual void mitkTransform::TransformPoint (  const ScalarIndexType &  x, const ScalarIndexType &  y, const ScalarIndexType &  z, float *  outPoint )  [virtual]

Perform a point transform. (pixel transform) /param point The transformed point need to be compute /param x The x index of the point in image. /param y The y index of the point in image. /param z The z index of the point in image. /return Return true if the transformation is performed without errors.

bool mitkTransform::TransformPointSet (  mitkPointSet *  p1, mitkPointSet *  p2 )

Perform point set transform. /param p1 The pointer to a input point set. /param p2 The pointer to a output point set. /return Return true if the transformation is performed without errors.

bool mitkTransform::TransformPointSet (  mitkPointSet *  p  )

Perform a point set transform. /param p The pointer to a input point set. /return Return true if the transformation is performed without errors.

virtual bool mitkTransform::Update (   )  [virtual]

Initialization, perform before Run() function

---

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

• mitkTransform.h

---