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

#include <mitkTransformParameters.h>

Public Types
enum	TransformType { TRANSLATIONTRANSFORM = 0, SCALETRANSFORM = 1, SCALELOGARITHMICTRANSFORM = 2, AFFINETRANSFORM = 3, FIXEDCENTEROFROTATIONAFFINETRANSFORM = 4, RIGID3DTRANSFORM = 5, EULER3DTRANSFORM = 6, CENTEREDEULER3DTRANSFORM = 7, QUATERNIONRIGIDTRANSFORM = 8, VERSORTRANSFORM = 9, VERSORRIGID3DTRANSFORM = 10, SCALESKEWVERSOR3DTRANSFORM = 11, SIMILARITY3DTRANSFORM = 12, RIGID2DTRANSFORM = 13, CENTEREDRIGID2DTRANSFORM = 14, EULER2DTRANSFORM = 15, SIMILARITY2DTRANSFORM = 16, CENTEREDSIMILARITY2DTRANSFORM = 17 }
	Unique integer value for every transform. More...
typedef TransformParameters	Self
typedef ::itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetTransform (int _arg)
	Sets the transform used for registration by its unique integer value.
virtual int	GetTransform ()
	Returns the transform used for registration by its unique integer value.
void	SetScales (itk::Array< double > scales)
	Sets an array that holds the magnitudes of changes for the transforms degrees of freedom.
itk::Array< double >	GetScales ()
	Returns an array that holds the magnitudes of changes for the transforms degrees of freedom.
void	SetInitialParameters (itk::Array< double > initialParameters)
	Sets an array that holds the initial transform parameters.
itk::Array< double >	GetInitialParameters ()
	Returns an array that holds the initial transform parameters.
virtual void	SetTransformInitializerOn (bool _arg)
	Sets whether a transform initializer will be used.
virtual bool	GetTransformInitializerOn ()
	Returns whether a transform initializer will be used.
virtual void	SetMomentsOn (bool _arg)
	Sets whether the transform initializer will be used to align the images moments or their centers.
virtual bool	GetMomentsOn ()
	Returns whether the transform initializer will be used to align the images moments or their centers.
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.
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.
virtual void	SetAngle (float _arg)
	Sets the initial angle for transforms.
virtual float	GetAngle ()
	Returns the initial angle for transforms.
virtual void	SetScale (float _arg)
	Sets the transforms initial scale.
virtual float	GetScale ()
	Returns the transforms initial scale.
virtual void	SetTransformCenterX (double _arg)
	This setter is used by the mitkTransformFactory to set the transforms initial center in X direction.
virtual double	GetTransformCenterX ()
	Returns the transforms initial center in X direction.
virtual void	SetTransformCenterY (double _arg)
	This setter is used by the mitkTransformFactory to set the transforms initial center in Y direction.
virtual double	GetTransformCenterY ()
	Returns the transforms initial center in Y direction.
virtual void	SetTransformCenterZ (double _arg)
	This setter is used by the mitkTransformFactory to set the transforms initial center in Z direction.
virtual double	GetTransformCenterZ ()
	Returns the transforms initial center in Z direction.
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 45 of file mitkTransformParameters.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::TransformParameters::ConstPointer

Definition at line 48 of file mitkTransformParameters.h.

typedef itk::SmartPointer<Self> mitk::TransformParameters::Pointer

Definition at line 48 of file mitkTransformParameters.h.

typedef TransformParameters mitk::TransformParameters::Self

Definition at line 48 of file mitkTransformParameters.h.

typedef ::itk::Object mitk::TransformParameters::Superclass

Definition at line 48 of file mitkTransformParameters.h.

Member Enumeration Documentation

enum mitk::TransformParameters::TransformType

Unique integer value for every transform.

Enumerator:

TRANSLATIONTRANSFORM
SCALETRANSFORM
SCALELOGARITHMICTRANSFORM
AFFINETRANSFORM
FIXEDCENTEROFROTATIONAFFINETRANSFORM
RIGID3DTRANSFORM
EULER3DTRANSFORM
CENTEREDEULER3DTRANSFORM
QUATERNIONRIGIDTRANSFORM
VERSORTRANSFORM
VERSORRIGID3DTRANSFORM
SCALESKEWVERSOR3DTRANSFORM
SIMILARITY3DTRANSFORM
RIGID2DTRANSFORM
CENTEREDRIGID2DTRANSFORM
EULER2DTRANSFORM
SIMILARITY2DTRANSFORM
CENTEREDSIMILARITY2DTRANSFORM

