FREE::SetupParameterTraits Class Reference
[Setup utilities]

Defines the traits of parameter values used in a setup optimization. More...

#include <freSetupParameterTraits.h>

List of all members.

Public Types
typedef Parameter::ParameterValueType	ParameterType
Public Member Functions
virtual const char *	GetNameOfClass () const
double	InitialValue (void) const
double	UpperBound (void) const
double	LowerBound (void) const
double	Quantisation (void) const
bool	IsBoundedBelow (void) const
bool	IsBoundedAbove (void) const
bool	IsBounded (void) const
bool	ValueIsValid (double dValue) const
ParameterType	GetParameterType (void) const
	SetupParameterTraits (double dInitialValue=0.0, ParameterType parameterType=Parameter::PVTDouble, double dLowerBound=itk::NumericTraits< double >::NonpositiveMin(), bool bBoundedBelow=false, double dUpperBound=itk::NumericTraits< double >::max(), bool bBoundedAbove=false, double dQuantisation=0.0)
Protected Attributes
bool	m_bBoundedBelow
bool	m_bBoundedAbove
double	m_dInitialValue
double	m_dUpperBound
double	m_dLowerBound
double	m_dQuantisation
ParameterType	m_ParameterType

---

Detailed Description

Defines the traits of parameter values used in a setup optimization.

The SetupParameterTraits is used by SetupTransform or derivates to specifies the traits of a value. It also offers setup optimizer to include these traits in the optimization process.

Definition at line 42 of file freSetupParameterTraits.h.

---

Member Typedef Documentation

typedef Parameter::ParameterValueType FREE::SetupParameterTraits::ParameterType

Definition at line 45 of file freSetupParameterTraits.h.

---

Constructor & Destructor Documentation

FREE::SetupParameterTraits::SetupParameterTraits	(	double	dInitialValue = 0.0,
		ParameterType	parameterType = Parameter::PVTDouble,
		double	dLowerBound = itk::NumericTraits< double >::NonpositiveMin(),
		bool	bBoundedBelow = false,
		double	dUpperBound = itk::NumericTraits< double >::max(),
		bool	bBoundedAbove = false,
		double	dQuantisation = 0.0
	)

Definition at line 57 of file freSetupParameterTraits.cxx.

References m_bBoundedBelow, m_dInitialValue, m_dLowerBound, m_dQuantisation, m_dUpperBound, m_ParameterType, and throwExceptionMacro.

---

Member Function Documentation

virtual const char* FREE::SetupParameterTraits::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 47 of file freSetupParameterTraits.h.

double FREE::SetupParameterTraits::InitialValue

(

void

)

const [inline]

The initial value of the parameter defined for the SetupTransform.

Definition at line 50 of file freSetupParameterTraits.h.

References m_dInitialValue.

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

double FREE::SetupParameterTraits::UpperBound

(

void

)

const [inline]

The upper bound of the parameter value.

Definition at line 53 of file freSetupParameterTraits.h.

References m_dUpperBound.

double FREE::SetupParameterTraits::LowerBound

(

void

)

const [inline]

The lower bound of the parameter value.

Definition at line 56 of file freSetupParameterTraits.h.

References m_dLowerBound.

double FREE::SetupParameterTraits::Quantisation

(

void

)

const [inline]

The quantisiation of the value. The initial value should only changed by integral multiple of the quantisation; otherwise it is not a valid value for the parameter anymore (0.0 indicates a normal float value). Only values greater or equal 0.0 are alowed. Intialization with negative values will cause an exception.

Definition at line 63 of file freSetupParameterTraits.h.

References m_dQuantisation.

bool FREE::SetupParameterTraits::IsBoundedBelow

(

void

)

const [inline]

Indicates if value is bounded below.

Definition at line 66 of file freSetupParameterTraits.h.

References m_bBoundedBelow.

bool FREE::SetupParameterTraits::IsBoundedAbove

(

void

)

const [inline]

Indicates if value is bounded above.

Definition at line 69 of file freSetupParameterTraits.h.

References m_bBoundedAbove.

bool FREE::SetupParameterTraits::IsBounded

(

void

)

const [inline]

Indicates if value is bounded.

Definition at line 72 of file freSetupParameterTraits.h.

References m_bBoundedAbove, and m_bBoundedBelow.

bool FREE::SetupParameterTraits::ValueIsValid

(

double

dValue

)

const

Implementation of FREE::SetupParameterTraits ///////////////////////

Definition at line 37 of file freSetupParameterTraits.cxx.

References m_dLowerBound, m_dQuantisation, and m_dUpperBound.

ParameterType FREE::SetupParameterTraits::GetParameterType

(

void

)

const [inline]

Definition at line 76 of file freSetupParameterTraits.h.

References m_ParameterType.

---

Member Data Documentation

bool FREE::SetupParameterTraits::m_bBoundedBelow [protected]

Definition at line 84 of file freSetupParameterTraits.h.

Referenced by IsBounded(), IsBoundedBelow(), and SetupParameterTraits().

bool FREE::SetupParameterTraits::m_bBoundedAbove [protected]

Definition at line 85 of file freSetupParameterTraits.h.

Referenced by IsBounded(), and IsBoundedAbove().

double FREE::SetupParameterTraits::m_dInitialValue [protected]

Definition at line 86 of file freSetupParameterTraits.h.

Referenced by InitialValue(), and SetupParameterTraits().

double FREE::SetupParameterTraits::m_dUpperBound [protected]

Definition at line 87 of file freSetupParameterTraits.h.

Referenced by SetupParameterTraits(), UpperBound(), and ValueIsValid().

double FREE::SetupParameterTraits::m_dLowerBound [protected]

Definition at line 88 of file freSetupParameterTraits.h.

Referenced by LowerBound(), SetupParameterTraits(), and ValueIsValid().

double FREE::SetupParameterTraits::m_dQuantisation [protected]

Definition at line 89 of file freSetupParameterTraits.h.

Referenced by Quantisation(), SetupParameterTraits(), and ValueIsValid().

ParameterType FREE::SetupParameterTraits::m_ParameterType [protected]

Definition at line 90 of file freSetupParameterTraits.h.

Referenced by GetParameterType(), and SetupParameterTraits().

---

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

• freSetupParameterTraits.h
• freSetupParameterTraits.cxx

---