itk::TranslationTransform< TScalarType, NDimensions > Class Template Reference
[Transforms]

Translation transformation of a vector space (e.g. space coordinates). More...

#include <itkTranslationTransform.h>

Inheritance diagram for itk::TranslationTransform< TScalarType, NDimensions >:

[legend]Collaboration diagram for itk::TranslationTransform< TScalarType, NDimensions >:

[legend]List of all members.

Public Types
typedef TranslationTransform	Self
typedef Transform< TScalarType, NDimensions, NDimensions >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ScalarType	ScalarType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension)	InputVectorType )
typedef Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension)	OutputVectorType )
typedef CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension)	InputCovariantVectorType )
typedef CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension)	OutputCovariantVectorType )
typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension)	InputVnlVectorType )
typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension)	OutputVnlVectorType )
typedef Point< TScalarType, itkGetStaticConstMacro(SpaceDimension)	InputPointType )
typedef Point< TScalarType, itkGetStaticConstMacro(SpaceDimension)	OutputPointType )
Public Member Functions
virtual const char *	GetClassName () const
const OutputVectorType &	GetOffset (void) const
void	SetParameters (const ParametersType &parameters)
virtual const ParametersType &	GetParameters (void) const
void	SetOffset (const OutputVectorType &offset)
void	Compose (const Self *other, bool pre=0)
void	Translate (const OutputVectorType &offset, bool pre=0)
TranslationTransform::Pointer	Inverse (void) const
virtual const JacobianType &	GetJacobian (const InputPointType &point) const
void	SetIdentity (void)
virtual unsigned int	GetNumberOfParameters (void) const
	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)
	itkStaticConstMacro (ParametersDimension, unsigned int, NDimensions)
OutputPointType	TransformPoint (const InputPointType &point) const
OutputVectorType	TransformVector (const InputVectorType &vector) const
OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector) const
OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector) const
InputPointType	BackTransform (const OutputPointType &point) const
InputVectorType	BackTransform (const OutputVectorType &vector) const
InputVnlVectorType	BackTransform (const OutputVnlVectorType &vector) const
InputCovariantVectorType	BackTransform (const OutputCovariantVectorType &vector) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	TranslationTransform ()
	~TranslationTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TScalarType = double, unsigned int NDimensions = 3>
class itk::TranslationTransform< TScalarType, NDimensions >

Translation transformation of a vector space (e.g. space coordinates).

The same functionality could be obtained by using the Affine tranform, but with a large difference in performace.

Definition at line 42 of file itkTranslationTransform.h.

---

Member Typedef Documentation

template<class TScalarType = double, unsigned int NDimensions = 3> typedef SmartPointer<const Self> itk::TranslationTransform< TScalarType, NDimensions >::ConstPointer

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 50 of file itkTranslationTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3> typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::InputCovariantVectorType)

Standard covariant vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 78 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::InputPointType)

Standard coordinate point type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 88 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::InputVectorType)

Standard vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 73 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::InputVnlVectorType)

Standard vnl_vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 83 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Superclass::JacobianType itk::TranslationTransform< TScalarType, NDimensions >::JacobianType

Standard Jacobian container. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 70 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::OutputCovariantVectorType)

Standard covariant vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 79 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::OutputPointType)

Standard coordinate point type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 89 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::OutputVectorType)

Standard vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 74 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::GetOffset(), and itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::TranslationTransform< TScalarType, NDimensions >::OutputVnlVectorType)

Standard vnl_vector type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 84 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Superclass::ParametersType itk::TranslationTransform< TScalarType, NDimensions >::ParametersType

Standard parameters container. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 67 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::GetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef SmartPointer<Self> itk::TranslationTransform< TScalarType, NDimensions >::Pointer

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 49 of file itkTranslationTransform.h. Referenced by itk::TranslationTransform< TScalarType, NDimensions >::SetOffset().

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Superclass::ScalarType itk::TranslationTransform< TScalarType, NDimensions >::ScalarType

Standard scalar type for this class. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 64 of file itkTranslationTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3> typedef TranslationTransform itk::TranslationTransform< TScalarType, NDimensions >::Self

Standard class typedefs. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 47 of file itkTranslationTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3> typedef Transform< TScalarType, NDimensions, NDimensions > itk::TranslationTransform< TScalarType, NDimensions >::Superclass

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 48 of file itkTranslationTransform.h.

---

Constructor & Destructor Documentation

template<class TScalarType = double, unsigned int NDimensions = 3> itk::TranslationTransform< TScalarType, NDimensions >::TranslationTransform (   )  [protected]

template<class TScalarType = double, unsigned int NDimensions = 3> itk::TranslationTransform< TScalarType, NDimensions >::~TranslationTransform (   )  [protected]

---

Member Function Documentation

template<class TScalarType = double, unsigned int NDimensions = 3> InputCovariantVectorType itk::TranslationTransform< TScalarType, NDimensions >::BackTransform (  const OutputCovariantVectorType &  vector  )  const [inline]

This method finds the point or vector that maps to a given point or vector under the affine transformation defined by self. If no such point exists, an exception is thrown.

template<class TScalarType = double, unsigned int NDimensions = 3> InputVnlVectorType itk::TranslationTransform< TScalarType, NDimensions >::BackTransform (  const OutputVnlVectorType &  vector  )  const [inline]

This method finds the point or vector that maps to a given point or vector under the affine transformation defined by self. If no such point exists, an exception is thrown.

