FREE::SetupTransform Class Reference
[Transformation controller, Setup optimization transform, Setup utilities]

This class is used to adapt/transform setups in an itk::Transform manner. More...

#include <freSetupTransform.h>

Inheritance diagram for FREE::SetupTransform:

[legend]

Collaboration diagram for FREE::SetupTransform:

[legend]

List of all members.

Public Types
typedef SetupTransform	Self
typedef itk::TransformBase	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef std::vector < SetupParameterTraits >	ParameterTraitsList
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual unsigned int	GetNumberOfParameters (void) const
virtual unsigned int	GetInputSpaceDimension (void) const
virtual unsigned int	GetOutputSpaceDimension (void) const
virtual void	SetParameters (const ParametersType &p)
virtual void	SetParametersByValue (const ParametersType &p)
void	SetParametersDirectly (const ParametersType &p)
virtual void	SetFixedParameters (const ParametersType &p)
virtual const ParametersType &	GetParameters (void) const
virtual const ParametersType &	GetFixedParameters () const
ParameterTraitsList	ComputeParametersTraits (const ParametersType &p) const
virtual ParameterTraitsList	ComputeParametersTraits (const ParametersType &p, ParametersType &validP) const
const ParameterTraitsList &	GetParametersTraits (void)
virtual std::string	GetTransformTypeAsString () const
Setup::Pointer	GenerateTransformedSetup ()
void	SetAutoInitialValues (bool bAutoValues)
bool	GetAutoInitialValues ()
void	SetReferenceSetup (Setup *pSetup)
void	ResetParameterIDs ()
void	AddParameterID (const IDPath &idPath)
Static Public Member Functions
static Pointer	New (void)
Protected Types
typedef std::vector < IDPath >	ParameterIDsType
Protected Member Functions
	SetupTransform ()
virtual	~SetupTransform ()
virtual void	TransformSetup ()
virtual void	GetInitialValues ()
Parameter::ParameterValueType	GetParameterValueType (const IDPath &paramID) const
Protected Attributes
Setup *	m_pReferenceSetup
Setup::Pointer	m_smpTransformedSetup
ParameterIDsType	m_ParameterIDs
ParametersType	m_Parameters
bool	m_bAutoInitialValue
ParameterTraitsList	m_ParameterTraits
bool	m_bTraitsInitialized

---

Detailed Description

This class is used to adapt/transform setups in an itk::Transform manner.

The SetupTransform is used to adapt/transform a setup in an itk:Transform manner. An arbitrary number of Parameters can be defined by IDPathes. SetParameters and GetParameters access these parts of the setup and treat them as a ParametersType.

Definition at line 43 of file freSetupTransform.h.

---

Member Typedef Documentation

typedef SetupTransform FREE::SetupTransform::Self

Standard class typedefs.

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 47 of file freSetupTransform.h.

typedef itk::TransformBase FREE::SetupTransform::Superclass

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 48 of file freSetupTransform.h.

typedef itk::SmartPointer< Self > FREE::SetupTransform::Pointer

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 49 of file freSetupTransform.h.

typedef itk::SmartPointer< const Self > FREE::SetupTransform::ConstPointer

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 50 of file freSetupTransform.h.

typedef Superclass::ParametersType FREE::SetupTransform::ParametersType

Type of the input parameters.

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 53 of file freSetupTransform.h.

typedef std::vector<SetupParameterTraits> FREE::SetupTransform::ParameterTraitsList

Definition at line 55 of file freSetupTransform.h.

typedef std::vector<IDPath> FREE::SetupTransform::ParameterIDsType [protected]

Definition at line 127 of file freSetupTransform.h.

---

Constructor & Destructor Documentation

FREE::SetupTransform::SetupTransform

(

)

[protected]

Definition at line 217 of file freSetupTransform.cxx.

References m_bAutoInitialValue, m_bTraitsInitialized, m_Parameters, m_pReferenceSetup, and m_smpTransformedSetup.

FREE::SetupTransform::~SetupTransform

(

)

[protected, virtual]

Definition at line 227 of file freSetupTransform.cxx.

---

Member Function Documentation

virtual const char* FREE::SetupTransform::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 58 of file freSetupTransform.h.

Referenced by GetTransformTypeAsString().

static Pointer FREE::SetupTransform::New

(

void

)

[inline, static]

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 60 of file freSetupTransform.h.

virtual ::itk::LightObject::Pointer FREE::SetupTransform::CreateAnother

(

void

)

const [inline, virtual]

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 60 of file freSetupTransform.h.

unsigned int FREE::SetupTransform::GetNumberOfParameters

(

void

)

const [virtual]

Return the number of parameters that completely define the Transfom

Implementation of FREE::SetupTransform /////////////////////////////

Definition at line 39 of file freSetupTransform.cxx.

References m_ParameterIDs.

Referenced by AddParameterID(), GenerateTransformedSetup(), ResetParameterIDs(), SetFixedParameters(), SetParameters(), and SetParametersDirectly().

