go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
elastix::EulerTransformElastix< TElastix > Class Template Reference

#include <elxEulerTransform.h>

Inheritance diagram for elastix::EulerTransformElastix< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::EulerTransformElastix< TElastix >:
Collaboration graph
[legend]

Public Types

typedef
Superclass2::CombinationTransformType 
CombinationTransformType
typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef Superclass2::CoordRepType CoordRepType
typedef
FixedImageType::DirectionType 
DirectionType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef EulerTransformType::Pointer EulerTransformPointer
typedef EulerTransform
< typename elx::TransformBase
< TElastix >::CoordRepType,
elx::TransformBase< TElastix >
::FixedImageDimension > 
EulerTransformType
typedef Superclass2::FixedImageType FixedImageType
typedef FixedImageType::IndexType IndexType
typedef IndexType::IndexValueType IndexValueType
typedef
Superclass1::InputCovariantVectorType 
InputCovariantVectorType
typedef Superclass1::InputPointType InputPointType
typedef
Superclass1::InputVectorType 
InputVectorType
typedef
Superclass1::InputVnlVectorType 
InputVnlVectorType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::JacobianType JacobianType
typedef
Superclass2::MovingImageType 
MovingImageType
typedef
EulerTransformType::OffsetType 
OffsetType
typedef
Superclass1::OutputCovariantVectorType 
OutputCovariantVectorType
typedef
Superclass1::OutputPointType 
OutputPointType
typedef
Superclass1::OutputVectorType 
OutputVectorType
typedef
Superclass1::OutputVnlVectorType 
OutputVnlVectorType
typedef Superclass1::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef FixedImageType::PointType PointType
typedef FixedImageType::RegionType RegionType
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef Superclass1::ScalarType ScalarType
typedef Superclass2::ScalesType ScalesType
typedef EulerTransformElastix Self
typedef FixedImageType::SizeType SizeType
typedef FixedImageType::SpacingType SpacingType
typedef
AdvancedCombinationTransform
< typename elx::TransformBase
< TElastix >::CoordRepType,
elx::TransformBase< TElastix >
::FixedImageDimension > 
Superclass1
typedef elx::TransformBase
< TElastix > 
Superclass2
typedef
TransformInitializerType::Pointer 
TransformInitializerPointer
typedef
CenteredTransformInitializer
< EulerTransformType,
FixedImageType,
MovingImageType
TransformInitializerType

Public Member Functions

virtual void BeforeRegistration (void)
 elxClassNameMacro ("EulerTransform")
virtual const char * GetClassName () const
virtual void InitializeTransform (void)
 itkStaticConstMacro (SpaceDimension, unsigned int, Superclass2::FixedImageDimension)
virtual void ReadFromFile (void)
virtual void SetScales (void)
virtual void WriteToFile (const ParametersType &param) const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 EulerTransformElastix ()
virtual bool ReadCenterOfRotationIndex (InputPointType &rotationPoint) const
virtual bool ReadCenterOfRotationPoint (InputPointType &rotationPoint) const
virtual ~EulerTransformElastix ()

Private Member Functions

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

Private Attributes

EulerTransformPointer m_EulerTransform

Detailed Description

template<class TElastix>
class elastix::EulerTransformElastix< TElastix >

A transform based on the itk EulerTransforms.

This transform is a rigid body transformation.

The parameters used in this class are:

Parameters:
Transform: Select this transform as follows:
(Transform "EulerTransform")
Parameters:
Scales: the scale factor between the rotations and translations, used in the optimizer.
example: (Scales 200000.0)
example: (Scales 100000.0 60000.0 ... 80000.0)
If only one argument is given, that factor is used for the rotations. If more than one argument is given, then the number of arguments should be equal to the number of parameters: for each parameter its scale factor. If this parameter option is not used, by default the rotations are scaled by a factor of 100000.0. See also the AutomaticScalesEstimation parameter.
Parameters:
AutomaticScalesEstimation: if this parameter is set to "true" the Scales parameter is ignored and the scales are determined automatically.
example: ( AutomaticScalesEstimation "true" )
Default: "false" (for backwards compatibility). Recommended: "true".
Parameters:
CenterOfRotation: an index around which the image is rotated.
example: (CenterOfRotation 128 128 90)
By default the CenterOfRotation is set to the geometric center of the image.
Parameters:
AutomaticTransformInitialization: whether or not the initial translation between images should be estimated as the distance between their centers.
example: (AutomaticTransformInitialization "true")
By default "false" is assumed. So, no initial translation.
Parameters:
AutomaticTransformInitializationMethod: how to initialize this transform. Should be one of {GeometricalCenter, CenterOfGravity}.
example: (AutomaticTransformInitializationMethod "CenterOfGravity")
By default "GeometricalCenter" is assumed.

The transform parameters necessary for transformix, additionally defined by this class, are:

