Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::TransformParameters Class Reference

This class is used to hold all transform parameters needed for a rigid registration process. More...

#include <mitkTransformParameters.h>

Inheritance diagram for mitk::TransformParameters:
Collaboration diagram for mitk::TransformParameters:

Public Types

enum  TransformType {
  TRANSLATIONTRANSFORM, SCALETRANSFORM, SCALELOGARITHMICTRANSFORM, AFFINETRANSFORM,
  FIXEDCENTEROFROTATIONAFFINETRANSFORM, EULER3DTRANSFORM, CENTEREDEULER3DTRANSFORM, QUATERNIONRIGIDTRANSFORM,
  VERSORTRANSFORM, VERSORRIGID3DTRANSFORM, SCALESKEWVERSOR3DTRANSFORM, SIMILARITY3DTRANSFORM,
  RIGID2DTRANSFORM, CENTEREDRIGID2DTRANSFORM, EULER2DTRANSFORM, SIMILARITY2DTRANSFORM,
  CENTEREDSIMILARITY2DTRANSFORM
}
 Unique integer value for every transform. More...
 

Public Member Functions

 mitkClassMacroItkParent (TransformParameters,::itk::Object)
 
Pointer Clone () const
 
virtual void SetTransform (int _arg)
 Sets the transform used for registration by its unique integer value. More...
 
virtual int GetTransform ()
 Returns the transform used for registration by its unique integer value. More...
 
void SetScales (itk::Array< double > scales)
 Sets an array that holds the magnitudes of changes for the transforms degrees of freedom. More...
 
itk::Array< double > GetScales ()
 Returns an array that holds the magnitudes of changes for the transforms degrees of freedom. More...
 
void SetInitialParameters (itk::Array< double > initialParameters)
 Sets an array that holds the initial transform parameters. More...
 
itk::Array< double > GetInitialParameters ()
 Returns an array that holds the initial transform parameters. More...
 
virtual void SetTransformInitializerOn (bool _arg)
 Sets whether a transform initializer will be used. More...
 
virtual bool GetTransformInitializerOn ()
 Returns whether a transform initializer will be used. More...
 
virtual void SetMomentsOn (bool _arg)
 Sets whether the transform initializer will be used to align the images moments or their centers. More...
 
virtual bool GetMomentsOn ()
 Returns whether the transform initializer will be used to align the images moments or their centers. More...
 
virtual void SetUseOptimizerScales (bool _arg)
 Sets whether the optimizer scales will be used to let the optimizer know about different magnitudes for the transforms degrees of freedom. More...
 
virtual bool GetUseOptimizerScales ()
 Returns whether the optimizer scales will be used to let the optimizer know about different magnitudes for the transforms degrees of freedom. More...
 
virtual void SetAngle (float _arg)
 Sets the initial angle for transforms. More...
 
virtual float GetAngle ()
 Returns the initial angle for transforms. More...
 
virtual void SetScale (float _arg)
 Sets the transforms initial scale. More...
 
virtual float GetScale ()
 Returns the transforms initial scale. More...
 
virtual void SetTransformCenterX (double _arg)
 This setter is used by the mitkTransformFactory to set the transforms initial center in X direction. More...
 
virtual double GetTransformCenterX ()
 Returns the transforms initial center in X direction. More...
 
virtual void SetTransformCenterY (double _arg)
 This setter is used by the mitkTransformFactory to set the transforms initial center in Y direction. More...
 
virtual double GetTransformCenterY ()
 Returns the transforms initial center in Y direction. More...
 
virtual void SetTransformCenterZ (double _arg)
 This setter is used by the mitkTransformFactory to set the transforms initial center in Z direction. More...
 
virtual double GetTransformCenterZ ()
 Returns the transforms initial center in Z direction. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 TransformParameters ()
 
 ~TransformParameters ()
 

Protected Attributes

int m_Transform
 
float m_Angle
 
float m_Scale
 
bool m_TransformInitializerOn
 
bool m_MomentsOn
 
bool m_UseOptimizerScales
 
double m_TransformCenterX
 
double m_TransformCenterY
 
double m_TransformCenterZ
 
itk::Array< double > m_Scales
 
itk::Array< double > m_InitialParameters
 

Detailed Description

This class is used to hold all transform parameters needed for a rigid registration process.

To use the rigid registration framework you have to create an instance of this class and fill it with the parameters belonging to the selected transformation. To let the rigid registration work properly, this instance has to be given to mitkImageRegistrationMethod before calling the update() method in mitkImageRegistrationMethod.

Also instances of the classes mitkMetricParameters and mitkOptimizerParameters have to be set in mitkImageRegistrationMethod before calling the update() method.

Author
Daniel Stein

Definition at line 44 of file mitkTransformParameters.h.

Constructor & Destructor Documentation

mitk::TransformParameters::TransformParameters ( )
protected

Definition at line 21 of file mitkTransformParameters.cpp.

References m_InitialParameters, and m_Scales.

mitk::TransformParameters::~TransformParameters ( )
inlineprotected

Definition at line 192 of file mitkTransformParameters.h.

Member Function Documentation

Pointer mitk::TransformParameters::Clone ( ) const
virtual float mitk::TransformParameters::GetAngle ( )
virtual

Returns the initial angle for transforms.

itk::Array< double > mitk::TransformParameters::GetInitialParameters ( )

Returns an array that holds the initial transform parameters.

Definition at line 44 of file mitkTransformParameters.cpp.

References m_InitialParameters.

virtual bool mitk::TransformParameters::GetMomentsOn ( )
virtual

Returns whether the transform initializer will be used to align the images moments or their centers.

True = image moments will be aligned, false = image centers will be aligned.

virtual float mitk::TransformParameters::GetScale ( )
virtual

Returns the transforms initial scale.

itk::Array< double > mitk::TransformParameters::GetScales ( )

Returns an array that holds the magnitudes of changes for the transforms degrees of freedom.

The optimizer changes the transforms values corresponding to this array values.

Definition at line 38 of file mitkTransformParameters.cpp.

References m_Scales.

virtual int mitk::TransformParameters::GetTransform ( )
virtual

Returns the transform used for registration by its unique integer value.

virtual double mitk::TransformParameters::GetTransformCenterX ( )
virtual

Returns the transforms initial center in X direction.

virtual double mitk::TransformParameters::GetTransformCenterY ( )
virtual

Returns the transforms initial center in Y direction.

virtual double mitk::TransformParameters::GetTransformCenterZ ( )
virtual

Returns the transforms initial center in Z direction.

virtual bool mitk::TransformParameters::GetTransformInitializerOn ( )
virtual

Returns whether a transform initializer will be used.

True = initializer is used, false = initializer is not used.

virtual bool mitk::TransformParameters::GetUseOptimizerScales ( )
virtual

Returns whether the optimizer scales will be used to let the optimizer know about different magnitudes for the transforms degrees of freedom.

True = optimizer scales will be used, false = optimizer scales will not be used.

mitk::TransformParameters::mitkClassMacroItkParent ( TransformParameters  ,
::itk::Object   
)
virtual void mitk::TransformParameters::SetAngle ( float  _arg)
virtual

Sets the initial angle for transforms.

void mitk::TransformParameters::SetInitialParameters ( itk::Array< double >  initialParameters)

Sets an array that holds the initial transform parameters.

Definition at line 39 of file mitkTransformParameters.cpp.

References m_InitialParameters.

virtual void mitk::TransformParameters::SetMomentsOn ( bool  _arg)
virtual

Sets whether the transform initializer will be used to align the images moments or their centers.

True = image moments will be aligned, false = image centers will be aligned.

virtual void mitk::TransformParameters::SetScale ( float  _arg)
virtual

Sets the transforms initial scale.

void mitk::TransformParameters::SetScales ( itk::Array< double >  scales)

Sets an array that holds the magnitudes of changes for the transforms degrees of freedom.

The optimizer changes the transforms values corresponding to this array values.

Definition at line 37 of file mitkTransformParameters.cpp.

References m_Scales.

virtual void mitk::TransformParameters::SetTransform ( int  _arg)
virtual

Sets the transform used for registration by its unique integer value.

virtual void mitk::TransformParameters::SetTransformCenterX ( double  _arg)
virtual

This setter is used by the mitkTransformFactory to set the transforms initial center in X direction.

virtual void mitk::TransformParameters::SetTransformCenterY ( double  _arg)
virtual

This setter is used by the mitkTransformFactory to set the transforms initial center in Y direction.

virtual void mitk::TransformParameters::SetTransformCenterZ ( double  _arg)
virtual

This setter is used by the mitkTransformFactory to set the transforms initial center in Z direction.

virtual void mitk::TransformParameters::SetTransformInitializerOn ( bool  _arg)
virtual

Sets whether a transform initializer will be used.

True = initializer is used, initializer is not used.

virtual void mitk::TransformParameters::SetUseOptimizerScales ( bool  _arg)
virtual

Sets whether the optimizer scales will be used to let the optimizer know about different magnitudes for the transforms degrees of freedom.

True = optimizer scales will be used, false = optimizer scales will not be used.

Member Data Documentation

float mitk::TransformParameters::m_Angle
protected

Definition at line 195 of file mitkTransformParameters.h.

itk::Array<double> mitk::TransformParameters::m_InitialParameters
protected
bool mitk::TransformParameters::m_MomentsOn
protected

Definition at line 198 of file mitkTransformParameters.h.

float mitk::TransformParameters::m_Scale
protected

Definition at line 196 of file mitkTransformParameters.h.

itk::Array<double> mitk::TransformParameters::m_Scales
protected

Definition at line 203 of file mitkTransformParameters.h.

Referenced by GetScales(), SetScales(), and TransformParameters().

int mitk::TransformParameters::m_Transform
protected

Definition at line 192 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterX
protected

Definition at line 200 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterY
protected

Definition at line 201 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterZ
protected

Definition at line 202 of file mitkTransformParameters.h.

bool mitk::TransformParameters::m_TransformInitializerOn
protected

Definition at line 197 of file mitkTransformParameters.h.

bool mitk::TransformParameters::m_UseOptimizerScales
protected

Definition at line 199 of file mitkTransformParameters.h.


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