template<class TScalarType = double, unsigned int NDimensions = 3> InputVectorType itk::TranslationTransform< TScalarType, NDimensions >::BackTransform (  const OutputVectorType &  vector  )  const [inline]

This method finds the point or vector that maps to a given point or vector under the affine transformation defined by self. If no such point exists, an exception is thrown.

template<class TScalarType = double, unsigned int NDimensions = 3> InputPointType itk::TranslationTransform< TScalarType, NDimensions >::BackTransform (  const OutputPointType &  point  )  const [inline]

This method finds the point or vector that maps to a given point or vector under the affine transformation defined by self. If no such point exists, an exception is thrown.

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::Compose (  const Self *  other, bool  pre = 0 )

Compose with another TranslationTransform.

template<class TScalarType = double, unsigned int NDimensions = 3> virtual const char* itk::TranslationTransform< TScalarType, NDimensions >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> virtual const JacobianType& itk::TranslationTransform< TScalarType, NDimensions >::GetJacobian (  const InputPointType &  point  )  const [virtual]

Compute the Jacobian Matrix of the transformation at one point Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> virtual unsigned int itk::TranslationTransform< TScalarType, NDimensions >::GetNumberOfParameters (  void   )  const [inline, virtual]

Return the number of parameters that completely define the Transfom Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >. Definition at line 153 of file itkTranslationTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3> const OutputVectorType& itk::TranslationTransform< TScalarType, NDimensions >::GetOffset (  void   )  const [inline]

This method returns the value of the offset of the TranslationTransform. Definition at line 94 of file itkTranslationTransform.h. References itk::TranslationTransform< TScalarType, NDimensions >::OutputVectorType, and itk::TranslationTransform< TScalarType, NDimensions >::ParametersType.

template<class TScalarType = double, unsigned int NDimensions = 3> virtual const ParametersType& itk::TranslationTransform< TScalarType, NDimensions >::GetParameters (  void   )  const [virtual]

Get the Transformation Parameters. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> TranslationTransform::Pointer itk::TranslationTransform< TScalarType, NDimensions >::Inverse (  void   )  const

Find inverse of an affine transformation. This method creates and returns a new TranslationTransform object which is the inverse of self. If self is not invertible, an exception is thrown.

template<class TScalarType = double, unsigned int NDimensions = 3> itk::TranslationTransform< TScalarType, NDimensions >::itkStaticConstMacro (  ParametersDimension  , unsigned  int, NDimensions  )

Dimension of the domain space.

template<class TScalarType = double, unsigned int NDimensions = 3> itk::TranslationTransform< TScalarType, NDimensions >::itkStaticConstMacro (  SpaceDimension  , unsigned  int, NDimensions  )

Dimension of the domain space.

template<class TScalarType = double, unsigned int NDimensions = 3> Pointer itk::TranslationTransform< TScalarType, NDimensions >::New (   )  [static]

New macro for creation of through the object factory. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Print contents of an TranslationTransform. Reimplemented from itk::Object.

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::SetIdentity (  void   )

Set the parameters to the IdentityTransform

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::SetOffset (  const OutputVectorType &  offset  )  [inline]

Set offset of an Translation Transform. This method sets the offset of an TranslationTransform to a value specified by the user. Definition at line 107 of file itkTranslationTransform.h. References itk::TranslationTransform< TScalarType, NDimensions >::InputCovariantVectorType, itk::TranslationTransform< TScalarType, NDimensions >::InputPointType, itk::TranslationTransform< TScalarType, NDimensions >::InputVectorType, itk::TranslationTransform< TScalarType, NDimensions >::InputVnlVectorType, itk::TranslationTransform< TScalarType, NDimensions >::JacobianType, itk::TranslationTransform< TScalarType, NDimensions >::OutputCovariantVectorType, itk::TranslationTransform< TScalarType, NDimensions >::OutputPointType, itk::TranslationTransform< TScalarType, NDimensions >::OutputVectorType, itk::TranslationTransform< TScalarType, NDimensions >::OutputVnlVectorType, and itk::TranslationTransform< TScalarType, NDimensions >::Pointer.

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::SetParameters (  const ParametersType &  parameters  )  [virtual]

This method sets the parameters for the transform value specified by the user. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> OutputCovariantVectorType itk::TranslationTransform< TScalarType, NDimensions >::TransformCovariantVector (  const InputCovariantVectorType &  vector  )  const [virtual]

Transform by an affine transformation. This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> OutputPointType itk::TranslationTransform< TScalarType, NDimensions >::TransformPoint (  const InputPointType &  point  )  const [virtual]

Transform by an affine transformation. This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> OutputVnlVectorType itk::TranslationTransform< TScalarType, NDimensions >::TransformVector (  const InputVnlVectorType &  vector  )  const [virtual]

Transform by an affine transformation. This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> OutputVectorType itk::TranslationTransform< TScalarType, NDimensions >::TransformVector (  const InputVectorType &  vector  )  const [virtual]

Transform by an affine transformation. This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = double, unsigned int NDimensions = 3> void itk::TranslationTransform< TScalarType, NDimensions >::Translate (  const OutputVectorType &  offset, bool  pre = 0 )

Compose affine transformation with a translation. This method modifies self to include a translation of the origin. The translation is precomposed with self if pre is true, and postcomposed otherwise.

---

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

• itkTranslationTransform.h

---