Transform Parameters:
CenterOfRotation: stores the center of rotation as an index.
example: (CenterOfRotation 128 128 90)
depecrated! From elastix version 3.402 this is changed to CenterOfRotationPoint!
Transform Parameters:
CenterOfRotationPoint: stores the center of rotation, expressed in world coordinates.
example: (CenterOfRotationPoint 10.555 6.666 12.345)

Definition at line 72 of file elxEulerTransform.h.


Member Typedef Documentation

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 144 of file elxEulerTransform.h.

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 137 of file elxEulerTransform.h.

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 136 of file elxEulerTransform.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::EulerTransformElastix< TElastix >::ConstPointer
template<class TElastix >
typedef Superclass2::CoordRepType elastix::EulerTransformElastix< TElastix >::CoordRepType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 140 of file elxEulerTransform.h.

template<class TElastix >
typedef FixedImageType::DirectionType elastix::EulerTransformElastix< TElastix >::DirectionType

Definition at line 153 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass2::ElastixPointer elastix::EulerTransformElastix< TElastix >::ElastixPointer

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 135 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass2::ElastixType elastix::EulerTransformElastix< TElastix >::ElastixType

Typedef's inherited from TransformBase.

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 134 of file elxEulerTransform.h.

template<class TElastix >
typedef EulerTransformType::Pointer elastix::EulerTransformElastix< TElastix >::EulerTransformPointer

Definition at line 130 of file elxEulerTransform.h.

template<class TElastix >
typedef EulerTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension > elastix::EulerTransformElastix< TElastix >::EulerTransformType

The ITK-class that provides most of the functionality, and that is set as the "CurrentTransform" in the CombinationTransform

Definition at line 93 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass2::FixedImageType elastix::EulerTransformElastix< TElastix >::FixedImageType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 141 of file elxEulerTransform.h.

template<class TElastix >
typedef FixedImageType::IndexType elastix::EulerTransformElastix< TElastix >::IndexType

Other typedef's.

Definition at line 147 of file elxEulerTransform.h.

template<class TElastix >
typedef IndexType::IndexValueType elastix::EulerTransformElastix< TElastix >::IndexValueType

Definition at line 148 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::InputPointType elastix::EulerTransformElastix< TElastix >::InputPointType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 121 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::InputVectorType elastix::EulerTransformElastix< TElastix >::InputVectorType
template<class TElastix >
typedef Superclass2::ITKBaseType elastix::EulerTransformElastix< TElastix >::ITKBaseType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 143 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::JacobianType elastix::EulerTransformElastix< TElastix >::JacobianType
template<class TElastix >
typedef Superclass2::MovingImageType elastix::EulerTransformElastix< TElastix >::MovingImageType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 142 of file elxEulerTransform.h.

template<class TElastix >
typedef EulerTransformType::OffsetType elastix::EulerTransformElastix< TElastix >::OffsetType

Definition at line 131 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::OutputPointType elastix::EulerTransformElastix< TElastix >::OutputPointType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 122 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::OutputVectorType elastix::EulerTransformElastix< TElastix >::OutputVectorType
template<class TElastix >
typedef Superclass1::ParametersType elastix::EulerTransformElastix< TElastix >::ParametersType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 118 of file elxEulerTransform.h.

template<class TElastix >
typedef SmartPointer<Self> elastix::EulerTransformElastix< TElastix >::Pointer
template<class TElastix >
typedef FixedImageType::PointType elastix::EulerTransformElastix< TElastix >::PointType

Definition at line 150 of file elxEulerTransform.h.

template<class TElastix >
typedef FixedImageType::RegionType elastix::EulerTransformElastix< TElastix >::RegionType

Definition at line 152 of file elxEulerTransform.h.

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 139 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass2::RegistrationType elastix::EulerTransformElastix< TElastix >::RegistrationType

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 138 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass1::ScalarType elastix::EulerTransformElastix< TElastix >::ScalarType

Typedefs inherited from the superclass. These are both in Euler2D and Euler3D.

Reimplemented from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >.

Definition at line 117 of file elxEulerTransform.h.

template<class TElastix >
typedef Superclass2::ScalesType elastix::EulerTransformElastix< TElastix >::ScalesType

For scales setting in the optimizer

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 160 of file elxEulerTransform.h.

template<class TElastix >
typedef EulerTransformElastix elastix::EulerTransformElastix< TElastix >::Self

Standard ITK-stuff.

Reimplemented from elastix::TransformBase< TElastix >.

Definition at line 81 of file elxEulerTransform.h.

template<class TElastix >
typedef FixedImageType::SizeType elastix::EulerTransformElastix< TElastix >::SizeType

Definition at line 149 of file elxEulerTransform.h.

template<class TElastix >
typedef FixedImageType::SpacingType elastix::EulerTransformElastix< TElastix >::SpacingType

Definition at line 151 of file elxEulerTransform.h.

