FREE::SetupParameterConstraint Class Reference
[Setup utilities]

Defines a constraint of a setup parameter that should be regarded within the transformation. More...

#include <freSetupParameterConstraint.h>

List of all members.

Public Types
enum	RelationType { RTEqual = 0, RTLesserOrEqual = 1, RTGreaterOrEqual = 2 }
typedef SetupParameterConstraint	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef int	ParameterIDType
typedef std::vector < ParameterIDType >	ParameterIDsType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
ParameterIDType	GetDestinationID (void) const
RelationType	GetRelationType (void) const
const std::string &	GetConstraintTerm (void) const
const ParameterIDsType &	GetConstraintParameters () const
SetupParameterConstraint &	operator= (const SetupParameterConstraint &constraint)
Static Public Member Functions
static Pointer	New (void)
static Pointer	New (ParameterIDType destinationID, RelationType relation, const std::string sTerm)
Protected Member Functions
	SetupParameterConstraint (ParameterIDType destinationID, RelationType relation, const std::string sTerm)
	SetupParameterConstraint ()
ParameterIDsType	ParseTermForParameters (const std::string &sTerm) const
Protected Attributes
ParameterIDType	m_DestinationID
RelationType	m_RelationType
std::string	m_sTerm
ParameterIDsType	m_ConstraintParameters
Private Member Functions
	SetupParameterConstraint (const SetupParameterConstraint &constraint)

---

Detailed Description

Defines a constraint of a setup parameter that should be regarded within the transformation.

A constraint is always of the form [constraint destination] [relation] [constraint term].
The constraint destination is the parameter ID of the limited parameter. The allowed relations are ==, <= or >=. The constraint term is a string specifying the constraint value as a function or constant. In this function any other parameters can be used. Theire variable name has the form _[ParameterID] (e.g. parameter 4 has the variable name _4).
Example for a constraint:

• constraint destination: 2
  
• relation: <=
  
• constraint term: _3 + _4 * _1
  

Meaning, the second parameter must always be equal or less then the third parameter summed with the product of Parameter 1 and 4.
SetupParameterConstraint only defines a constraint and provides the data. It's up to the SetupTransform to use the constraint.

Definition at line 52 of file freSetupParameterConstraint.h.

---

Member Typedef Documentation

typedef SetupParameterConstraint FREE::SetupParameterConstraint::Self

Definition at line 55 of file freSetupParameterConstraint.h.

typedef itk::LightObject FREE::SetupParameterConstraint::Superclass

Definition at line 56 of file freSetupParameterConstraint.h.

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

Definition at line 57 of file freSetupParameterConstraint.h.

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

Definition at line 58 of file freSetupParameterConstraint.h.

typedef int FREE::SetupParameterConstraint::ParameterIDType

Definition at line 60 of file freSetupParameterConstraint.h.

typedef std::vector<ParameterIDType> FREE::SetupParameterConstraint::ParameterIDsType

Definition at line 61 of file freSetupParameterConstraint.h.

---

Member Enumeration Documentation

enum FREE::SetupParameterConstraint::RelationType

Enumerator:

RTEqual
RTLesserOrEqual
RTGreaterOrEqual

Definition at line 63 of file freSetupParameterConstraint.h.

---

Constructor & Destructor Documentation

FREE::SetupParameterConstraint::SetupParameterConstraint	(	ParameterIDType	destinationID,
		RelationType	relation,
		const std::string	sTerm
	)			[protected]

Implementation of FREE::SetupParameterConstraint ///////////////////

Definition at line 37 of file freSetupParameterConstraint.cxx.

References m_ConstraintParameters, m_DestinationID, m_RelationType, m_sTerm, and ParseTermForParameters().

Here is the call graph for this function:

FREE::SetupParameterConstraint::SetupParameterConstraint

(

)

[protected]

Definition at line 48 of file freSetupParameterConstraint.cxx.

References m_DestinationID, m_RelationType, m_sTerm, and RTEqual.

Referenced by New().

FREE::SetupParameterConstraint::SetupParameterConstraint

