#include <itkMatrixOffsetTransformBase.h>
Inheritance diagram for itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >:
Public Types | |
typedef MatrixOffsetTransformBase | Self |
typedef Transform< TScalarType, NInputDimensions, NOutputDimensions > | Superclass |
typedef SmartPointer< Self > | Pointer |
typedef SmartPointer< const Self > | ConstPointer |
typedef Superclass::ParametersType | ParametersType |
typedef Superclass::JacobianType | JacobianType |
typedef Superclass::ScalarType | ScalarType |
typedef Matrix< TScalarType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension) | MatrixType ) |
typedef Matrix< TScalarType, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension) | InverseMatrixType ) |
typedef InputPointType | CenterType |
typedef OutputVectorType | OffsetType |
typedef OutputVectorType | TranslationType |
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 void | SetIdentity (void) |
const MatrixType & | GetMatrix () const |
const OutputVectorType & | GetOffset (void) const |
const InputPointType & | GetCenter () const |
const OutputVectorType & | GetTranslation (void) const |
void | SetParameters (const ParametersType ¶meters) |
const ParametersType & | GetParameters (void) const |
virtual void | SetFixedParameters (const ParametersType &) |
virtual const ParametersType & | GetFixedParameters (void) const |
void | Compose (const Self *other, bool pre=0) |
const JacobianType & | GetJacobian (const InputPointType &point) const |
const InverseMatrixType & | GetInverseMatrix (void) const |
itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions) | |
itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions) | |
itkStaticConstMacro (ParametersDimension, unsigned int, NOutputDimensions *(NInputDimensions+1)) | |
virtual void | SetMatrix (const MatrixType &matrix) |
void | SetOffset (const OutputVectorType &offset) |
void | SetCenter (const InputPointType ¢er) |
void | SetTranslation (const OutputVectorType &translation) |
OutputPointType | TransformPoint (const InputPointType &point) const |
OutputVectorType | TransformVector (const InputVectorType &vector) const |
OutputVnlVectorType | TransformVector (const InputVnlVectorType &vector) const |
OutputCovariantVectorType | TransformCovariantVector (const InputCovariantVectorType &vector) const |
bool | GetInverse (Self *inverse) const |
Static Public Member Functions | |
Pointer | New () |
Protected Member Functions | |
virtual | ~MatrixOffsetTransformBase () |
void | PrintSelf (std::ostream &s, Indent indent) const |
InverseMatrixType | GetVarInverseMatrix (void) const |
void | SetVarInverseMatrix (const InverseMatrixType &matrix) const |
bool | InverseMatrixIsOld (void) const |
virtual void | ComputeMatrixParameters (void) |
virtual void | ComputeMatrix (void) |
void | SetVarMatrix (const MatrixType &matrix) |
virtual void | ComputeTranslation (void) |
void | SetVarTranslation (const OutputVectorType &translation) |
virtual void | ComputeOffset (void) |
void | SetVarOffset (const OutputVectorType &offset) |
void | SetVarCenter (const InputPointType ¢er) |
MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset) | |
MatrixOffsetTransformBase (unsigned int outputDims, unsigned int paramDims) | |
MatrixOffsetTransformBase () |
This class serves as a base class for transforms that can be expressed as a linear transformation plus a constant offset (e.g., affine, similarity and rigid transforms). This base class also provides the concept of using a center of rotation and a translation instead of an offset.
As derived instances of this class are specializations of an affine transform, any two of these transformations may be composed and the result is an 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 three template parameters for this class:
ScalarT The type to be used for scalar numeric values. Either float or double.
NInputDimensions The number of dimensions of the input vector space.
NOutputDimensions The number of dimensions of the output vector space.
This class provides several methods for setting the matrix and offset defining the transform. To support the registration framework, the transform parameters can also be set as an Array<double> of size (NInputDimension + 1) * NOutputDimension using method SetParameters(). The first (NOutputDimension x NInputDimension) parameters defines the matrix in column-major order (where the column index varies the fastest). The last NOutputDimension parameters defines the translation in each dimensions.
Definition at line 80 of file itkMatrixOffsetTransformBase.h.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Construct an MatrixOffsetTransformBase object This method constructs a new MatrixOffsetTransformBase object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the MatrixOffsetTransformBase is initialized to an identity transformation in the appropriate number of dimensions. * |
|
Construct an MatrixOffsetTransformBase object This method constructs a new MatrixOffsetTransformBase object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the MatrixOffsetTransformBase is initialized to an identity transformation in the appropriate number of dimensions. * |
|
Construct an MatrixOffsetTransformBase object This method constructs a new MatrixOffsetTransformBase object and initializes the matrix and offset parts of the transformation to values specified by the caller. If the arguments are omitted, then the MatrixOffsetTransformBase is initialized to an identity transformation in the appropriate number of dimensions. * |
|
Destroy an MatrixOffsetTransformBase object * |
|
Compose with another MatrixOffsetTransformBase This method composes self with another MatrixOffsetTransformBase of the same dimension, modifying self to be the composition of self and other. If the argument pre is true, then other is precomposed with self; that is, the resulting transformation consists of first applying other to the source, followed by self. If pre is false or omitted, then other is post-composed with self; that is the resulting transformation consists of first applying self to the source, followed by other. This updates the Translation based on current center. |
|
|
|
|
|
|
|
Get center of rotation of the MatrixOffsetTransformBase This method returns the point used as the fixed center of rotation for the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 250 of file itkMatrixOffsetTransformBase.h. |
|
Get the Fixed Parameters. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, and itk::CenteredSimilarity2DTransform< TScalarType >. |
|
Create inverse of an affine transformation This populates the parameters an affine transform such that the transform is the inverse of self. If self is not invertible, an exception is thrown. Note that by default the inverese transform is centered at the origin. If you need to compute the inverse centered at a point, p,
transform2->SetCenter( p ); transform1->GetInverse( transform2 ); transform2 will now contain the inverse of transform1 and will with its center set to p. Flipping the two statements will produce an incorrect transform. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. |
|
Reimplemented in itk::QuaternionRigidTransform< TScalarType >. |
|
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. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::CenteredEuler3DTransform< TScalarType >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler3DTransform< TScalarType >, itk::QuaternionRigidTransform< TScalarType >, itk::Rigid2DTransform< TScalarType >, itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity2DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, itk::VersorRigid3DTransform< TScalarType >, and itk::VersorTransform< TScalarType >. |
|
Get matrix of an MatrixOffsetTransformBase This method returns the value of the matrix of the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 193 of file itkMatrixOffsetTransformBase.h. |
|
|
Get offset of an MatrixOffsetTransformBase This method returns the offset value of the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 214 of file itkMatrixOffsetTransformBase.h. |
|
|
Get translation component of the MatrixOffsetTransformBase This method returns the translation used after rotation about the center point. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 270 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 370 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 374 of file itkMatrixOffsetTransformBase.h. |
|
Dimension of the domain space. |
|
Dimension of the domain space. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. |
|
Dimension of the domain space. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. |
|
|
|
Set center of rotation of an MatrixOffsetTransformBase This method sets the center of rotation of an MatrixOffsetTransformBase to a fixed point - for most transforms derived from this class, this point is not a "parameter" of the transform - the exception is that "centered" transforms have center as a parameter during optimization. This method updates offset wrt to current translation and matrix. That is, changing the center changes the transform! WARNING: When using the Center, we strongly recommend only changing the matrix and translation to define a transform. Changing a transform's center, changes the mapping between spaces - specifically, translation is not changed with respect to that new center, and so the offset is updated to * maintain the consistency with translation. If a center is not used, or is set before the matrix and the offset, then it is safe to change the offset directly. As a rule of thumb, if you wish to set the center explicitly, set before Offset computations are done. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 239 of file itkMatrixOffsetTransformBase.h. |
|
Set the fixed parameters and update internal transformation. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, and itk::CenteredSimilarity2DTransform< TScalarType >. |
|
Set the transformation to an Identity This sets the matrix to identity and the Offset to null. Reimplemented in itk::Euler3DTransform< TScalarType >, itk::QuaternionRigidTransform< TScalarType >, itk::Rigid2DTransform< TScalarType >, itk::ScalableAffineTransform< TScalarType, NDimensions >, itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity2DTransform< TScalarType >, and itk::VersorTransform< TScalarType >. |
|
Set matrix of an MatrixOffsetTransformBase This method sets the matrix of an MatrixOffsetTransformBase to a value specified by the user. This updates the Offset wrt to current translation and center. See the warning regarding offset-versus-translation in the documentation for SetCenter. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Reimplemented in itk::Rigid2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 181 of file itkMatrixOffsetTransformBase.h. |
|
Set offset (origin) of an MatrixOffset TransformBase. This method sets the offset of an MatrixOffsetTransformBase to a value specified by the user. This updates Translation wrt current center. See the warning regarding offset-versus-translation in the documentation for SetCenter. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 204 of file itkMatrixOffsetTransformBase.h. |
|
Set the transformation from a container of parameters. The first (NOutputDimension x NInputDimension) parameters define the matrix and the last NOutputDimension parameters the translation. Offset is updated based on current center. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::CenteredAffineTransform< TScalarType, NDimensions >, itk::CenteredEuler3DTransform< TScalarType >, itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler3DTransform< TScalarType >, itk::QuaternionRigidTransform< TScalarType >, itk::Rigid2DTransform< TScalarType >, itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity2DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, itk::VersorRigid3DTransform< TScalarType >, and itk::VersorTransform< TScalarType >. |
|
Set translation of an MatrixOffsetTransformBase This method sets the translation of an MatrixOffsetTransformBase. This updates Offset to reflect current translation. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset Definition at line 259 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 392 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 372 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 381 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 389 of file itkMatrixOffsetTransformBase.h. |
|
Definition at line 385 of file itkMatrixOffsetTransformBase.h. |
|
Transform by an affine transformation This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. The TransformPoint method transforms its argument as an affine point, whereas the TransformVector method transforms its argument as a vector. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::Rigid3DTransform< TScalarType >. |
|
Transform by an affine transformation This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. The TransformPoint method transforms its argument as an affine point, whereas the TransformVector method transforms its argument as a vector. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. Reimplemented in itk::AzimuthElevationToCartesianTransform< TScalarType, NDimensions >. |
|
Transform by an affine transformation This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. The TransformPoint method transforms its argument as an affine point, whereas the TransformVector method transforms its argument as a vector. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. |
|
Transform by an affine transformation This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector. The TransformPoint method transforms its argument as an affine point, whereas the TransformVector method transforms its argument as a vector. Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >. |