template<class TElastix >
typedef AdvancedCombinationTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension > elastix::EulerTransformElastix< TElastix >::Superclass1

Definition at line 85 of file elxEulerTransform.h.

template<class TElastix >
typedef elx::TransformBase< TElastix > elastix::EulerTransformElastix< TElastix >::Superclass2

Definition at line 87 of file elxEulerTransform.h.

template<class TElastix >
typedef TransformInitializerType::Pointer elastix::EulerTransformElastix< TElastix >::TransformInitializerPointer

Definition at line 157 of file elxEulerTransform.h.

template<class TElastix >
typedef CenteredTransformInitializer< EulerTransformType, FixedImageType, MovingImageType> elastix::EulerTransformElastix< TElastix >::TransformInitializerType

Definition at line 156 of file elxEulerTransform.h.


Constructor & Destructor Documentation

template<class TElastix >
elastix::EulerTransformElastix< TElastix >::EulerTransformElastix ( ) [protected]

The constructor.

template<class TElastix >
virtual elastix::EulerTransformElastix< TElastix >::~EulerTransformElastix ( ) [inline, protected, virtual]

The destructor.

Definition at line 210 of file elxEulerTransform.h.

template<class TElastix >
elastix::EulerTransformElastix< TElastix >::EulerTransformElastix ( const Self ) [private]

The private constructor.


Member Function Documentation

template<class TElastix >
virtual void elastix::EulerTransformElastix< TElastix >::BeforeRegistration ( void  ) [virtual]

Execute stuff before the actual registration:

  • Call InitializeTransform
  • Set the scales.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::EulerTransformElastix< TElastix >::elxClassNameMacro ( "EulerTransform"  )

Name of this class. Use this name in the parameter file to select this specific transform.
example: (Transform "EulerTransform")

template<class TElastix >
virtual const char* elastix::EulerTransformElastix< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from elastix::TransformBase< TElastix >.

template<class TElastix >
virtual void elastix::EulerTransformElastix< TElastix >::InitializeTransform ( void  ) [virtual]

Initialize Transform.

  • Set all parameters to zero.
  • Set center of rotation: automatically initialized to the geometric center of the image, or assigned a user entered voxel index, given by the parameter (CenterOfRotation <index-x> <index-y> ...); If an initial transform is present and HowToCombineTransforms is set to "Compose", the initial transform is taken into account while setting the center of rotation.
  • Set initial translation: the initial translation between fixed and moving image is guessed, if the user has set (AutomaticTransformInitialization "true").

It is not yet possible to enter an initial rotation angle.

template<class TElastix >
elastix::EulerTransformElastix< TElastix >::itkStaticConstMacro ( SpaceDimension  ,
unsigned  int,
Superclass2::FixedImageDimension   
)

Dimension of the fixed image.

template<class TElastix >
static Pointer elastix::EulerTransformElastix< TElastix >::New ( ) [static]
template<class TElastix >
void elastix::EulerTransformElastix< TElastix >::operator= ( const Self ) [private]

The private copy constructor.

template<class TElastix >
virtual bool elastix::EulerTransformElastix< TElastix >::ReadCenterOfRotationIndex ( InputPointType rotationPoint) const [protected, virtual]

Try to read the CenterOfRotation from the transform parameter file This is an index value, and, thus, converted to world coordinates. Transform parameter files generated by elastix version < 3.402 saved the center of rotation in this way.

template<class TElastix >
virtual bool elastix::EulerTransformElastix< TElastix >::ReadCenterOfRotationPoint ( InputPointType rotationPoint) const [protected, virtual]

Try to read the CenterOfRotationPoint from the transform parameter file The CenterOfRotationPoint is already in world coordinates. Transform parameter files generated by elastix version > 3.402 save the center of rotation in this way.

template<class TElastix >
virtual void elastix::EulerTransformElastix< TElastix >::ReadFromFile ( void  ) [virtual]

Function to read transform-parameters from a file.

It reads the center of rotation and calls the superclass' implementation.

Reimplemented from elastix::TransformBase< TElastix >.

template<class TElastix >
virtual void elastix::EulerTransformElastix< TElastix >::SetScales ( void  ) [virtual]

Set the scales

  • If AutomaticScalesEstimation is "true" estimate scales
  • If scales are provided by the user use those,
  • Otherwise use some default value This function is called by BeforeRegistration, after the InitializeTransform function is called
template<class TElastix >
virtual void elastix::EulerTransformElastix< TElastix >::WriteToFile ( const ParametersType param) const [virtual]

Function to write transform-parameters to a file. It writes the center of rotation to file and calls the superclass' implementation.

Reimplemented from elastix::TransformBase< TElastix >.


Field Documentation

template<class TElastix >
EulerTransformPointer elastix::EulerTransformElastix< TElastix >::m_EulerTransform [private]

Definition at line 233 of file elxEulerTransform.h.



Generated on 24-05-2012 for elastix by doxygen 1.7.6.1 elastix logo