unsigned int FREE::SetupTransform::GetInputSpaceDimension

(

void

)

const [virtual]

Get the size of the input space

Definition at line 53 of file freSetupTransform.cxx.

unsigned int FREE::SetupTransform::GetOutputSpaceDimension

(

void

)

const [virtual]

Get the size of the output space

Definition at line 60 of file freSetupTransform.cxx.

void FREE::SetupTransform::SetParameters

(

const ParametersType &

p

)

[virtual]

Set the transformation parameters and validation of the parameter regarding their traits.

Definition at line 67 of file freSetupTransform.cxx.

References ComputeParametersTraits(), GetNumberOfParameters(), m_bTraitsInitialized, m_Parameters, m_ParameterTraits, and throwExceptionMacro.

Referenced by FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::ActualizeMainComponent(), FREE::ConstrainedSetupTransformController::ActualizeMainComponent(), GetInitialValues(), and SetParametersByValue().

Here is the call graph for this function:

void FREE::SetupTransform::SetParametersByValue

(

const ParametersType &

p

)

[virtual]

Definition at line 86 of file freSetupTransform.cxx.

References SetParameters().

Here is the call graph for this function:

void FREE::SetupTransform::SetParametersDirectly

(

const ParametersType &

p

)

Transform doesn't ensure the validity of the passed parameter and sets the values without checking. Ensure valid values or otherwise sensibility of the transform cannot be guranteed.

Definition at line 76 of file freSetupTransform.cxx.

References ComputeParametersTraits(), GetNumberOfParameters(), m_bTraitsInitialized, m_Parameters, m_ParameterTraits, and throwExceptionMacro.

Here is the call graph for this function:

void FREE::SetupTransform::SetFixedParameters

(

const ParametersType &

p

)

[virtual]

Set the fixed parameters.

Definition at line 93 of file freSetupTransform.cxx.

References ComputeParametersTraits(), GetNumberOfParameters(), m_bTraitsInitialized, m_Parameters, m_ParameterTraits, and throwExceptionMacro.

Here is the call graph for this function:

const SetupTransform::ParametersType & FREE::SetupTransform::GetParameters

(

void

)

const [virtual]

Get the Transformation Parameters.

Definition at line 46 of file freSetupTransform.cxx.

References m_Parameters.

const SetupTransform::ParametersType & FREE::SetupTransform::GetFixedParameters

(

)

const [virtual]

Get the fixed parameters.

Definition at line 102 of file freSetupTransform.cxx.

References m_Parameters.

SetupTransform::ParameterTraitsList FREE::SetupTransform::ComputeParametersTraits

(

const ParametersType &

p

)

const

Computes the traits of all parameters regarding the passed values if needed.

Definition at line 109 of file freSetupTransform.cxx.

Referenced by GetParametersTraits(), SetFixedParameters(), SetParameters(), and SetParametersDirectly().

SetupTransform::ParameterTraitsList FREE::SetupTransform::ComputeParametersTraits	(	const ParametersType &	p,
		ParametersType &	validP
	)			const [virtual]

Computes the traits of all parameters regarding the passed values and also returns the corrected parameter values.

Reimplemented in FREE::ConstrainedSetupTransform.

Definition at line 117 of file freSetupTransform.cxx.

References GetParameterValueType(), m_ParameterIDs, m_Parameters, m_pReferenceSetup, FREE::Parameter::PVTInteger, FREE::Parameter::PVTLong, FREE::Parameter::PVTULong, and throwExceptionMacro.

Here is the call graph for this function:

const SetupTransform::ParameterTraitsList & FREE::SetupTransform::GetParametersTraits

(

void

)

Return the parameter traits of the current parameter set.

Definition at line 142 of file freSetupTransform.cxx.

References ComputeParametersTraits(), m_bTraitsInitialized, m_Parameters, and m_ParameterTraits.

Here is the call graph for this function:

std::string FREE::SetupTransform::GetTransformTypeAsString

(

)

const [virtual]

Generate a platform independant name

Definition at line 155 of file freSetupTransform.cxx.

References GetNameOfClass().

Here is the call graph for this function:

Setup::Pointer FREE::SetupTransform::GenerateTransformedSetup

(

)

Generate the transformed setup and returns it

Definition at line 162 of file freSetupTransform.cxx.

References GetNumberOfParameters(), m_Parameters, m_pReferenceSetup, m_smpTransformedSetup, throwExceptionMacro, and TransformSetup().

Here is the call graph for this function:

void FREE::SetupTransform::SetAutoInitialValues

(

bool

bAutoValues

)

Set the auto initial value.

Definition at line 175 of file freSetupTransform.cxx.

References m_bAutoInitialValue.

Referenced by FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::ActualizeMainComponent(), and FREE::ConstrainedSetupTransformController::ActualizeMainComponent().

bool FREE::SetupTransform::GetAutoInitialValues

(

)

Get the auto initial value.

Definition at line 182 of file freSetupTransform.cxx.

References m_bAutoInitialValue.

void FREE::SetupTransform::SetReferenceSetup

(

Setup *

pSetup

)

Set the reference setup.

Definition at line 189 of file freSetupTransform.cxx.

References GetInitialValues(), m_bAutoInitialValue, and m_pReferenceSetup.

Here is the call graph for this function:

void FREE::SetupTransform::ResetParameterIDs

(

)

Resets the list of parameters, that should be changed by the transform.

Definition at line 197 of file freSetupTransform.cxx.

References GetNumberOfParameters(), m_bTraitsInitialized, m_ParameterIDs, and m_Parameters.

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

Here is the call graph for this function:

void FREE::SetupTransform::AddParameterID

(

const IDPath &

idPath

)

Add a Parameter to the list of parameter to be transformed.

Definition at line 207 of file freSetupTransform.cxx.

References GetNumberOfParameters(), m_bTraitsInitialized, m_ParameterIDs, and m_Parameters.

Referenced by FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::ActualizeMainComponent(), and FREE::ConstrainedSetupTransformController::ActualizeMainComponent().

Here is the call graph for this function:

void FREE::SetupTransform::TransformSetup

(

)

[protected, virtual]

Definition at line 231 of file freSetupTransform.cxx.

References FREE::cIDPRoot, m_ParameterIDs, m_Parameters, m_smpTransformedSetup, and FREE::Setup::New().

Referenced by GenerateTransformedSetup().

Here is the call graph for this function:

void FREE::SetupTransform::GetInitialValues

(

)

[protected, virtual]

Definition at line 257 of file freSetupTransform.cxx.

References FREE::cIDPRoot, FREE::Setup::GetComponentByIDPath(), m_ParameterIDs, m_pReferenceSetup, and SetParameters().

Referenced by SetReferenceSetup().

Here is the call graph for this function:

Parameter::ParameterValueType FREE::SetupTransform::GetParameterValueType

(

const IDPath &

paramID

)

const [protected]

Definition at line 284 of file freSetupTransform.cxx.

References FREE::ComponentSetup::ControllerIsAssigned(), FREE::Setup::GetComponentByIDPath(), FREE::ControllerCentral::GetController(), FREE::ComponentSetup::GetControllerID(), FREE::IDPath::GetParameterName(), FREE::IDPath::GetParentComponentIDPath(), FREE::ComponentControllerInterface::GetProfile(), m_pReferenceSetup, throwExceptionMacro, and FREE::IDPath::ToStr().

Referenced by ComputeParametersTraits().

Here is the call graph for this function:

---

Member Data Documentation

Setup* FREE::SetupTransform::m_pReferenceSetup [protected]

Definition at line 124 of file freSetupTransform.h.

Referenced by ComputeParametersTraits(), GenerateTransformedSetup(), GetInitialValues(), GetParameterValueType(), SetReferenceSetup(), and SetupTransform().

Setup::Pointer FREE::SetupTransform::m_smpTransformedSetup [protected]

Definition at line 125 of file freSetupTransform.h.

Referenced by GenerateTransformedSetup(), SetupTransform(), and TransformSetup().

ParameterIDsType FREE::SetupTransform::m_ParameterIDs [protected]

Definition at line 129 of file freSetupTransform.h.

Referenced by AddParameterID(), ComputeParametersTraits(), FREE::ConstrainedSetupTransform::ComputeParametersTraits(), GetInitialValues(), GetNumberOfParameters(), ResetParameterIDs(), and TransformSetup().

ParametersType FREE::SetupTransform::m_Parameters [protected]

Definition at line 131 of file freSetupTransform.h.

Referenced by AddParameterID(), ComputeParametersTraits(), FREE::ConstrainedSetupTransform::ComputeParametersTraits(), GenerateTransformedSetup(), GetFixedParameters(), GetParameters(), GetParametersTraits(), ResetParameterIDs(), SetFixedParameters(), SetParameters(), SetParametersDirectly(), SetupTransform(), and TransformSetup().

bool FREE::SetupTransform::m_bAutoInitialValue [protected]

Definition at line 132 of file freSetupTransform.h.

Referenced by GetAutoInitialValues(), SetAutoInitialValues(), SetReferenceSetup(), and SetupTransform().

ParameterTraitsList FREE::SetupTransform::m_ParameterTraits [protected]

Definition at line 134 of file freSetupTransform.h.

Referenced by GetParametersTraits(), SetFixedParameters(), SetParameters(), and SetParametersDirectly().

bool FREE::SetupTransform::m_bTraitsInitialized [mutable, protected]

Definition at line 135 of file freSetupTransform.h.

Referenced by FREE::ConstrainedSetupTransform::AddParameterConstraint(), AddParameterID(), GetParametersTraits(), FREE::ConstrainedSetupTransform::ResetParameterConstraints(), ResetParameterIDs(), SetFixedParameters(), SetParameters(), SetParametersDirectly(), and SetupTransform().

---

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

• freSetupTransform.h
• freSetupTransform.cxx

---