Transform points and vector from an input space to an output space. More...

#include <itkTransform.h>

Inheritance diagram for itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >:

Collaboration diagram for itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < TScalarType, NInputDimensions >	InputCovariantVectorType
typedef Point< TScalarType, NInputDimensions >	InputPointType
typedef Vector< TScalarType, NInputDimensions >	InputVectorType
typedef vnl_vector_fixed < TScalarType, NInputDimensions >	InputVnlVectorType
typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer
typedef TransformBase	InverseTransformBaseType
typedef Array2D< double >	JacobianType
typedef CovariantVector < TScalarType, NOutputDimensions >	OutputCovariantVectorType
typedef Point< TScalarType, NOutputDimensions >	OutputPointType
typedef Vector< TScalarType, NOutputDimensions >	OutputVectorType
typedef vnl_vector_fixed < TScalarType, NOutputDimensions >	OutputVnlVectorType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::ParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef TScalarType	ScalarType
typedef Transform	Self
typedef TransformBase	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
unsigned int	GetInputSpaceDimension (void) const
bool	GetInverse (Self *) const
virtual InverseTransformBasePointer	GetInverseTransform () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters (void) const
unsigned int	GetOutputSpaceDimension (void) const
virtual int	GetReferenceCount () const
virtual std::string	GetTransformTypeAsString () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual bool	IsLinear () const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetFixedParameters (const ParametersType &)=0
virtual void	SetFixedParameters (const ParametersType &)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParameters (const ParametersType &)
virtual void	SetParametersByValue (const ParametersType &p)
virtual void	SetParametersByValue (const ParametersType &p)=0
virtual void	SetReferenceCount (int)
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
virtual OutputPointType	TransformPoint (const InputPointType &) const
virtual OutputVectorType	TransformVector (const InputVectorType &) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const
virtual void	UnRegister () const


virtual const ParametersType &	GetParameters (void) const


virtual const ParametersType &	GetFixedParameters (void) const


virtual const JacobianType &	GetJacobian (const InputPointType &) const


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes


static const unsigned int	InputSpaceDimension = NInputDimensions
static const unsigned int	OutputSpaceDimension = NOutputDimensions
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	Transform (unsigned int Dimension, unsigned int NumberOfParameters)
	Transform ()
virtual	~Transform ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
ParametersType	m_FixedParameters
JacobianType	m_Jacobian
ParametersType	m_Parameters
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Detailed Description

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
class itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >

Transform points and vector from an input space to an output space.

This abstract class define the generic interface for a geometrical transformation from one space to another. The class provides methods for mapping points, vectors and covariant vectors from the input space to the output space.

Given that transformation are not necesarily invertible, this basic class does not provide the methods for back transfromation. Back transform methods are implemented in derived classes where appropriate.

Registration Framework Support: Typically a Transform class has several methods for setting its parameters. For use in the registration framework, the parameters must also be represented by an array of doubles to allow communication with generic optimizers. The Array of transformation parameters is set using the SetParameters() method.

Another requirement of the registration framework is the computation of the transform Jacobian. In general, a ImageToImageMetric requires the knowledge of the Jacobian in order to compute the metric derivatives. The Jacobian is a matrix whose element are the partial derivatives of the output point with respect to the array of parameters that defines the transform.

Definition at line 66 of file itkTransform.h.

Member Typedef Documentation

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SmartPointer< const Self > itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ConstPointer

Reimplemented from itk::TransformBase.

Definition at line 73 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef CovariantVector<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputCovariantVectorType

Standard covariant vector type for this class

Definition at line 107 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Point<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputPointType

Standard coordinate point type for this class

Definition at line 115 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Vector<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputVectorType

Standard vector type for this class.

Definition at line 103 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef vnl_vector_fixed<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputVnlVectorType

Standard vnl_vector type for this class.

Definition at line 111 of file itkTransform.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef InverseTransformBaseType::Pointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InverseTransformBasePointer

Reimplemented in itk::AffineTransform< TScalarType, NDimensions >, itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::CenteredEuler3DTransform< TScalarType >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, itk::IdentityTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::Rigid2DTransform< TScalarType >, itk::Rigid3DTransform< TScalarType >, itk::ScalableAffineTransform< TScalarType, NDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::Similarity2DTransform< TScalarType >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 128 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef TransformBase itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InverseTransformBaseType

Base inverse transform type. This type should not be changed to the concrete inverse transform type or inheritance would be lost.