Definition at line 54 of file mitkTransformParameters.h.

                       {
      TRANSLATIONTRANSFORM = 0,
      SCALETRANSFORM = 1,
      SCALELOGARITHMICTRANSFORM = 2,
      AFFINETRANSFORM = 3,
      FIXEDCENTEROFROTATIONAFFINETRANSFORM = 4,
      RIGID3DTRANSFORM = 5,
      EULER3DTRANSFORM = 6,
      CENTEREDEULER3DTRANSFORM = 7,
      QUATERNIONRIGIDTRANSFORM = 8,
      VERSORTRANSFORM = 9,
      VERSORRIGID3DTRANSFORM = 10,
      SCALESKEWVERSOR3DTRANSFORM = 11,
      SIMILARITY3DTRANSFORM = 12,
      RIGID2DTRANSFORM = 13,
      CENTEREDRIGID2DTRANSFORM = 14,
      EULER2DTRANSFORM = 15,
      SIMILARITY2DTRANSFORM = 16,
      CENTEREDSIMILARITY2DTRANSFORM = 17
    };

Constructor & Destructor Documentation

mitk::TransformParameters::TransformParameters ( ) [protected]

Definition at line 24 of file mitkTransformParameters.cpp.

References m_InitialParameters, and m_Scales.

                                           :
    m_Transform(TRANSLATIONTRANSFORM),
    m_Angle(0.0),
    m_Scale(1.0),
    m_TransformInitializerOn(true),
    m_MomentsOn(true),
    m_UseOptimizerScales(true),
    m_TransformCenterX(0.0),
    m_TransformCenterY(0.0),
    m_TransformCenterZ(0.0)
    {
      m_InitialParameters.set_size(0);
      m_Scales.SetSize(16);
      m_Scales.Fill(1.0);
    }

mitk::TransformParameters::~TransformParameters ( ) [inline, protected]

Definition at line 195 of file mitkTransformParameters.h.

{};

Member Function Documentation

virtual float mitk::TransformParameters::GetAngle ( ) [virtual]

Returns the initial angle for transforms.

virtual const char* mitk::TransformParameters::GetClassName ( ) const [virtual]

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

Returns an array that holds the initial transform parameters.

Definition at line 55 of file mitkTransformParameters.cpp.

References m_InitialParameters.

  {
    return 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 45 of file mitkTransformParameters.cpp.

References m_Scales.

  {
    return 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.

static Pointer mitk::TransformParameters::New ( ) [static]

Referenced by mitk::PyramidalRegistrationMethod::PyramidalRegistrationMethod().

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 50 of file mitkTransformParameters.cpp.

References m_InitialParameters.

  {
    m_InitialParameters = 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 40 of file mitkTransformParameters.cpp.

References m_Scales.

  {
    m_Scales = 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 198 of file mitkTransformParameters.h.

itk::Array<double> mitk::TransformParameters::m_InitialParameters [protected]

Definition at line 207 of file mitkTransformParameters.h.

Referenced by GetInitialParameters(), SetInitialParameters(), and TransformParameters().

bool mitk::TransformParameters::m_MomentsOn [protected]

Definition at line 201 of file mitkTransformParameters.h.

float mitk::TransformParameters::m_Scale [protected]

Definition at line 199 of file mitkTransformParameters.h.

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

Definition at line 206 of file mitkTransformParameters.h.

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

int mitk::TransformParameters::m_Transform [protected]

Definition at line 195 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterX [protected]

Definition at line 203 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterY [protected]

Definition at line 204 of file mitkTransformParameters.h.

double mitk::TransformParameters::m_TransformCenterZ [protected]

Definition at line 205 of file mitkTransformParameters.h.

bool mitk::TransformParameters::m_TransformInitializerOn [protected]

Definition at line 200 of file mitkTransformParameters.h.

bool mitk::TransformParameters::m_UseOptimizerScales [protected]

Definition at line 202 of file mitkTransformParameters.h.

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

mitk::TransformParameters Class Reference [Classes related to rigid registration]

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

mitk::TransformParameters Class Reference
[Classes related to rigid registration]