Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

Implementation of an Identity Transform. More...

#include <itkIdentityTransform.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::IdentityTransform< TScalarType, NDimensions >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef IdentityTransform Self
typedef Transform< TScalarType,
NDimensions, NDimensions > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TScalarType ScalarType
typedef Superclass::ParametersType ParametersType
typedef Superclass::JacobianType JacobianType
typedef Vector< TScalarType,
itkGetStaticConstMacro(InputSpaceDimension) 
InputVectorType )
typedef Vector< TScalarType,
itkGetStaticConstMacro(OutputSpaceDimension) 
OutputVectorType )
typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(InputSpaceDimension) 
InputCovariantVectorType )
typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(OutputSpaceDimension) 
OutputCovariantVectorType )
typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(InputSpaceDimension) 
InputVnlVectorType )
typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(OutputSpaceDimension) 
OutputVnlVectorType )
typedef Point< TScalarType,
itkGetStaticConstMacro(InputSpaceDimension) 
InputPointType )
typedef Point< TScalarType,
itkGetStaticConstMacro(OutputSpaceDimension) 
OutputPointType )

Public Member Functions

virtual const char * GetNameOfClass () const
virtual OutputPointType TransformPoint (const InputPointType &point) const
virtual OutputVectorType TransformVector (const InputVectorType &vector) const
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const
void SetIdentity (void)
virtual void SetParameters (const ParametersType &)
 itkStaticConstMacro (InputSpaceDimension, unsigned int, NDimensions)
 itkStaticConstMacro (OutputSpaceDimension, unsigned int, NDimensions)
virtual const JacobianTypeGetJacobian (const InputPointType &) const

Static Public Member Functions

Pointer New ()

Protected Member Functions

 IdentityTransform ()
virtual ~IdentityTransform ()

Detailed Description

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

Implementation of an Identity Transform.

This class defines the generic interface for an Identity Transform.

It will map every point to itself, every vector to itself and every covariant vector to itself.

This class is intended to be used primarily as a default Transform for initializing those classes supporting a generic Transform.

This class is templated over the Representation type for coordinates (that is the type used for representing the components of points and vectors) and over the dimension of the space. In this case the Input and Output spaces are the same so only one dimension is required.

Definition at line 56 of file itkIdentityTransform.h.


Member Typedef Documentation

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

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 63 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef CovariantVector<TScalarType, itkGetStaticConstMacro(InputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::InputCovariantVectorType)
 

Standard covariant vector type for this class

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 94 of file itkIdentityTransform.h.

Referenced by itk::IdentityTransform< TScalarType, NDimensions >::TransformVector().

template<class TScalarType, unsigned int NDimensions = 3>
typedef Point<TScalarType, itkGetStaticConstMacro(InputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::InputPointType)
 

Standard coordinate point type for this class

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 108 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef Vector<TScalarType, itkGetStaticConstMacro(InputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::InputVectorType)
 

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 87 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(InputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::InputVnlVectorType)
 

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 101 of file itkIdentityTransform.h.

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

Type of the Jacobian matrix.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 83 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef CovariantVector<TScalarType, itkGetStaticConstMacro(OutputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::OutputCovariantVectorType)
 

Standard covariant vector type for this class

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 96 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef Point<TScalarType, itkGetStaticConstMacro(OutputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::OutputPointType)
 

Standard coordinate point type for this class

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 110 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef Vector<TScalarType, itkGetStaticConstMacro(OutputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::OutputVectorType)
 

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 89 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(OutputSpaceDimension) itk::IdentityTransform< TScalarType, NDimensions >::OutputVnlVectorType)
 

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 103 of file itkIdentityTransform.h.

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

Type of the input parameters.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 80 of file itkIdentityTransform.h.

Referenced by itk::IdentityTransform< TScalarType, NDimensions >::SetIdentity().

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

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 62 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
typedef TScalarType itk::IdentityTransform< TScalarType, NDimensions >::ScalarType
 

Type of the input parameters.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 77 of file itkIdentityTransform.h.

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

Standard class typedefs.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 60 of file itkIdentityTransform.h.

Referenced by itk::IdentityTransform< TScalarType, NDimensions >::IdentityTransform().

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

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 61 of file itkIdentityTransform.h.


Constructor & Destructor Documentation

