#include <itkAffineTransform.h>

Inheritance diagram for itk::AffineTransform< TParametersValueType, NDimensions >:

Collaboration diagram for itk::AffineTransform< TParametersValueType, NDimensions >:

Detailed Description

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
class itk::AffineTransform< TParametersValueType, NDimensions >

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

This class allows the definition and manipulation of affine transformations of an n-dimensional affine space (and its associated vector space) onto itself. One common use is to define and manipulate Euclidean coordinate transformations in two and three dimensions, but other uses are possible as well.

An affine transformation is defined mathematically as a linear transformation plus a constant offset. If A is a constant n x n matrix and b is a constant n-vector, then y = Ax+b defines an affine transformation from the n-vector x to the n-vector y.

The difference between two points is a vector and transforms linearly, using the matrix only. That is, (y1-y2) = A*(x1-x2).

The AffineTransform class determines whether to transform an object as a point or a vector by examining its type. An object of type Point transforms as a point; an object of type Vector transforms as a vector.

One common use of affine transformations is to define coordinate conversions in two- and three-dimensional space. In this application, x is a two- or three-dimensional vector containing the "source" coordinates of a point, y is a vector containing the "target" coordinates, the matrix A defines the scaling and rotation of the coordinate systems from the source to the target, and b defines the translation of the origin from the source to the target. More generally, A can also define anisotropic scaling and shearing transformations. Any good textbook on computer graphics will discuss coordinate transformations in more detail. Several of the methods in this class are designed for this purpose and use the language appropriate to coordinate conversions.

Any two affine transformations may be composed and the result is another affine transformation. However, the order is important. Given two affine transformations T1 and T2, we will say that "precomposing T1 with T2" yields the transformation which applies T1 to the source, and then applies T2 to that result to obtain the target. Conversely, we will say that "postcomposing T1 with T2" yields the transformation which applies T2 to the source, and then applies T1 to that result to obtain the target. (Whether T1 or T2 comes first lexicographically depends on whether you choose to write mappings from right-to-left or vice versa; we avoid the whole problem by referring to the order of application rather than the textual order.)

There are two template parameters for this class:

ScalarT The type to be used for scalar numeric values. Either float or double.

NDimensions The number of dimensions of the vector space.

This class provides several methods for setting the matrix and vector defining the transform. To support the registration framework, the transform parameters can also be set as an Array<double> of size (NDimension + 1) * NDimension using method SetParameters(). The first (NDimension x NDimension) parameters defines the matrix in row-major order (where the column index varies the fastest). The last NDimension parameters defines the translation in each dimensions.

This class also supports the specification of a center of rotation (center) and a translation that is applied with respect to that centered rotation. By default the center of rotation is set to the origin.

Examples:: Examples/Filtering/ResampleImageFilter.cxx, Examples/Filtering/ResampleImageFilter2.cxx, Examples/Filtering/ResampleImageFilter3.cxx, Examples/Filtering/ResampleImageFilter4.cxx, Examples/Filtering/ResampleImageFilter7.cxx, Examples/Filtering/ResampleImageFilter8.cxx, Examples/IO/TransformReadWrite.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/ImageRegistration19.cxx, Examples/RegistrationITKv3/ImageRegistration20.cxx, Examples/RegistrationITKv3/ImageRegistration9.cxx, Examples/RegistrationITKv3/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, SphinxExamples/src/Core/Transform/ApplyAffineTransformFromHomogeneousMatrixAndResample/Code.cxx, WikiExamples/Registration/ImageRegistrationMethodAffine.cxx, and WikiExamples/Registration/MutualInformationAffine.cxx.

Definition at line 103 of file itkAffineTransform.h.

Public Types
typedef Superclass::CenterType	CenterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::InverseMatrixType	InverseMatrixType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MatrixType	MatrixType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef AffineTransform	Self

typedef MatrixOffsetTransformBase < TParametersValueType, NDimensions, NDimensions >	Superclass

typedef Superclass::TranslationType	TranslationType

Public Types inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
typedef InputPointType	CenterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::FixedParametersValueType	FixedParametersValueType

typedef Superclass::InputDiffusionTensor3DType	InputDiffusionTensor3DType

typedef Superclass::InputSymmetricSecondRankTensorType	InputSymmetricSecondRankTensorType

typedef CovariantVector < TParametersValueType, InputDiffusionTensor3DType::Dimension >	InputTensorEigenVectorType