Reimplemented in itk::AffineTransform< TScalarType, NDimensions >, itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::CenteredEuler3DTransform< TScalarType >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, itk::IdentityTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::Rigid2DTransform< TScalarType >, itk::Rigid3DTransform< TScalarType >, itk::ScalableAffineTransform< TScalarType, NDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::Similarity2DTransform< TScalarType >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 123 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Array2D< double > itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::JacobianType

Type of the Jacobian matrix.

Definition at line 100 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef CovariantVector<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputCovariantVectorType

Definition at line 108 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Point<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputPointType

Definition at line 116 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Vector<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputVectorType

Definition at line 104 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef vnl_vector_fixed<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputVnlVectorType

Definition at line 112 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::ParametersType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ParametersType

Type of the input parameters.

Reimplemented from itk::TransformBase.

Definition at line 96 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::ParametersValueType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ParametersValueType

Type of the input parameters.

Reimplemented from itk::TransformBase.

Definition at line 97 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SmartPointer< Self > itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Pointer

Reimplemented from itk::TransformBase.

Definition at line 72 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef TScalarType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ScalarType

Type of the scalar representing coordinate and vector elements.

Definition at line 93 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Transform itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Self

Standard class typedefs.

Reimplemented from itk::TransformBase.

Definition at line 70 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef TransformBase itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Superclass

Reimplemented from itk::TransformBase.

Definition at line 71 of file itkTransform.h.

Constructor & Destructor Documentation

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Transform ( ) [protected]

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Transform	(	unsigned int	Dimension,
		unsigned int	NumberOfParameters
	)			`[protected]`

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::~Transform ( ) [inline, protected, virtual]

Definition at line 270 of file itkTransform.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const ParametersType& itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetFixedParameters ( void ) const [inline, virtual]

Get the Fixed Parameters.

Implements itk::TransformBase.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::IdentityTransform< TScalarType, NDimensions >, itk::KernelTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 182 of file itkTransform.h.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInputSpaceDimension ( void ) const [inline, virtual]

Get the size of the input space

Implements itk::TransformBase.

Definition at line 87 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

bool itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInverse ( Self * ) const [inline]

Returns a boolean indicating whether it is possible or not to compute the inverse of this current Transform. If it is possible, then the inverse of the transform is returned in the inverseTransform variable passed by the user. The inverse is recomputed if this current transform has been modified. This method is intended to be overriden by derived classes.

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::Rigid2DTransform< TScalarType >, itk::Rigid3DTransform< TScalarType >, itk::ScaleTransform< TScalarType, NDimensions >, itk::Similarity2DTransform< TScalarType >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 239 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual InverseTransformBasePointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInverseTransform ( ) const [inline, virtual]

Return an inverse of this transform. If the inverse has not been implemented, return NULL. The type of the inverse transform does not necessarily need to match the type of the forward transform. This allows one to return a numeric inverse transform instead.

Reimplemented in itk::AffineTransform< TScalarType, NDimensions >, itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::CenteredEuler3DTransform< TScalarType >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, itk::IdentityTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::Rigid2DTransform< TScalarType >, itk::Rigid3DTransform< TScalarType >, itk::ScalableAffineTransform< TScalarType, NDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::Similarity2DTransform< TScalarType >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 247 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const JacobianType& itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetJacobian ( const InputPointType & ) const [inline, virtual]

Compute the Jacobian of the transformation

This method computes the Jacobian matrix of the transformation at a given input point. The rank of the Jacobian will also indicate if the transform is invertible at this point.

The Jacobian is be expressed as a matrix 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_{1}}{\partial p_{2}} & \cdots & \frac{\partial x_{1}}{\partial p_{m}}\\ \frac{\partial x_{2}}{\partial p_{1}} & \frac{\partial x_{2}}{\partial p_{2}} & \cdots & \frac{\partial x_{2}}{\partial p_{m}}\\ \vdots & \vdots & \ddots & \vdots \\ \frac{\partial x_{n}}{\partial p_{1}} & \frac{\partial x_{n}}{\partial p_{2}} & \cdots & \frac{\partial x_{n}}{\partial p_{m}} \end{array}\right]$

Reimplemented in itk::KernelTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 218 of file itkTransform.h.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const char* itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::TransformBase.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetNumberOfParameters ( void ) const [inline, virtual]

Return the number of parameters that completely define the Transfom

Implements itk::TransformBase.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, and itk::TranslationTransform< TScalarType, NDimensions >.

Definition at line 229 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetOutputSpaceDimension ( void ) const [inline, virtual]

Get the size of the output space

Implements itk::TransformBase.

Definition at line 90 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const ParametersType& itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetParameters ( void ) const [inline, virtual]

Get the Transformation Parameters.

Implements itk::TransformBase.

Definition at line 168 of file itkTransform.h.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual std::string itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetTransformTypeAsString ( ) const [virtual]

Generate a platform independant name

Implements itk::TransformBase.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual bool itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::IsLinear ( ) const [inline, virtual]

Indicates if this transform is linear. A transform is defined to be linear if the transform of a linear combination of points is equal to the linear combination (with the same coefficients) of the individual transforms of each point. The transform T will be linear if given two points P and Q, and scalar coefficients a and b, then

T( a*P + b*Q ) = a * T(P) + b * T(Q)

By default, we assume this to NOT be the case for most transforms. However, transforms for which this is true will overload and reimplement this method accordingly.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::IdentityTransform< TScalarType, NDimensions >, itk::KernelTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 265 of file itkTransform.h.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

static Pointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::New ( ) [static]

New method for creating an object using a factory.

Reimplemented from itk::Object.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

virtual void itk::Object::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

Referenced by itk::Statistics::TransferFunctionBase< ScalarType >::PrintSelf(), itk::Statistics::RadialBasisFunctionBase< ScalarType >::PrintSelf(), itk::Statistics::NNetDistanceMetricBase< TMeasurementVector >::PrintSelf(), and itk::Statistics::InputFunctionBase< TMeasurementVector, ScalarType >::PrintSelf().

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetFixedParameters ( const ParametersType & ) [inline, virtual]

Set the fixed parameters and update internal transformation.

Reimplemented in itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 178 of file itkTransform.h.

virtual void itk::TransformBase::SetFixedParameters ( const ParametersType & ) [pure virtual, inherited]

Set the fixed parameters.

Implemented in itk::TranslationTransform< TScalarType, NDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, and itk::Transform< TScalarType, 3, 2 >.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetParameters ( const ParametersType & ) [inline, virtual]

Set the transformation parameters and update internal transformation. SetParameters gives the transform the option to set it's parameters by keeping a reference to the parameters, or by copying. To force the transform to copy it's parameters call SetParametersByValue.

See also:: SetParametersByValue

Reimplemented in itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 154 of file itkTransform.h.

virtual void itk::TransformBase::SetParameters ( const ParametersType & ) [pure virtual, inherited]

Set the transformation parameters and update internal transformation.

Implemented in itk::TranslationTransform< TScalarType, NDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, and itk::Transform< TScalarType, 3, 2 >.

virtual void itk::TransformBase::SetParametersByValue ( const ParametersType & p ) [pure virtual, inherited]

Set the transformation by copying parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See also:: SetParameters

Implemented in itk::Transform< TScalarType, NDimensions, NDimensions >, and itk::Transform< TScalarType, 3, 2 >.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetParametersByValue ( const ParametersType & p ) [inline, virtual]

Set the transformation parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See also:: SetParameters

Definition at line 164 of file itkTransform.h.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual OutputCovariantVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformCovariantVector ( const InputCovariantVectorType & ) const [inline, virtual]

Method to transform a CovariantVector.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::IdentityTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 143 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual OutputPointType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformPoint ( const InputPointType & ) const [inline, virtual]

Method to transform a point.

Reimplemented in itk::KernelTransform< TScalarType, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 131 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual OutputVnlVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformVector ( const InputVnlVectorType & ) const [inline, virtual]

Method to transform a vnl_vector.

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 139 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual OutputVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformVector ( const InputVectorType & ) const [inline, virtual]

Method to transform a vector.

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

Definition at line 135 of file itkTransform.h.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

const unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputSpaceDimension = NInputDimensions [static]

Dimension of the domain space.

Definition at line 82 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

ParametersType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_FixedParameters [mutable, protected]

Definition at line 274 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

JacobianType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_Jacobian [mutable, protected]

Definition at line 275 of file itkTransform.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

ParametersType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_Parameters [mutable, protected]

Definition at line 273 of file itkTransform.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

const unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputSpaceDimension = NOutputDimensions [static]

Dimension of the domain space.

Definition at line 83 of file itkTransform.h.

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

itkTransform.h

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > Class Template Reference [Transforms]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3> class itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > Class Template Reference
[Transforms]

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
class itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >