Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::ScaleTransform< TScalarType, NDimensions > Class Template Reference
[Transforms]

Scale transformation of a vector space (e.g. space coordinates). More...

#include <itkScaleTransform.h>

Inheritance diagram for itk::ScaleTransform:

Inheritance graph
[legend]
Collaboration diagram for itk::ScaleTransform< TScalarType, NDimensions >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ScaleTransform Self
typedef Transform< TScalarType,
NDimensions, NDimensions > 		Superclass
typedef SmartPointer< Self > Pointer
typedef SmartPointer< const
Self > 		ConstPointer
typedef Superclass::ScalarType ScalarType
typedef Superclass::ParametersType ParametersType
typedef Superclass::JacobianType JacobianType
typedef FixedArray< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		ScaleType )
typedef Vector< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		InputVectorType )
typedef Vector< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		OutputVectorType )
typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		InputCovariantVectorType )
typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		OutputCovariantVectorType )
typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(SpaceDimension) 		InputVnlVectorType )
typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(SpaceDimension) 		OutputVnlVectorType )
typedef Point< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		InputPointType )
typedef Point< TScalarType,
itkGetStaticConstMacro(SpaceDimension) 		OutputPointType )

Public Methods

virtual const char * GetClassName () const
const ScaleType & GetScale (void) const
void SetParameters (const ParametersType &parameters)
const ParametersType & GetParameters (void) const
const JacobianType & GetJacobian (const InputPointType &point) const
void SetScale (const ScaleType &scale)
void Compose (const Self *other, bool pre=false)
void Scale (const ScaleType &scale, bool pre=false)
ScaleTransform::Pointer Inverse (void) const
void SetIdentity (void)
 itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)
 itkStaticConstMacro (ParametersDimension, unsigned int, NDimensions)
OutputPointType TransformPoint (const InputPointType &point) const
OutputVectorType TransformVector (const InputVectorType &vector) const
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const
InputPointType BackTransform (const OutputPointType &point) const
InputVectorType BackTransform (const OutputVectorType &vector) const
InputVnlVectorType BackTransform (const OutputVnlVectorType &vector) const
InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vector) const

Static Public Methods

Pointer New ()

Protected Methods

 ScaleTransform ()
 ~ScaleTransform ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TScalarType = float, unsigned int NDimensions = 3>
class itk::ScaleTransform< TScalarType, NDimensions >

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

The same functionality could be obtained by using the Affine tranform, but with a large difference in performace

Definition at line 39 of file itkScaleTransform.h.

Member Typedef Documentation

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef SmartPointer<const Self> itk::ScaleTransform< TScalarType, NDimensions >::ConstPointer
 

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 48 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::InputCovariantVectorType)
 

Standard covariant vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 79 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::InputPointType)
 

Standard coordinate point type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 89 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::InputVectorType)
 

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 74 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::InputVnlVectorType)
 

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 84 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Superclass::JacobianType itk::ScaleTransform< TScalarType, NDimensions >::JacobianType
 

Jacobian type.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 68 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::OutputCovariantVectorType)
 

Standard covariant vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 80 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::OutputPointType)
 

Standard coordinate point type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 90 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::OutputVectorType)
 

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 75 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::OutputVnlVectorType)
 

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 85 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Superclass::ParametersType itk::ScaleTransform< TScalarType, NDimensions >::ParametersType
 

Parameters type.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 65 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef SmartPointer<Self> itk::ScaleTransform< TScalarType, NDimensions >::Pointer
 

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 47 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Superclass::ScalarType itk::ScaleTransform< TScalarType, NDimensions >::ScalarType
 

Scalar type.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 62 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef FixedArray<TScalarType, itkGetStaticConstMacro(SpaceDimension) itk::ScaleTransform< TScalarType, NDimensions >::ScaleType)
 

Standard vector type for this class.

Definition at line 71 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef ScaleTransform itk::ScaleTransform< TScalarType, NDimensions >::Self
 

Standard class typedefs.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 45 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
typedef Transform< TScalarType, NDimensions, NDimensions > itk::ScaleTransform< TScalarType, NDimensions >::Superclass
 

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 46 of file itkScaleTransform.h.

Constructor & Destructor Documentation

template<class TScalarType = float, unsigned int NDimensions = 3>
itk::ScaleTransform< TScalarType, NDimensions >::ScaleTransform (    )  [protected]
 

Construct an ScaleTransform object.

template<class TScalarType = float, unsigned int NDimensions = 3>
itk::ScaleTransform< TScalarType, NDimensions >::~ScaleTransform (    )  [protected]
 

Destroy an ScaleTransform object.

Member Function Documentation

