ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkAffineTransform.h>
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.
Definition at line 104 of file itkAffineTransform.h.
Public Types | |
typedef Superclass::CenterType | CenterType |
typedef SmartPointer< const Self > | ConstPointer |
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 < TScalarType, NDimensions, NDimensions > | Superclass |
typedef Superclass::TranslationType | TranslationType |
Public Types inherited from itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions > | |
typedef InputPointType | CenterType |
typedef SmartPointer< const Self > | ConstPointer |
typedef Superclass::InputDiffusionTensor3DType | InputDiffusionTensor3DType |
typedef Superclass::InputSymmetricSecondRankTensorType | InputSymmetricSecondRankTensorType |
typedef CovariantVector < TScalarType, InputDiffusionTensor3DType::Dimension > | InputTensorEigenVectorType |
typedef Superclass::InputVectorPixelType | InputVectorPixelType |
typedef Matrix< TScalarType, 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< TScalarType, NInputDimensions, NOutputDimensions > | Superclass |
typedef Superclass::TransformCategoryType | TransformCategoryType |
typedef OutputVectorType | TranslationType |
typedef TranslationType::ValueType | TranslationValueType |
typedef Vector< TScalarType, itkGetStaticConstMacro(InputSpaceDimension)> | InputVectorType |
typedef Vector< TScalarType, itkGetStaticConstMacro(OutputSpaceDimension)> | OutputVectorType |
typedef OutputVectorType::ValueType | OutputVectorValueType |
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 InputPointType::ValueType | InputPointValueType |
typedef Point< TScalarType, itkGetStaticConstMacro(OutputSpaceDimension)> | OutputPointType |
typedef OutputPointType::ValueType | OutputPointValueType |
typedef Matrix< TScalarType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)> | MatrixType |
typedef MatrixType::ValueType | MatrixValueType |
Public Types inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > | |
typedef SmartPointer< const Self > | ConstPointer |
typedef Array < ParametersValueType > | DerivativeType |
typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)> | DirectionChangeMatrix |
typedef CovariantVector < TScalarType, NInputDimensions > | InputCovariantVectorType |
typedef DiffusionTensor3D < TScalarType > | InputDiffusionTensor3DType |
typedef Matrix< double, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)> | InputDirectionMatrix |
typedef Point< TScalarType, NInputDimensions > | InputPointType |
typedef SymmetricSecondRankTensor < TScalarType, NInputDimensions > | InputSymmetricSecondRankTensorType |
typedef VariableLengthVector < TScalarType > | InputVectorPixelType |
typedef Vector< TScalarType, NInputDimensions > | InputVectorType |
typedef vnl_vector_fixed < TScalarType, NInputDimensions > | InputVnlVectorType |
typedef InverseTransformBaseType::Pointer | InverseTransformBasePointer |
typedef Transform< TScalarType, NOutputDimensions, NInputDimensions > | InverseTransformBaseType |
typedef Array2D < ParametersValueType > | JacobianType |
typedef Matrix< TScalarType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)> | MatrixType |
typedef Superclass::NumberOfParametersType | NumberOfParametersType |
typedef CovariantVector < TScalarType, NOutputDimensions > | OutputCovariantVectorType |
typedef DiffusionTensor3D < TScalarType > | OutputDiffusionTensor3DType |
typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)> | OutputDirectionMatrix |
typedef Point< TScalarType, NOutputDimensions > | OutputPointType |
typedef SymmetricSecondRankTensor < TScalarType, NOutputDimensions > | OutputSymmetricSecondRankTensorType |
typedef VariableLengthVector < TScalarType > | OutputVectorPixelType |
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 Types inherited from itk::TransformBase | |
typedef SmartPointer< const Self > | ConstPointer |
typedef IdentifierType | NumberOfParametersType |
typedef OptimizerParameters < ParametersValueType > | ParametersType |
typedef double | ParametersValueType |
typedef SmartPointer< Self > | Pointer |
typedef TransformBase | 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 |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions > | |
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< TScalarType, NDimensions, NDimensions > | |
static const unsigned int | InputSpaceDimension |
static const unsigned int | OutputSpaceDimension |
static const unsigned int | ParametersDimension |
Static Public Attributes inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > | |
static const unsigned int | InputSpaceDimension = NInputDimensions |
static const unsigned int | OutputSpaceDimension = NOutputDimensions |
Private Member Functions | |
AffineTransform (const Self &other) | |
const Self & | operator= (const Self &) |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > | |
DirectionChangeMatrix | m_DirectionChange |
ParametersType | m_FixedParameters |
ParametersType | m_Parameters |
typedef Superclass::CenterType itk::AffineTransform< TScalarType, NDimensions >::CenterType |
Definition at line 145 of file itkAffineTransform.h.
typedef SmartPointer< const Self > itk::AffineTransform< TScalarType, NDimensions >::ConstPointer |
Definition at line 115 of file itkAffineTransform.h.
typedef Superclass::InputCovariantVectorType itk::AffineTransform< TScalarType, NDimensions >::InputCovariantVectorType |
Definition at line 141 of file itkAffineTransform.h.
typedef Superclass::InputPointType itk::AffineTransform< TScalarType, NDimensions >::InputPointType |
Definition at line 135 of file itkAffineTransform.h.
typedef Superclass::InputVectorType itk::AffineTransform< TScalarType, NDimensions >::InputVectorType |
Definition at line 137 of file itkAffineTransform.h.
typedef Superclass::InputVnlVectorType itk::AffineTransform< TScalarType, NDimensions >::InputVnlVectorType |
Definition at line 139 of file itkAffineTransform.h.
typedef Superclass::InverseMatrixType itk::AffineTransform< TScalarType, NDimensions >::InverseMatrixType |
Definition at line 144 of file itkAffineTransform.h.
typedef InverseTransformBaseType::Pointer itk::AffineTransform< TScalarType, NDimensions >::InverseTransformBasePointer |
Definition at line 152 of file itkAffineTransform.h.
typedef Superclass::InverseTransformBaseType itk::AffineTransform< TScalarType, NDimensions >::InverseTransformBaseType |
Base inverse transform type. This type should not be changed to the concrete inverse transform type or inheritance would be lost.
Definition at line 151 of file itkAffineTransform.h.
typedef Superclass::JacobianType itk::AffineTransform< TScalarType, NDimensions >::JacobianType |
Definition at line 133 of file itkAffineTransform.h.
typedef Superclass::MatrixType itk::AffineTransform< TScalarType, NDimensions >::MatrixType |
Definition at line 143 of file itkAffineTransform.h.
typedef Superclass::OffsetType itk::AffineTransform< TScalarType, NDimensions >::OffsetType |
Definition at line 146 of file itkAffineTransform.h.
typedef Superclass::OutputCovariantVectorType itk::AffineTransform< TScalarType, NDimensions >::OutputCovariantVectorType |
Definition at line 142 of file itkAffineTransform.h.
typedef Superclass::OutputPointType itk::AffineTransform< TScalarType, NDimensions >::OutputPointType |
Definition at line 136 of file itkAffineTransform.h.
typedef Superclass::OutputVectorType itk::AffineTransform< TScalarType, NDimensions >::OutputVectorType |
Definition at line 138 of file itkAffineTransform.h.
typedef Superclass::OutputVnlVectorType itk::AffineTransform< TScalarType, NDimensions >::OutputVnlVectorType |
Definition at line 140 of file itkAffineTransform.h.
typedef Superclass::ParametersType itk::AffineTransform< TScalarType, NDimensions >::ParametersType |
Parameters Type
Definition at line 132 of file itkAffineTransform.h.
typedef SmartPointer< Self > itk::AffineTransform< TScalarType, NDimensions >::Pointer |
Definition at line 114 of file itkAffineTransform.h.
typedef Superclass::ScalarType itk::AffineTransform< TScalarType, NDimensions >::ScalarType |
Definition at line 134 of file itkAffineTransform.h.
typedef AffineTransform itk::AffineTransform< TScalarType, NDimensions >::Self |
Standard typedefs
Definition at line 109 of file itkAffineTransform.h.
typedef MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions > itk::AffineTransform< TScalarType, NDimensions >::Superclass |
Definition at line 112 of file itkAffineTransform.h.
typedef Superclass::TranslationType itk::AffineTransform< TScalarType, NDimensions >::TranslationType |
Definition at line 147 of file itkAffineTransform.h.
|
protected |
Construct an AffineTransform object
This method constructs a new AffineTransform object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the AffineTransform is initialized to an identity transformation in the appropriate number of dimensions.
|
protected |
Construct an AffineTransform object
This method constructs a new AffineTransform object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the AffineTransform is initialized to an identity transformation in the appropriate number of dimensions.
|
protected |
Construct an AffineTransform object
This method constructs a new AffineTransform object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the AffineTransform is initialized to an identity transformation in the appropriate number of dimensions.
|
protectedvirtual |
Destroy an AffineTransform object
|
private |
|
virtual |
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::Object.
Reimplemented in itk::AzimuthElevationToCartesianTransform< TScalarType, NDimensions >, itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::FixedCenterOfRotationAffineTransform< TScalarType, NDimensions >, and itk::ScalableAffineTransform< TScalarType, NDimensions >.
bool itk::AffineTransform< TScalarType, NDimensions >::GetInverse | ( | Self * | inverse | ) | const |
Get an inverse of this transform.
|
virtual |
Return an inverse of this transform.
Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >.
Reimplemented in itk::ScalableAffineTransform< TScalarType, NDimensions >, and itk::CenteredAffineTransform< TScalarType, NDimensions >.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >.
Reimplemented in itk::AzimuthElevationToCartesianTransform< TScalarType, NDimensions >, itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::FixedCenterOfRotationAffineTransform< TScalarType, NDimensions >, and itk::ScalableAffineTransform< TScalarType, NDimensions >.
itk::AffineTransform< TScalarType, NDimensions >::itkLegacyMacro | ( | InputPointType BackTransform(const OutputPointType &point) | const | ) |
Back transform by an affine transformation
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. \xrefitem deprecated 34.
itk::AffineTransform< TScalarType, NDimensions >::itkLegacyMacro | ( | InputVectorType BackTransform(const OutputVectorType &vector) | const | ) |
Back transform by an affine transformation
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. \xrefitem deprecated 34.
itk::AffineTransform< TScalarType, NDimensions >::itkLegacyMacro | ( | InputVnlVectorType BackTransform(const OutputVnlVectorType &vector) | const | ) |
Back transform by an affine transformation
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. \xrefitem deprecated 34.
itk::AffineTransform< TScalarType, NDimensions >::itkLegacyMacro | ( | InputCovariantVectorType BackTransform(const OutputCovariantVectorType &vector) | const | ) |
Back transform by an affine transformation
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. \xrefitem deprecated 34.
itk::AffineTransform< TScalarType, NDimensions >::itkLegacyMacro | ( | InputPointType BackTransformPoint(const OutputPointType &point) | const | ) |
Back transform a point by an affine transform
This method finds the point that maps to a given point under the affine transformation defined by self. If no such point exists, an exception is thrown. The returned value is (a pointer to) a brand new point created with new.
ScalarType itk::AffineTransform< TScalarType, NDimensions >::Metric | ( | const Self * | other | ) | const |
Compute distance between two affine transformations
This method computes a ``distance'' between two affine transformations. This distance is guaranteed to be a metric, but not any particular metric. (At the moment, the algorithm is to collect all the elements of the matrix and offset into a vector, and compute the euclidean (L2) norm of that vector. Some metric which could be used to estimate the distance between two points transformed by the affine transformation would be more useful, but I don't have time right now to work out the mathematical details.)
ScalarType itk::AffineTransform< TScalarType, NDimensions >::Metric | ( | void | ) | const |
This method computes the distance from self to the identity transformation, using the same metric as the one-argument form of the Metric() method.
|
static |
New macro for creation of through a Smart Pointer
|
private |
|
protectedvirtual |
Print contents of an AffineTransform
Reimplemented from itk::Object.
Reimplemented in itk::AzimuthElevationToCartesianTransform< TScalarType, NDimensions >, and itk::ScalableAffineTransform< TScalarType, NDimensions >.
void itk::AffineTransform< TScalarType, NDimensions >::Rotate | ( | int | axis1, |
int | axis2, | ||
TScalarType | angle, | ||
bool | pre = 0 |
||
) |
Compose affine transformation with an elementary rotation
This method composes self with a rotation that affects two specified axes, replacing the current value of self. The rotation angle is in radians. The axis of rotation goes through the origin. The transformation is given by y[axis1] = vcl_cos(angle)*x[axis1] + vcl_sin(angle)*x[axis2] y[axis2] = -sin(angle)*x[axis1] + vcl_cos(angle)*x[axis2]. All coordinates other than axis1 and axis2 are unchanged; a rotation of pi/2 radians will carry +axis1 into +axis2. The rotation is precomposed with self if pre is true, and postcomposed otherwise. Note that the rotation is applied centered at the origin.
void itk::AffineTransform< TScalarType, NDimensions >::Rotate2D | ( | TScalarType | angle, |
bool | pre = 0 |
||
) |
Compose 2D affine transformation with a rotation
This method composes self, which must be a 2D affine transformation, with a clockwise rotation through a given angle in radians. The center of rotation is the origin. The rotation is precomposed with self if pre is true, and postcomposed otherwise. Note that the rotation is applied centered at the origin.
void itk::AffineTransform< TScalarType, NDimensions >::Rotate3D | ( | const OutputVectorType & | axis, |
TScalarType | angle, | ||
bool | pre = 0 |
||
) |
Compose 3D affine transformation with a rotation
This method composes self, which must be a 3D affine transformation, with a clockwise rotation around a specified axis. The rotation angle is in radians; the axis of rotation goes through the origin. The rotation is precomposed with self if pre is true, and postcomposed otherwise. Note that the rotation is applied centered at the origin.
void itk::AffineTransform< TScalarType, NDimensions >::Scale | ( | const OutputVectorType & | factor, |
bool | pre = 0 |
||
) |
Compose affine transformation with a scaling
This method modifies self to magnify the source by a given factor along each axis. If all factors are the same, or only a single factor is given, then the scaling is isotropic; otherwise it is anisotropic. If an odd number of factors are negative, then the parity of the image changes. If any of the factors is zero, then the transformation becomes a projection and is not invertible. The scaling is precomposed with self if pre is true, and postcomposed otherwise. Note that the scaling is applied centered at the origin.
void itk::AffineTransform< TScalarType, NDimensions >::Scale | ( | const TScalarType & | factor, |
bool | pre = 0 |
||
) |
void itk::AffineTransform< TScalarType, NDimensions >::Shear | ( | int | axis1, |
int | axis2, | ||
TScalarType | coef, | ||
bool | pre = 0 |
||
) |
Compose affine transformation with a shear
This method composes self with a shear transformation, replacing the original contents of self. The shear is precomposed with self if pre is true, and postcomposed otherwise. The transformation is given by
y[axis1] = x[axis1] + coef*x[axis2] y[axis2] = x[axis2].
Note that the shear is applied centered at the origin.
void itk::AffineTransform< 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. This updates Translation based on current center.
|
static |
Dimension of the domain space.
Definition at line 124 of file itkAffineTransform.h.
|
static |
Dimension of the domain space.
Definition at line 125 of file itkAffineTransform.h.
|
static |
Dimension of the domain space.
Definition at line 128 of file itkAffineTransform.h.
|
static |
Dimension of the domain space.
Definition at line 126 of file itkAffineTransform.h.