FREE::SetupParameterTraitsGenerator Class Reference
[Setup utilities]

This class is used to compute the traits of parameters. More...

#include <freSetupParameterTraitsGenerator.h>

Collaboration diagram for FREE::SetupParameterTraitsGenerator:

[legend]

List of all members.

Public Types
typedef SetupParameterTraitsGenerator	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::Array < double >	ParametersType
typedef std::vector < SetupParameterTraits >	ParameterTraitsList
typedef std::vector < Parameter::ParameterValueType >	ParameterTypeList
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual ParameterTraitsList	ComputeParametersTraits (const ParametersType &p, ParametersType &validP) const
virtual ParameterTraitsList	ComputeParametersTraits (const ParameterTypeList &typeList, const ParametersType &p, ParametersType &validP) const
void	AddParameterTypes (const ParameterTypeList &typeList)
void	ResetParameterConstraints ()
void	AddParameterConstraint (const SetupParameterConstraint &constraint)
void	AddParameterConstraints (const SetupParameterConstraints &constraints)
Static Public Member Functions
static Pointer	New (void)
Protected Types
typedef SetupParameterConstraint::ParameterIDsType	ParameterIDsType
typedef SetupParameterConstraints::ElementVectorType	SetupParameterConstraintList
Protected Member Functions
	SetupParameterTraitsGenerator ()
ParameterIDsType	GetParameterOrder () const
SetupParameterTraits	ComputeTraits (const int &iParamID, const Parameter::ParameterValueType &parameterType, const double &dValue, const SetupParameterConstraintList &constraints) const
Protected Attributes
SetupParameterConstraints	m_Constraints
ParameterTypeList	m_ParameterTypes
ParameterIDsType	m_ParameterOrder
ParametersType	m_TempParamValues
unsigned int	m_iNumberOfParameters
bool	m_bTraitsInitialized

---

Detailed Description

This class is used to compute the traits of parameters.

The SetupParameterTraitsGenerator is used to compute the traits of parameters by using given constraints and the current parameter values. It is used e.g. by the constrained setup transform.

Definition at line 43 of file freSetupParameterTraitsGenerator.h.

---

Member Typedef Documentation

typedef SetupParameterTraitsGenerator FREE::SetupParameterTraitsGenerator::Self

Standard class typedefs.

Definition at line 47 of file freSetupParameterTraitsGenerator.h.

typedef itk::LightObject FREE::SetupParameterTraitsGenerator::Superclass

Definition at line 48 of file freSetupParameterTraitsGenerator.h.

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

Definition at line 49 of file freSetupParameterTraitsGenerator.h.

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

Definition at line 50 of file freSetupParameterTraitsGenerator.h.

typedef itk::Array< double > FREE::SetupParameterTraitsGenerator::ParametersType

Type of the input parameters.

Definition at line 53 of file freSetupParameterTraitsGenerator.h.

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

Type of the list of traits.

Definition at line 56 of file freSetupParameterTraitsGenerator.h.

typedef std::vector<Parameter::ParameterValueType> FREE::SetupParameterTraitsGenerator::ParameterTypeList

Definition at line 58 of file freSetupParameterTraitsGenerator.h.

typedef SetupParameterConstraint::ParameterIDsType FREE::SetupParameterTraitsGenerator::ParameterIDsType [protected]

Definition at line 80 of file freSetupParameterTraitsGenerator.h.

typedef SetupParameterConstraints::ElementVectorType FREE::SetupParameterTraitsGenerator::SetupParameterConstraintList [protected]

Definition at line 81 of file freSetupParameterTraitsGenerator.h.

---

Constructor & Destructor Documentation

FREE::SetupParameterTraitsGenerator::SetupParameterTraitsGenerator

(

)

[protected]

Definition at line 66 of file freSetupParameterTraitsGenerator.cxx.

References m_bTraitsInitialized, m_Constraints, and FREE::CollectionBase< TElement, TStorageType >::Reset().

Here is the call graph for this function:

---

Member Function Documentation

virtual const char* FREE::SetupParameterTraitsGenerator::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Definition at line 61 of file freSetupParameterTraitsGenerator.h.

static Pointer FREE::SetupParameterTraitsGenerator::New

(

void

)

[inline, static]

Definition at line 63 of file freSetupParameterTraitsGenerator.h.

Referenced by FREE::ConstrainedSetupTransform::ComputeParametersTraits().

virtual ::itk::LightObject::Pointer FREE::SetupParameterTraitsGenerator::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 63 of file freSetupParameterTraitsGenerator.h.

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

Definition at line 82 of file freSetupParameterTraitsGenerator.cxx.

References m_ParameterTypes, and throwExceptionMacro.

SetupParameterTraitsGenerator::ParameterTraitsList FREE::SetupParameterTraitsGenerator::ComputeParametersTraits	(	const ParameterTypeList &	typeList,
		const ParametersType &	p,
		ParametersType &	validP
	)			const [virtual]

Definition at line 90 of file freSetupParameterTraitsGenerator.cxx.