template<class TScalarType = float, unsigned int NDimensions = 3>
InputCovariantVectorType itk::ScaleTransform< TScalarType, NDimensions >::BackTransform (  const OutputCovariantVectorType &    vector )  const [inline]
 

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.

template<class TScalarType = float, unsigned int NDimensions = 3>
InputVnlVectorType itk::ScaleTransform< TScalarType, NDimensions >::BackTransform (  const OutputVnlVectorType &    vector )  const [inline]
 

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.

template<class TScalarType = float, unsigned int NDimensions = 3>
InputVectorType itk::ScaleTransform< TScalarType, NDimensions >::BackTransform (  const OutputVectorType &    vector )  const [inline]
 

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.

template<class TScalarType = float, unsigned int NDimensions = 3>
InputPointType itk::ScaleTransform< TScalarType, NDimensions >::BackTransform (  const OutputPointType &    point )  const [inline]
 

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.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::Compose (  const Self *    other,
bool    pre = false
) 
 

Compose with another ScaleTransform.

template<class TScalarType = float, unsigned int NDimensions = 3>
virtual const char* itk::ScaleTransform< TScalarType, NDimensions >::GetClassName (    )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
const JacobianType& itk::ScaleTransform< TScalarType, NDimensions >::GetJacobian (  const InputPointType &    point )  const [virtual]
 

Get the Jacobian matrix.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
const ParametersType& itk::ScaleTransform< TScalarType, NDimensions >::GetParameters (  void    )  const [virtual]
 

Get the parameters that uniquely define the transform This is typically used by optimizers. There are 4 parameters. The first one represents the rotation, the second one the scale and the last two represent the offset.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
const ScaleType& itk::ScaleTransform< TScalarType, NDimensions >::GetScale (  void    )  const [inline]
 

Get scale of an ScaleTransform. This method returns the value of the offset of the ScaleTransform.

Definition at line 96 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
ScaleTransform::Pointer itk::ScaleTransform< TScalarType, NDimensions >::Inverse (  void    )  const
 

Find inverse of an affine transformation This method creates and returns a new ScaleTransform object which is the inverse of self. If self is not invertible, an exception is thrown.

template<class TScalarType = float, unsigned int NDimensions = 3>
itk::ScaleTransform< TScalarType, NDimensions >::itkStaticConstMacro (  ParametersDimension   ,
unsigned    int,
NDimensions   
) 
 

Dimension of the domain space.

template<class TScalarType = float, unsigned int NDimensions = 3>
itk::ScaleTransform< TScalarType, NDimensions >::itkStaticConstMacro (  SpaceDimension   ,
unsigned    int,
NDimensions   
) 
 

Dimension of the domain space.

template<class TScalarType = float, unsigned int NDimensions = 3>
Pointer itk::ScaleTransform< TScalarType, NDimensions >::New (    )  [static]
 

New macro for creation of through a smart pointer.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::PrintSelf (  std::ostream &    os,
Indent    indent
)  const [protected, virtual]
 

Print contents of an ScaleTransform

Reimplemented from itk::Object.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::Scale (  const ScaleType &    scale,
bool    pre = false
) 
 

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.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::SetIdentity (  void    )  [inline]
 

Set the transformation to an Identity

This sets all the scales to 1.0

Definition at line 162 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::SetParameters (  const ParametersType &    parameters )  [virtual]
 

Set parameters. This method sets the parameters for the transform value specified by the user.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TScalarType, NDimensions >::SetScale (  const ScaleType &    scale )  [inline]
 

Set offset of an Scale Transform This method sets the offset of an ScaleTransform to a value specified by the user. This method cannot be done with SetMacro because itk::Array has not an operator== defined.

Definition at line 119 of file itkScaleTransform.h.

template<class TScalarType = float, unsigned int NDimensions = 3>
OutputCovariantVectorType itk::ScaleTransform< TScalarType, NDimensions >::TransformCovariantVector (  const InputCovariantVectorType &    vector )  const [virtual]
 

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.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
OutputPointType itk::ScaleTransform< TScalarType, NDimensions >::TransformPoint (  const InputPointType &    point )  const [virtual]
 

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.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
OutputVnlVectorType itk::ScaleTransform< TScalarType, NDimensions >::TransformVector (  const InputVnlVectorType &    vector )  const [virtual]
 

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.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

template<class TScalarType = float, unsigned int NDimensions = 3>
OutputVectorType itk::ScaleTransform< TScalarType, NDimensions >::TransformVector (  const InputVectorType &    vector )  const [virtual]
 

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.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

The documentation for this class was generated from the following file:
Generated at Fri May 21 01:39:41 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000