ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::Similarity3DTransform< TScalarType > Class Template Reference

Similarity3DTransform of a vector space (e.g. space coordinates) More...

#include <itkSimilarity3DTransform.h>

Inheritance diagram for itk::Similarity3DTransform< TScalarType >:
Collaboration diagram for itk::Similarity3DTransform< TScalarType >:

List of all members.

Public Types

typedef Superclass::AngleType AngleType
typedef Superclass::AxisType AxisType
typedef Superclass::CenterType CenterType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::InputCovariantVectorType 
InputCovariantVectorType
typedef Superclass::InputPointType InputPointType
typedef Superclass::InputVectorType InputVectorType
typedef
Superclass::InputVnlVectorType 
InputVnlVectorType
typedef
Superclass::InverseMatrixType 
InverseMatrixType
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< SelfPointer
typedef Superclass::ScalarType ScalarType
typedef TScalarType ScaleType
typedef Similarity3DTransform Self
typedef VersorRigid3DTransform
< TScalarType > 
Superclass
typedef Superclass::TranslationType TranslationType
typedef Superclass::VersorType VersorType

Public Member Functions

virtual void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual const ParametersTypeGetParameters (void) const
virtual const ScaleTypeGetScale ()
virtual void SetIdentity (void)
virtual void SetMatrix (const MatrixType &matrix)
void SetParameters (const ParametersType &parameters)
void SetScale (ScaleType scale)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int SpaceDimension = 3
static const unsigned int InputSpaceDimension = 3
static const unsigned int OutputSpaceDimension = 3
static const unsigned int ParametersDimension = 7

Protected Member Functions

void ComputeMatrix ()
void ComputeMatrixParameters ()
void PrintSelf (std::ostream &os, Indent indent) const
 Similarity3DTransform (unsigned int paramDim)
 Similarity3DTransform (const MatrixType &matrix, const OutputVectorType &offset)
 Similarity3DTransform ()
 ~Similarity3DTransform ()

Private Member Functions

void operator= (const Self &)
 Similarity3DTransform (const Self &)

Private Attributes

ScaleType m_Scale

Detailed Description

template<class TScalarType = double>
class itk::Similarity3DTransform< TScalarType >

Similarity3DTransform of a vector space (e.g. space coordinates)

This transform applies a rotation, translation and isotropic scaling to the space.

The parameters for this transform can be set either using individual Set methods or in serialized form using SetParameters() and SetFixedParameters().

The serialization of the optimizable parameters is an array of 7 elements. The first 3 elements are the components of the versor representation of 3D rotation. The next 3 parameters defines the translation in each dimension. The last parameter defines the isotropic scaling.

The serialization of the fixed parameters is an array of 3 elements defining the center of rotation.

See also:
VersorRigid3DTransform

Definition at line 48 of file itkSimilarity3DTransform.h.


Member Typedef Documentation

template<class TScalarType = double>
typedef Superclass::AngleType itk::Similarity3DTransform< TScalarType >::AngleType

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 92 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::AxisType itk::Similarity3DTransform< TScalarType >::AxisType

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 91 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::CenterType itk::Similarity3DTransform< TScalarType >::CenterType

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 85 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef SmartPointer<const Self> itk::Similarity3DTransform< TScalarType >::ConstPointer

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 56 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::InputCovariantVectorType itk::Similarity3DTransform< TScalarType >::InputCovariantVectorType

Standard covariant vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 81 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::InputPointType itk::Similarity3DTransform< TScalarType >::InputPointType

Standard coordinate point type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 75 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::InputVectorType itk::Similarity3DTransform< TScalarType >::InputVectorType

Standard vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 77 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::InputVnlVectorType itk::Similarity3DTransform< TScalarType >::InputVnlVectorType

Standard vnl_vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 79 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::InverseMatrixType itk::Similarity3DTransform< TScalarType >::InverseMatrixType

Standard inverse matrix type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 84 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::JacobianType itk::Similarity3DTransform< TScalarType >::JacobianType

Jacobian Type

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 73 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::MatrixType itk::Similarity3DTransform< TScalarType >::MatrixType

Standard matrix type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 83 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::OffsetType itk::Similarity3DTransform< TScalarType >::OffsetType

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 86 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::OutputCovariantVectorType itk::Similarity3DTransform< TScalarType >::OutputCovariantVectorType

Standard covariant vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 82 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::OutputPointType itk::Similarity3DTransform< TScalarType >::OutputPointType

Standard coordinate point type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 76 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::OutputVectorType itk::Similarity3DTransform< TScalarType >::OutputVectorType

Standard vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 78 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::OutputVnlVectorType itk::Similarity3DTransform< TScalarType >::OutputVnlVectorType

Standard vnl_vector type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 80 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::ParametersType itk::Similarity3DTransform< TScalarType >::ParametersType

Parameters Type

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 72 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef SmartPointer<Self> itk::Similarity3DTransform< TScalarType >::Pointer

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 55 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::ScalarType itk::Similarity3DTransform< TScalarType >::ScalarType

Standard scalar type for this class

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 74 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef TScalarType itk::Similarity3DTransform< TScalarType >::ScaleType

Definition at line 93 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Similarity3DTransform itk::Similarity3DTransform< TScalarType >::Self

Standard class typedefs.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 53 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef VersorRigid3DTransform<TScalarType> itk::Similarity3DTransform< TScalarType >::Superclass

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 54 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::TranslationType itk::Similarity3DTransform< TScalarType >::TranslationType

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 87 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
typedef Superclass::VersorType itk::Similarity3DTransform< TScalarType >::VersorType

Versor type.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 90 of file itkSimilarity3DTransform.h.


Constructor & Destructor Documentation

template<class TScalarType = double>
itk::Similarity3DTransform< TScalarType >::Similarity3DTransform ( const MatrixType matrix,
const OutputVectorType offset 
) [protected]
template<class TScalarType = double>
itk::Similarity3DTransform< TScalarType >::Similarity3DTransform ( unsigned int  paramDim) [protected]
template<class TScalarType = double>
itk::Similarity3DTransform< TScalarType >::Similarity3DTransform ( ) [protected]
template<class TScalarType = double>
itk::Similarity3DTransform< TScalarType >::~Similarity3DTransform ( ) [inline, protected]

Definition at line 128 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
itk::Similarity3DTransform< TScalarType >::Similarity3DTransform ( const Self ) [private]

Member Function Documentation

template<class TScalarType = double>
virtual void itk::Similarity3DTransform< TScalarType >::ComputeJacobianWithRespectToParameters ( const InputPointType p,
JacobianType jacobian 
) const [virtual]

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::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::ComputeMatrix ( ) [protected, virtual]

Recomputes the matrix by calling the Superclass::ComputeMatrix() and then applying the scale factor.

Reimplemented from itk::VersorTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::ComputeMatrixParameters ( ) [protected, virtual]

Computes the parameters from an input matrix.

Reimplemented from itk::VersorTransform< TScalarType >.

template<class TScalarType = double>
virtual::itk::LightObject::Pointer itk::Similarity3DTransform< TScalarType >::CreateAnother ( void  ) const [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::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
virtual const char* itk::Similarity3DTransform< TScalarType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
virtual const ParametersType& itk::Similarity3DTransform< TScalarType >::GetParameters ( void  ) const [virtual]

Get the Transformation Parameters.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
virtual const ScaleType& itk::Similarity3DTransform< TScalarType >::GetScale ( ) [virtual]
template<class TScalarType = double>
static Pointer itk::Similarity3DTransform< TScalarType >::New ( ) [static]

New macro for creation of through a Smart Pointer.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::operator= ( const Self ) [private]

Assignment operator

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Print contents of a VersorTransform

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
virtual void itk::Similarity3DTransform< TScalarType >::SetIdentity ( void  ) [virtual]

Set the parameters to the IdentityTransform

Reimplemented from itk::VersorTransform< TScalarType >.

template<class TScalarType = double>
virtual void itk::Similarity3DTransform< TScalarType >::SetMatrix ( const MatrixType matrix) [virtual]

Directly set the rotation matrix of the transform.

Warning:
The input matrix must be orthogonal with isotropic scaling to within a specified tolerance, else an exception is thrown.
See also:
MatrixOffsetTransformBase::SetMatrix()

Reimplemented from itk::Rigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::SetParameters ( const ParametersType parameters) [virtual]

Set the transformation from a container of parameters This is typically used by optimizers. There are 7 parameters. The first three represent the versor, the next three represent the translation and the last one represents the scaling factor.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::Similarity3DTransform< TScalarType >::SetScale ( ScaleType  scale)

Set/Get the value of the isotropic scaling factor


Member Data Documentation

template<class TScalarType = double>
const unsigned int itk::Similarity3DTransform< TScalarType >::InputSpaceDimension = 3 [static]

Dimension of parameters.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 66 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
ScaleType itk::Similarity3DTransform< TScalarType >::m_Scale [private]

Definition at line 145 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
const unsigned int itk::Similarity3DTransform< TScalarType >::OutputSpaceDimension = 3 [static]

Dimension of parameters.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 67 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
const unsigned int itk::Similarity3DTransform< TScalarType >::ParametersDimension = 7 [static]

Dimension of parameters.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 68 of file itkSimilarity3DTransform.h.

template<class TScalarType = double>
const unsigned int itk::Similarity3DTransform< TScalarType >::SpaceDimension = 3 [static]

Dimension of parameters.

Reimplemented from itk::VersorRigid3DTransform< TScalarType >.

Definition at line 65 of file itkSimilarity3DTransform.h.


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