(

const SetupParameterConstraint &

constraint

)

[private]

---

Member Function Documentation

virtual const char* FREE::SetupParameterConstraint::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 70 of file freSetupParameterConstraint.h.

static Pointer FREE::SetupParameterConstraint::New

(

void

)

[inline, static]

Definition at line 71 of file freSetupParameterConstraint.h.

Referenced by FREE::ConstrainedSetupTransformController::ActualizeMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::ActualizeMainComponent(), and FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::ActualizeMainComponent().

virtual ::itk::LightObject::Pointer FREE::SetupParameterConstraint::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 71 of file freSetupParameterConstraint.h.

SetupParameterConstraint::Pointer FREE::SetupParameterConstraint::New	(	ParameterIDType	destinationID,
		RelationType	relation,
		const std::string	sTerm
	)			[static]

Definition at line 110 of file freSetupParameterConstraint.cxx.

References SetupParameterConstraint().

Here is the call graph for this function:

ParameterIDType FREE::SetupParameterConstraint::GetDestinationID

(

void

)

const [inline]

The initial value of the parameter defined for the SetupTransform.

Definition at line 75 of file freSetupParameterConstraint.h.

References m_DestinationID.

Referenced by FREE::ConstrainedMetricInterface::ComputeConstraintPenalty(), FREE::SetupParameterConstraints::GetElementsByDestination(), FREE::SetupParameterTraitsGenerator::GetParameterOrder(), and operator=().

RelationType FREE::SetupParameterConstraint::GetRelationType

(

void

)

const [inline]

Definition at line 77 of file freSetupParameterConstraint.h.

References m_RelationType.

Referenced by FREE::ConstrainedMetricInterface::ComputeConstraintPenalty(), and operator=().

const std::string& FREE::SetupParameterConstraint::GetConstraintTerm

(

void

)

const [inline]

Definition at line 79 of file freSetupParameterConstraint.h.

References m_sTerm.

Referenced by FREE::ConstrainedMetricInterface::ComputeConstraintPenalty(), and operator=().

const ParameterIDsType& FREE::SetupParameterConstraint::GetConstraintParameters

(

)

const [inline]

Definition at line 81 of file freSetupParameterConstraint.h.

References m_ConstraintParameters.

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

SetupParameterConstraint & FREE::SetupParameterConstraint::operator=

(

const SetupParameterConstraint &

constraint

)

Definition at line 57 of file freSetupParameterConstraint.cxx.

References GetConstraintTerm(), GetDestinationID(), GetRelationType(), m_ConstraintParameters, m_DestinationID, m_RelationType, m_sTerm, and ParseTermForParameters().

Here is the call graph for this function:

SetupParameterConstraint::ParameterIDsType FREE::SetupParameterConstraint::ParseTermForParameters

(

const std::string &

sTerm

)

const [protected]

Definition at line 72 of file freSetupParameterConstraint.cxx.

References FREE::Convert::ToInt().

Referenced by operator=(), and SetupParameterConstraint().

Here is the call graph for this function:

---

Member Data Documentation

ParameterIDType FREE::SetupParameterConstraint::m_DestinationID [protected]

Definition at line 93 of file freSetupParameterConstraint.h.

Referenced by GetDestinationID(), operator=(), and SetupParameterConstraint().

RelationType FREE::SetupParameterConstraint::m_RelationType [protected]

Definition at line 94 of file freSetupParameterConstraint.h.

Referenced by GetRelationType(), operator=(), and SetupParameterConstraint().

std::string FREE::SetupParameterConstraint::m_sTerm [protected]

Definition at line 95 of file freSetupParameterConstraint.h.

Referenced by GetConstraintTerm(), operator=(), and SetupParameterConstraint().

ParameterIDsType FREE::SetupParameterConstraint::m_ConstraintParameters [protected]

Definition at line 97 of file freSetupParameterConstraint.h.

Referenced by GetConstraintParameters(), operator=(), and SetupParameterConstraint().

---

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

• freSetupParameterConstraint.h
• freSetupParameterConstraint.cxx

---