FREE::TransformSetupAdaptor Class Reference
[Setup component adapter]

Class of setup information for transformations. More...

#include <freTransformSetupAdaptor.h>

Inheritance diagram for FREE::TransformSetupAdaptor:

[legend]

Collaboration diagram for FREE::TransformSetupAdaptor:

[legend]

List of all members.

Public Member Functions
void	SetInitialTransformParameters (ParameterArrayType initialParameters)
ParameterArrayType	GetInitialTransformParameters () const
void	SetCurrentTransformParameters (const ParameterArrayType &finalParameters)
ParameterArrayType	GetCurrentTransformParameters () const
void	SetScales (ParameterArrayType newScales)
ParameterArrayType	GetScales (const int iLevel) const
virtual ComponentSetup *	Adapt (ComponentSetup *pComponent)
	TransformSetupAdaptor (ComponentSetup *pComponent=NULL)
virtual	~TransformSetupAdaptor ()

---

Detailed Description

Class of setup information for transformations.

TransformSetupAdaptor is used to initialize a ComponentSetup with the basic requirements of a controller based on TransformControllerBase. And also the adapter offers member functions to access these parameters in specialized ways.
Added Parameters are:

• cParam_InitialTransformValues;
• cParam_CurrentTransformValues;
• cParam_TransformScale;
• cParam_InitialisationMethod;

Most of the elements and their dimensions are unspecified at instantiation and will be set by the controller by calling the controller function InitializeSetup.

Definition at line 49 of file freTransformSetupAdaptor.h.

---

Constructor & Destructor Documentation

FREE::TransformSetupAdaptor::TransformSetupAdaptor

(

ComponentSetup *

pComponent = NULL

)

Definition at line 147 of file freTransformSetupAdaptor.cxx.

FREE::TransformSetupAdaptor::~TransformSetupAdaptor

(

)

[virtual]

Definition at line 152 of file freTransformSetupAdaptor.cxx.

---

Member Function Documentation

void FREE::TransformSetupAdaptor::SetInitialTransformParameters

(

ParameterArrayType

initialParameters

)

Function to set the parameters with the key InitialTransformValues. The parameter will be created, with the construction of the TransformSetup.

Parameters:

[in]

initialParameters

Values to set.

Implementation of FREE::TransformSetupAdaptor //////////////////////

Definition at line 36 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_InitialTransformValues, FREE::ComponentAdaptorBase::m_pComponent, and throwExceptionMacro.

ParameterArrayType FREE::TransformSetupAdaptor::GetInitialTransformParameters

(

)

const

Function to access the parameters with the key InitialTransformValues.

Returns:

Array of the parameter value.

Definition at line 48 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_InitialTransformValues, FREE::ComponentAdaptorBase::m_pComponent, and throwExceptionMacro.

Referenced by FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), and FREE::CenteredAffine2DTransformController::SetInitialTransformValues().

void FREE::TransformSetupAdaptor::SetCurrentTransformParameters

(

const ParameterArrayType &

finalParameters

)

Function to set the parameters with the key FinalTransformValues. The parameter will be created, with the construction of the TransformSetup.

Parameters:

[in]

finalParameters

Values to set.

Definition at line 66 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_CurrentTransformValues, FREE::ComponentAdaptorBase::m_pComponent, and throwExceptionMacro.

Referenced by FREE::ClosedFormRegistrationProcessor< VImageDimension >::ComputeRegistration().

ParameterArrayType FREE::TransformSetupAdaptor::GetCurrentTransformParameters

(

)

const

Function to access the parameters with the key FinalTransformValues.

Returns:

Array of the parameter value.

Definition at line 78 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_CurrentTransformValues, FREE::ComponentAdaptorBase::m_pComponent, and throwExceptionMacro.

Referenced by FREE::MultiRigidRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::SingleRigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::ComputeRegistration(), and FREE::PointSetRegistrationProcessor< VImageDimension >::ComputeRegistration().

void FREE::TransformSetupAdaptor::SetScales

(

ParameterArrayType

newScales

)

Function to set the parameters with the key TransformScales. The parameter will be created, with the construction of the TransformSetup.

Parameters:

[in]

newScales

Values to set.

Definition at line 96 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_TransformScale, FREE::ComponentAdaptorBase::m_pComponent, and throwExceptionMacro.

ParameterArrayType FREE::TransformSetupAdaptor::GetScales

(

const int

iLevel

)

const

Function to access the parameters with the key TransformScales.

Parameters:

[in]

iLevel

defines the level of the scale.

Returns:

Array of the parameter value.

Definition at line 108 of file freTransformSetupAdaptor.cxx.

References FREE::cParam_TransformScale, FREE::Parameter::LayerCount(), FREE::ComponentAdaptorBase::m_pComponent, FREE::Parameter::ParameterSize(), and throwExceptionMacro.

Referenced by FREE::ConjugateGradientOptimizerController::ActualizeMainComponent().

Here is the call graph for this function:

ComponentSetup * FREE::TransformSetupAdaptor::Adapt

(

ComponentSetup *

pComponent

)

[virtual]

The function takes the passed ComponentSetup resets it and adds the basic parameters. After the adaptation the component becomes the current component of the adaptor and is the return of the function.

Parameters:

[in,out]

pComponent

Pointer to the component that should be adapted.

Returns:

Pointer to the adapted setup component. (The return is equal to pComponent)

Reimplemented from FREE::ComponentAdaptorBase.

Definition at line 135 of file freTransformSetupAdaptor.cxx.

References FREE::ComponentAdaptorBase::Adapt(), FREE::cParam_InitialisationMethod, FREE::cParam_InitialTransformValues, FREE::cParam_TransformScale, and FREE::ComponentAdaptorBase::m_pComponent.

Here is the call graph for this function:

---

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

• freTransformSetupAdaptor.h
• freTransformSetupAdaptor.cxx

---