References ComputeTraits(), FREE::SetupParameterConstraints::GetElementsByDestination(), GetParameterOrder(), FREE::SetupParameterTraits::InitialValue(), m_bTraitsInitialized, m_Constraints, m_iNumberOfParameters, m_ParameterOrder, m_TempParamValues, and throwExceptionMacro.

Here is the call graph for this function:

void FREE::SetupParameterTraitsGenerator::AddParameterTypes

(

const ParameterTypeList &

typeList

)

Definition at line 74 of file freSetupParameterTraitsGenerator.cxx.

References m_ParameterTypes.

void FREE::SetupParameterTraitsGenerator::ResetParameterConstraints

(

)

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

Implementation of FREE::SetupParameterTraitsGenerator /////////////

Definition at line 42 of file freSetupParameterTraitsGenerator.cxx.

References m_bTraitsInitialized, m_Constraints, and FREE::CollectionBase< TElement, TStorageType >::Reset().

Here is the call graph for this function:

void FREE::SetupParameterTraitsGenerator::AddParameterConstraint

(

const SetupParameterConstraint &

constraint

)

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

Definition at line 50 of file freSetupParameterTraitsGenerator.cxx.

References FREE::SmartCollectionBase< TElement >::AddElement(), m_bTraitsInitialized, and m_Constraints.

Here is the call graph for this function:

void FREE::SetupParameterTraitsGenerator::AddParameterConstraints

(

const SetupParameterConstraints &

constraints

)

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

Definition at line 58 of file freSetupParameterTraitsGenerator.cxx.

References FREE::CollectionBase< TElement, TStorageType >::AddElements(), m_bTraitsInitialized, and m_Constraints.

Here is the call graph for this function:

SetupParameterTraitsGenerator::ParameterIDsType FREE::SetupParameterTraitsGenerator::GetParameterOrder

(

)

const [protected]

Definition at line 123 of file freSetupParameterTraitsGenerator.cxx.

References FREE::SetupParameterConstraint::GetConstraintParameters(), FREE::SetupParameterConstraint::GetDestinationID(), FREE::SmartCollectionBase< TElement >::GetElement(), m_Constraints, m_iNumberOfParameters, FREE::CollectionBase< TElement, TStorageType >::Size(), and throwExceptionMacro.

Referenced by ComputeParametersTraits().

Here is the call graph for this function:

SetupParameterTraits FREE::SetupParameterTraitsGenerator::ComputeTraits	(	const int &	iParamID,
		const Parameter::ParameterValueType &	parameterType,
		const double &	dValue,
		const SetupParameterConstraintList &	constraints
	)			const [protected]

Definition at line 197 of file freSetupParameterTraitsGenerator.cxx.

References catchAllNPassMacro, GetClassLocationMacro, FREE::LogException(), m_iNumberOfParameters, m_TempParamValues, FREE::Parameter::PVTInteger, FREE::Parameter::PVTLong, FREE::Parameter::PVTULong, FREE::SetupParameterConstraint::RTEqual, FREE::SetupParameterConstraint::RTGreaterOrEqual, FREE::SetupParameterConstraint::RTLesserOrEqual, throwExceptionMacro, and FREE::Convert::ToStr().

Referenced by ComputeParametersTraits().

Here is the call graph for this function:

---

Member Data Documentation

SetupParameterConstraints FREE::SetupParameterTraitsGenerator::m_Constraints [protected]

Definition at line 92 of file freSetupParameterTraitsGenerator.h.

Referenced by AddParameterConstraint(), AddParameterConstraints(), ComputeParametersTraits(), GetParameterOrder(), ResetParameterConstraints(), and SetupParameterTraitsGenerator().

ParameterTypeList FREE::SetupParameterTraitsGenerator::m_ParameterTypes [protected]

Definition at line 94 of file freSetupParameterTraitsGenerator.h.

Referenced by AddParameterTypes(), and ComputeParametersTraits().

ParameterIDsType FREE::SetupParameterTraitsGenerator::m_ParameterOrder [mutable, protected]

Definition at line 96 of file freSetupParameterTraitsGenerator.h.

Referenced by ComputeParametersTraits().

ParametersType FREE::SetupParameterTraitsGenerator::m_TempParamValues [mutable, protected]

current ParameterValues will stored here, while computing the parameter traits. Needed to provide the data for muParser

Definition at line 100 of file freSetupParameterTraitsGenerator.h.

Referenced by ComputeParametersTraits(), and ComputeTraits().

unsigned int FREE::SetupParameterTraitsGenerator::m_iNumberOfParameters [mutable, protected]

temporary storing the number of parameters, extracted from the passed value vector, when calling ComputeParametersTraits();

Definition at line 104 of file freSetupParameterTraitsGenerator.h.

Referenced by ComputeParametersTraits(), ComputeTraits(), and GetParameterOrder().

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

Indicates if the traits are already evaluated with the current contrains.

Definition at line 107 of file freSetupParameterTraitsGenerator.h.

Referenced by AddParameterConstraint(), AddParameterConstraints(), ComputeParametersTraits(), ResetParameterConstraints(), and SetupParameterTraitsGenerator().

---

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

• freSetupParameterTraitsGenerator.h
• freSetupParameterTraitsGenerator.cxx

---