template<class TScalarType, unsigned int NDimensions = 3>
itk::IdentityTransform< TScalarType, NDimensions >::IdentityTransform  )  [inline, protected]
 

Definition at line 180 of file itkIdentityTransform.h.

References itk::IdentityTransform< TScalarType, NDimensions >::Self.

template<class TScalarType, unsigned int NDimensions = 3>
virtual itk::IdentityTransform< TScalarType, NDimensions >::~IdentityTransform  )  [inline, protected, virtual]
 

Definition at line 181 of file itkIdentityTransform.h.


Member Function Documentation

template<class TScalarType, unsigned int NDimensions = 3>
virtual const JacobianType& itk::IdentityTransform< TScalarType, NDimensions >::GetJacobian const InputPointType  )  const [inline, virtual]
 

Compute the Jacobian of the transformation

This method computes the Jacobian matrix of the transformation. given point or vector, returning the transformed point or vector. The rank of the Jacobian will also indicate if the transform is invertible at this point.

The Jacobian can be expressed as a set of partial derivatives of the output point components with respect to the parameters that defined the transform:

\[ J=\left[ \begin{array}{cccc} \frac{\partial x_{1}}{\partial p_{1}} & \frac{\partial x_{2}}{\partial p_{1}} & \cdots & \frac{\partial x_{n}}{\partial p_{1}}\\ \frac{\partial x_{1}}{\partial p_{2}} & \frac{\partial x_{2}}{\partial p_{2}} & \cdots & \frac{\partial x_{n}}{\partial p_{2}}\\ \vdots & \vdots & \ddots & \vdots \\ \frac{\partial x_{1}}{\partial p_{m}} & \frac{\partial x_{2}}{\partial p_{m}} & \cdots & \frac{\partial x_{n}}{\partial p_{m}} \end{array}\right] \]

*

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 169 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
virtual const char* itk::IdentityTransform< TScalarType, NDimensions >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType, unsigned int NDimensions = 3>
itk::IdentityTransform< TScalarType, NDimensions >::itkStaticConstMacro OutputSpaceDimension  ,
unsigned  int,
NDimensions 
 

Dimension of the domain space.

template<class TScalarType, unsigned int NDimensions = 3>
itk::IdentityTransform< TScalarType, NDimensions >::itkStaticConstMacro InputSpaceDimension  ,
unsigned  int,
NDimensions 
 

Dimension of the domain space.

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

New method for creating an object using a factory.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType, unsigned int NDimensions = 3>
void itk::IdentityTransform< TScalarType, NDimensions >::SetIdentity void   )  [inline]
 

Set the transformation to an Identity

This is a NULL operation in the case of this particular transform. The method is provided only to comply with the interface of other transforms.

Definition at line 134 of file itkIdentityTransform.h.

References itk::IdentityTransform< TScalarType, NDimensions >::ParametersType.

template<class TScalarType, unsigned int NDimensions = 3>
virtual void itk::IdentityTransform< TScalarType, NDimensions >::SetParameters const ParametersType  )  [inline, virtual]
 

Set the Transformation Parameters and update the internal transformation.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 139 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
virtual OutputCovariantVectorType itk::IdentityTransform< TScalarType, NDimensions >::TransformCovariantVector const InputCovariantVectorType vector  )  const [inline, virtual]
 

Method to transform a CovariantVector.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 126 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
virtual OutputPointType itk::IdentityTransform< TScalarType, NDimensions >::TransformPoint const InputPointType point  )  const [inline, virtual]
 

Method to transform a point.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 114 of file itkIdentityTransform.h.

template<class TScalarType, unsigned int NDimensions = 3>
virtual OutputVnlVectorType itk::IdentityTransform< TScalarType, NDimensions >::TransformVector const InputVnlVectorType vector  )  const [inline, virtual]
 

Method to transform a vnl_vector.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 122 of file itkIdentityTransform.h.

References itk::IdentityTransform< TScalarType, NDimensions >::InputCovariantVectorType.

template<class TScalarType, unsigned int NDimensions = 3>
virtual OutputVectorType itk::IdentityTransform< TScalarType, NDimensions >::TransformVector const InputVectorType vector  )  const [inline, virtual]
 

Method to transform a vector.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 118 of file itkIdentityTransform.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:11:18 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000