typedef Superclass::InputVectorPixelType	InputVectorPixelType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)>	InverseMatrixType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::JacobianType	JacobianType

typedef OutputVectorType	OffsetType

typedef OffsetType::ValueType	OffsetValueType

typedef Superclass::OutputDiffusionTensor3DType	OutputDiffusionTensor3DType

typedef Superclass::OutputSymmetricSecondRankTensorType	OutputSymmetricSecondRankTensorType

typedef Superclass::OutputVectorPixelType	OutputVectorPixelType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef MatrixOffsetTransformBase	Self

typedef Transform < TParametersValueType, NInputDimensions, NOutputDimensions >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

typedef OutputVectorType	TranslationType

typedef TranslationType::ValueType	TranslationValueType

typedef Vector < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputVectorType

typedef Vector < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputVectorType

typedef OutputVectorType::ValueType	OutputVectorValueType

typedef CovariantVector < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputCovariantVectorType

typedef CovariantVector < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputCovariantVectorType

typedef vnl_vector_fixed < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputVnlVectorType

typedef vnl_vector_fixed < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputVnlVectorType

typedef Point < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputPointType

typedef InputPointType::ValueType	InputPointValueType

typedef Point < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputPointType

typedef OutputPointType::ValueType	OutputPointValueType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	MatrixType

typedef MatrixType::ValueType	MatrixValueType

Public Types inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	DirectionChangeMatrix

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::FixedParametersValueType	FixedParametersValueType

typedef CovariantVector < TParametersValueType, NInputDimensions >	InputCovariantVectorType

typedef DiffusionTensor3D < TParametersValueType >	InputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	InputDirectionMatrix

typedef Point < TParametersValueType, NInputDimensions >	InputPointType

typedef SymmetricSecondRankTensor < TParametersValueType, NInputDimensions >	InputSymmetricSecondRankTensorType

typedef VariableLengthVector < TParametersValueType >	InputVectorPixelType

typedef Vector < TParametersValueType, NInputDimensions >	InputVectorType

typedef vnl_vector_fixed < TParametersValueType, NInputDimensions >	InputVnlVectorType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Transform < TParametersValueType, NOutputDimensions, NInputDimensions >	InverseTransformBaseType

typedef Array2D < ParametersValueType >	JacobianType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	MatrixType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef CovariantVector < TParametersValueType, NOutputDimensions >	OutputCovariantVectorType

typedef DiffusionTensor3D < TParametersValueType >	OutputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)>	OutputDirectionMatrix

typedef Point < TParametersValueType, NOutputDimensions >	OutputPointType

typedef SymmetricSecondRankTensor < TParametersValueType, NOutputDimensions >	OutputSymmetricSecondRankTensorType

typedef VariableLengthVector < TParametersValueType >	OutputVectorPixelType

typedef Vector < TParametersValueType, NOutputDimensions >	OutputVectorType

typedef vnl_vector_fixed < TParametersValueType, NOutputDimensions >	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ParametersValueType	ScalarType

typedef Transform	Self

typedef TransformBaseTemplate < TParametersValueType >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < FixedParametersValueType >	FixedParametersType

typedef ParametersValueType	FixedParametersValueType

typedef IdentifierType	NumberOfParametersType

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef TParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef TransformBaseTemplate	Self

typedef Object	Superclass

enum	TransformCategoryType { UnknownTransformCategory =0, Linear =1, BSpline =2, Spline =3, DisplacementField =4, VelocityField =5 }

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

bool	GetInverse (Self *inverse) const

virtual InverseTransformBasePointer	GetInverseTransform () const override

virtual const char *	GetNameOfClass () const

	itkLegacyMacro (InputPointType BackTransformPoint(const OutputPointType &point) const)

ScalarType	Metric (const Self *other) const

ScalarType	Metric () const

void	Rotate2D (TParametersValueType angle, bool pre=0)

void	Rotate3D (const OutputVectorType &axis, TParametersValueType angle, bool pre=0)

void	Scale (const OutputVectorType &factor, bool pre=0)

void	Scale (const TParametersValueType &factor, bool pre=0)

void	Shear (int axis1, int axis2, TParametersValueType coef, bool pre=0)

void	Translate (const OutputVectorType &offset, bool pre=0)


void	Rotate (int axis1, int axis2, TParametersValueType angle, bool pre=0)


	itkLegacyMacro (InputPointType BackTransform(const OutputPointType &point) const)

	itkLegacyMacro (InputVectorType BackTransform(const OutputVectorType &vector) const)

	itkLegacyMacro (InputVnlVectorType BackTransform(const OutputVnlVectorType &vector) const)

	itkLegacyMacro (InputCovariantVectorType BackTransform(const OutputCovariantVectorType &vector) const)

Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
void	Compose (const Self *other, bool pre=0)

virtual void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const override

virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &x, JacobianType &j) const override

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

const InputPointType &	GetCenter () const

virtual const FixedParametersType &	GetFixedParameters () const override

virtual const MatrixType &	GetMatrix () const

const OutputVectorType &	GetOffset () const

const ParametersType &	GetParameters () const override

virtual TransformCategoryType	GetTransformCategory () const override

const OutputVectorType &	GetTranslation () const

virtual bool	IsLinear () const override

virtual void	SetFixedParameters (const FixedParametersType &) override

virtual void	SetIdentity ()

void	SetParameters (const ParametersType &parameters) override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector) const override

OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override

OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override

OutputPointType	TransformPoint (const InputPointType &point) const override

OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const override

OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const override

OutputVectorType	TransformVector (const InputVectorType &vector) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector) const override

virtual void	SetMatrix (const MatrixType &matrix)

void	SetOffset (const OutputVectorType &offset)

void	SetCenter (const InputPointType &center)

void	SetTranslation (const OutputVectorType &translation)

bool	GetInverse (Self *inverse) const

Public Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

virtual void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end) override

virtual void	CopyInParameters (const ParametersValueType const begin, const ParametersValueType const end) override

unsigned int	GetInputSpaceDimension (void) const override

bool	GetInverse (Self *) const

virtual NumberOfParametersType	GetNumberOfFixedParameters () const

virtual NumberOfParametersType	GetNumberOfLocalParameters (void) const

virtual NumberOfParametersType	GetNumberOfParameters (void) const override

unsigned int	GetOutputSpaceDimension (void) const override

virtual std::string	GetTransformTypeAsString () const override

	itkCloneMacro (Self)

virtual void	SetParametersByValue (const ParametersType &p) override

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const

virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual void	UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)

Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end)=0

virtual void	SetFixedParameters (const FixedParametersType &)=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes

static const unsigned int	InputSpaceDimension = NDimensions

static const unsigned int	OutputSpaceDimension = NDimensions

static const unsigned int	SpaceDimension = NDimensions

static const unsigned int	ParametersDimension = NDimensions *( NDimensions + 1 )

Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
static const unsigned int	InputSpaceDimension

static const unsigned int	OutputSpaceDimension

static const unsigned int	ParametersDimension

Static Public Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
static const unsigned int	InputSpaceDimension = NInputDimensions

static const unsigned int	OutputSpaceDimension = NOutputDimensions

Protected Member Functions
void	PrintSelf (std::ostream &s, Indent indent) const override

virtual	~AffineTransform ()


	AffineTransform (const MatrixType &matrix, const OutputVectorType &offset)

	AffineTransform (unsigned int paramDims)

	AffineTransform ()

Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
virtual void	ComputeMatrix ()

virtual void	ComputeMatrixParameters ()

virtual void	ComputeOffset ()

virtual void	ComputeTranslation ()

const InverseMatrixType &	GetInverseMatrix () const

const InverseMatrixType &	GetVarInverseMatrix () const

bool	InverseMatrixIsOld () const

void	SetVarCenter (const InputPointType &center)

void	SetVarInverseMatrix (const InverseMatrixType &matrix) const

void	SetVarMatrix (const MatrixType &matrix)

void	SetVarOffset (const OutputVectorType &offset)

void	SetVarTranslation (const OutputVectorType &translation)

virtual	~MatrixOffsetTransformBase ()

	MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)

	MatrixOffsetTransformBase (unsigned int paramDims)

	MatrixOffsetTransformBase ()

Protected Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
virtual LightObject::Pointer	InternalClone () const override

OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const

	Transform ()

	Transform (NumberOfParametersType NumberOfParameters)

virtual	~Transform ()

Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
	TransformBaseTemplate ()

virtual	~TransformBaseTemplate ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	AffineTransform (const Self &other)

const Self &	operator= (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
DirectionChangeMatrix	m_DirectionChange

FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount