f.r.e.e. - Flexible Registration and Evaluation Engine: FREE::SetupOptimizationMetric Class Reference

typedef SetupOptimizationMetric FREE::SetupOptimizationMetric::Self

Standard class typedefs.

Definition at line 50 of file freSetupOptimizationMetric.h.

typedef itk::CostFunction FREE::SetupOptimizationMetric::Superclass

Definition at line 51 of file freSetupOptimizationMetric.h.

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

Definition at line 52 of file freSetupOptimizationMetric.h.

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

Definition at line 53 of file freSetupOptimizationMetric.h.

typedef Superclass::ParametersType FREE::SetupOptimizationMetric::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented in FREE::ConstrainedAccuracySOMetric< VImageDimension >, FREE::ConstrainedImageClassificationSOMetric< VImageDimension >, and FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 56 of file freSetupOptimizationMetric.h.

typedef double FREE::SetupOptimizationMetric::MeasureType

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 64 of file freSetupOptimizationMetric.h.

typedef itk::Array<double> FREE::SetupOptimizationMetric::DecomposedMeasureType

Reimplemented in FREE::AccuracySOMetric< VImageDimension >, FREE::ConstrainedAccuracySOMetric< VImageDimension >, FREE::ConstrainedImageClassificationSOMetric< VImageDimension >, FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >, FREE::PrecisionSOMetric< VImageDimension >, FREE::ImageClassificationSOMetric< VImageDimension >, FREE::ImageDifferenceSOMetric< VImageDimension >, and FREE::PrecisionSOMetric< VImageDimension >.

Definition at line 65 of file freSetupOptimizationMetric.h.

typedef itk::Array<double> FREE::SetupOptimizationMetric::DerivativeType

Definition at line 66 of file freSetupOptimizationMetric.h.

typedef itk::Array<double> FREE::SetupOptimizationMetric::MetricScalesType

Definition at line 68 of file freSetupOptimizationMetric.h.

typedef SetupTransform FREE::SetupOptimizationMetric::TransformType

Definition at line 70 of file freSetupOptimizationMetric.h.

typedef TransformType::Pointer FREE::SetupOptimizationMetric::TransformPointer

Definition at line 71 of file freSetupOptimizationMetric.h.

FREE::SetupOptimizationMetric::SetupOptimizationMetric ( ) [protected]

Definition at line 27 of file freSetupOptimizationMetric.cxx.

References fnOnEvaluationDone, fnOnEvaluationFailed, fnOnEvaluationProgress, fnOnNextAdaptation, m_CachedDerivative, m_CachedParameters, m_CachedValues, m_Delta, m_MetricScales, m_smpAdaptations, and m_Transform.

FREE::SetupOptimizationMetric::~SetupOptimizationMetric ( ) [protected, virtual]

Definition at line 43 of file freSetupOptimizationMetric.cxx.

FREE::SetupOptimizationMetric::SetupOptimizationMetric ( const Self & ) [private]

virtual const char* FREE::SetupOptimizationMetric::GetNameOfClass ( ) const [inline, virtual]

Run-time type information (and related methods).

Definition at line 56 of file freSetupOptimizationMetric.h.

virtual void FREE::SetupOptimizationMetric::SetDelta ( const double _arg ) [inline, virtual]

Definition at line 73 of file freSetupOptimizationMetric.h.

virtual double FREE::SetupOptimizationMetric::GetDelta ( ) [inline, virtual]

Definition at line 74 of file freSetupOptimizationMetric.h.

virtual void FREE::SetupOptimizationMetric::SetMetricScales ( const MetricScalesType _arg ) [inline, virtual]

Definition at line 76 of file freSetupOptimizationMetric.h.

virtual const MetricScalesType& FREE::SetupOptimizationMetric::GetMetricScales ( ) const [inline, virtual]

Definition at line 77 of file freSetupOptimizationMetric.h.

SetupOptimizationMetric::MeasureType FREE::SetupOptimizationMetric::GetValue ( const ParametersType & parameters ) const [virtual]

This method returns the value of the cost function corresponding to the specified parameters

Definition at line 86 of file freSetupOptimizationMetric.cxx.

References ComposeValue(), ComputeDecomposedValue(), FREE::Statistics::GetData(), m_CachedParameters, m_CachedValues, m_MetricStatistic, and FREE::StatisticData::Reset().

Here is the call graph for this function:

SetupOptimizationMetric::DecomposedMeasureType FREE::SetupOptimizationMetric::GetDecomposedValue ( const ParametersType & parameters ) const [virtual]

Definition at line 98 of file freSetupOptimizationMetric.cxx.

References ComputeDecomposedValue(), FREE::Statistics::GetData(), m_CachedParameters, m_CachedValues, m_MetricStatistic, and FREE::StatisticData::Reset().

Here is the call graph for this function:

SetupOptimizationMetric::DecomposedMeasureType FREE::SetupOptimizationMetric::GetCurrentDecomposedValue ( ) const

This method returns the last computed values of the cost function

Definition at line 110 of file freSetupOptimizationMetric.cxx.

References m_CachedValues.

Referenced by FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), FREE::ConsistencySOMetricControllerBase< FREE::ConsistencyRegistrationMetric< 2 > >::SetStatisticEntryMainComponent(), and FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent().

SetupOptimizationMetric::MeasureType FREE::SetupOptimizationMetric::GetCurrentValue ( ) const

This method returns the last computed value of the cost function

Definition at line 117 of file freSetupOptimizationMetric.cxx.

References ComposeValue(), and m_CachedValues.

Here is the call graph for this function:

SetupOptimizationMetric::ParametersType FREE::SetupOptimizationMetric::GetCurrentParameters ( ) const

This method returns the parameters of the last computed value

Definition at line 124 of file freSetupOptimizationMetric.cxx.

References m_CachedParameters.

void FREE::SetupOptimizationMetric::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative
	)			const `[virtual]`

Get the derivatives of the match measure.

Definition at line 131 of file freSetupOptimizationMetric.cxx.

References ComputeDecomposedValueAndDerivative(), FREE::Statistics::GetData(), m_CachedDerivative, m_CachedParameters, m_CachedValues, m_MetricStatistic, and FREE::StatisticData::Reset().

Here is the call graph for this function:

void FREE::SetupOptimizationMetric::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	Value,
		DerivativeType &	Derivative
	)			const `[virtual]`

Get value and derivatives for multiple valued optimizers.

Definition at line 143 of file freSetupOptimizationMetric.cxx.

References ComposeValue(), ComputeDecomposedValueAndDerivative(), FREE::Statistics::GetData(), m_CachedDerivative, m_CachedParameters, m_CachedValues, m_MetricStatistic, and FREE::StatisticData::Reset().

Here is the call graph for this function:

virtual unsigned int FREE::SetupOptimizationMetric::GetNumberOfValues ( void ) const [pure virtual]

Return the number of values that are computed by the multivalued cost function. This method MUST be overloaded by derived classes

Implemented in FREE::AccuracySOMetric< VImageDimension >, FREE::ConsistencyRegistrationMetric< VImageDimension >, FREE::ConstrainedAccuracySOMetric< VImageDimension >, FREE::ConstrainedImageClassificationSOMetric< VImageDimension >, FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >, FREE::PrecisionSOMetric< VImageDimension >, FREE::ImageClassificationSOMetric< VImageDimension >, FREE::ImageDifferenceSOMetric< VImageDimension >, and FREE::PrecisionSOMetric< VImageDimension >.

unsigned int FREE::SetupOptimizationMetric::GetNumberOfParameters ( void ) const [virtual]

Return the number of parameters required to compute this cost function.

Definition at line 77 of file freSetupOptimizationMetric.cxx.

References m_Transform.

Referenced by FREE::LimitedAxisAmoebaSOOptimizer::SetCostFunction(), and FREE::AmoebaSOOptimizer::SetCostFunction().

virtual void FREE::SetupOptimizationMetric::SetTransform ( TransformType * _arg ) [inline, virtual]

Connect the Transform.

Definition at line 109 of file freSetupOptimizationMetric.h.

virtual const TransformType* FREE::SetupOptimizationMetric::GetTransform ( ) const [inline, virtual]

Get a pointer to the Transform.

Definition at line 111 of file freSetupOptimizationMetric.h.

Adaptation::AdaptationList * FREE::SetupOptimizationMetric::GetAdaptationList ( ) const

Function to access the member variable m_pAdaptations. m_pAdaptations If not valid/exists the return is NULL.

Definition at line 59 of file freSetupOptimizationMetric.cxx.

References m_smpAdaptations.

void FREE::SetupOptimizationMetric::SetAdaptationList ( Adaptation::AdaptationList * pAdaptations )

Definition at line 66 of file freSetupOptimizationMetric.cxx.

References m_smpAdaptations.

virtual Statistics& FREE::SetupOptimizationMetric::GetMetricStatistic ( ) const [inline, virtual]

Definition at line 118 of file freSetupOptimizationMetric.h.

void FREE::SetupOptimizationMetric::Initialize ( void ) [virtual]

Reimplemented in FREE::PrecisionSOMetric< VImageDimension >.

Definition at line 49 of file freSetupOptimizationMetric.cxx.

References throwExceptionMacro.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::Initialize().

virtual DecomposedMeasureType FREE::SetupOptimizationMetric::ComputeDecomposedValue ( const ParametersType & parameters ) const [protected, pure virtual]

Referenced by GetDecomposedValue(), and GetValue().

void FREE::SetupOptimizationMetric::ComputeDecomposedValueAndDerivative	(	const ParametersType &	parameters,
		DecomposedMeasureType &	Value,
		DerivativeType &	Derivative
	)			const `[protected, virtual]`

Definition at line 160 of file freSetupOptimizationMetric.cxx.

References throwExceptionMacro.

Referenced by GetDerivative(), and GetValueAndDerivative().

SetupOptimizationMetric::MeasureType FREE::SetupOptimizationMetric::ComposeValue ( const DecomposedMeasureType & values ) const [protected]

Definition at line 169 of file freSetupOptimizationMetric.cxx.

References m_MetricScales.

Referenced by GetCurrentValue(), GetValue(), and GetValueAndDerivative().

void FREE::SetupOptimizationMetric::EnlistLastRegistrationEvaluation ( ) const [protected]

void FREE::SetupOptimizationMetric::operator= ( const Self & ) [private]

Reimplemented in FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >, FREE::SetupOptimizationMultiThreadMetric< FREE::ImageDifferenceSOMetricMonitor, FREE::ImageDifferenceSOMetricThread< VImageDimension > >, FREE::SetupOptimizationMultiThreadMetric< FREE::ImageClassificationSOMetricMonitor, FREE::ImageClassificationSOMetricThread< VImageDimension > >, and FREE::SetupOptimizationMultiThreadMetric< FREE::AccuracySOMetricMonitor, FREE::AccuracySOMetricThread< VImageDimension > >.

ProgressEventBase::Pointer FREE::SetupOptimizationMetric::fnOnEvaluationProgress

Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, when any component of the evaluated setup notifies a progress. Depending on the setup, there could be many progress notifications. Status specifies the adaptation ID of the adaptation that has progressed.

Remarks:: You can also use the itk subject/observer design pattern with an itk::IterationEvent.

Definition at line 129 of file freSetupOptimizationMetric.h.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::Initialize(), FREE::PrecisionSOMetric< VImageDimension >::OnEvaluationProgress(), FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::OnMonitorEvaluationProgress(), and SetupOptimizationMetric().

ProgressEventBase::Pointer FREE::SetupOptimizationMetric::fnOnEvaluationDone

Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, whenever an evaluation of an adaption is finished. Status specifies the adaptation ID of the adaptation that was done.

Remarks:: You can also use the itk subject/observer design pattern with an FREE::EvaluationDoneObserverEvent.

Definition at line 136 of file freSetupOptimizationMetric.h.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeDecomposedValue(), FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::OnMonitorEvaluationDone(), and SetupOptimizationMetric().

ProgressEventBase::Pointer FREE::SetupOptimizationMetric::fnOnNextAdaptation

Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, when a new adaptation will be processed by the metric. The Status ID indecats the index of the next adaptation.

Remarks:: You can also use the itk subject/observer design pattern with an FREE::NextAdaptationObserverEvent.

Definition at line 143 of file freSetupOptimizationMetric.h.

Referenced by FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::OnOnMonitorNextAdaptation(), and SetupOptimizationMetric().

ProgressEventBase::Pointer FREE::SetupOptimizationMetric::fnOnEvaluationFailed

Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, whenever a registration is failed. The state ID is the index of the failed adaptation. sComment contains the exception information.

Definition at line 149 of file freSetupOptimizationMetric.h.

Referenced by FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::OnOnMonitorEvaluationFailed(), and SetupOptimizationMetric().

TransformPointer FREE::SetupOptimizationMetric::m_Transform [protected]

Definition at line 155 of file freSetupOptimizationMetric.h.

Referenced by FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::ComputeDecomposedValue(), FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeDecomposedValue(), GetNumberOfParameters(), and SetupOptimizationMetric().

Adaptation::AdaptationList::Pointer FREE::SetupOptimizationMetric::m_smpAdaptations [protected]

Definition at line 156 of file freSetupOptimizationMetric.h.

Referenced by FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::ComputeDecomposedValue(), FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeDecomposedValue(), GetAdaptationList(), SetAdaptationList(), and SetupOptimizationMetric().

IterationEvent<SetupOptimizationMetric>::Pointer FREE::SetupOptimizationMetric::m_IterationEvent [protected]

Reimplemented in FREE::ConsistencyRegistrationMetric< VImageDimension >, and FREE::PrecisionSOMetric< VImageDimension >.

Definition at line 158 of file freSetupOptimizationMetric.h.

MetricScalesType FREE::SetupOptimizationMetric::m_MetricScales [protected]

Definition at line 168 of file freSetupOptimizationMetric.h.

Referenced by ComposeValue(), and SetupOptimizationMetric().

DecomposedMeasureType FREE::SetupOptimizationMetric::m_CachedValues [mutable, protected]

Definition at line 170 of file freSetupOptimizationMetric.h.

Referenced by GetCurrentDecomposedValue(), GetCurrentValue(), GetDecomposedValue(), GetDerivative(), GetValue(), GetValueAndDerivative(), and SetupOptimizationMetric().

DerivativeType FREE::SetupOptimizationMetric::m_CachedDerivative [mutable, protected]

Definition at line 171 of file freSetupOptimizationMetric.h.

Referenced by GetDerivative(), GetValueAndDerivative(), and SetupOptimizationMetric().

ParametersType FREE::SetupOptimizationMetric::m_CachedParameters [mutable, protected]

Definition at line 172 of file freSetupOptimizationMetric.h.

Referenced by GetCurrentParameters(), GetDecomposedValue(), GetDerivative(), GetValue(), GetValueAndDerivative(), and SetupOptimizationMetric().

Statistics FREE::SetupOptimizationMetric::m_MetricStatistic [mutable, protected]

Stores the evaluation results of any adaptation done while computing the metric value. the statistic will be reseted, when a new metric value should be calculated.

Definition at line 177 of file freSetupOptimizationMetric.h.

Referenced by GetDecomposedValue(), GetDerivative(), GetValue(), and GetValueAndDerivative().

double FREE::SetupOptimizationMetric::m_Delta [protected]

Definition at line 179 of file freSetupOptimizationMetric.h.

Referenced by SetupOptimizationMetric().

FREE::SetupOptimizationMetric Class Reference
[Metric controller, Setup optimization metric]

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types
typedef SetupOptimizationMetric	Self
typedef itk::CostFunction	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef double	MeasureType
typedef itk::Array < double >	DecomposedMeasureType
typedef itk::Array < double >	DerivativeType
typedef itk::Array < double >	MetricScalesType
typedef SetupTransform	TransformType
typedef TransformType::Pointer	TransformPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetDelta (const double _arg)
virtual double	GetDelta ()
virtual void	SetMetricScales (const MetricScalesType _arg)
virtual const MetricScalesType &	GetMetricScales () const
virtual MeasureType	GetValue (const ParametersType &parameters) const
virtual DecomposedMeasureType	GetDecomposedValue (const ParametersType &parameters) const
DecomposedMeasureType	GetCurrentDecomposedValue () const
MeasureType	GetCurrentValue () const
ParametersType	GetCurrentParameters () const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
virtual unsigned int	GetNumberOfValues (void) const =0
virtual unsigned int	GetNumberOfParameters (void) const
virtual void	SetTransform (TransformType *_arg)
virtual const TransformType *	GetTransform () const
Adaptation::AdaptationList *	GetAdaptationList () const
void	SetAdaptationList (Adaptation::AdaptationList *pAdaptations)
virtual Statistics &	GetMetricStatistic () const
virtual void	Initialize ()
Public Attributes
ProgressEventBase::Pointer	fnOnEvaluationProgress
ProgressEventBase::Pointer	fnOnEvaluationDone
ProgressEventBase::Pointer	fnOnNextAdaptation
ProgressEventBase::Pointer	fnOnEvaluationFailed
Protected Member Functions
	SetupOptimizationMetric ()
virtual	~SetupOptimizationMetric ()
virtual DecomposedMeasureType	ComputeDecomposedValue (const ParametersType &parameters) const =0
virtual void	ComputeDecomposedValueAndDerivative (const ParametersType &parameters, DecomposedMeasureType &Value, DerivativeType &Derivative) const
MeasureType	ComposeValue (const DecomposedMeasureType &values) const
void	EnlistLastRegistrationEvaluation () const
Protected Attributes
TransformPointer	m_Transform
Adaptation::AdaptationList::Pointer	m_smpAdaptations
IterationEvent < SetupOptimizationMetric > ::Pointer	m_IterationEvent
MetricScalesType	m_MetricScales
DecomposedMeasureType	m_CachedValues
DerivativeType	m_CachedDerivative
ParametersType	m_CachedParameters
Statistics	m_MetricStatistic
double	m_Delta
Private Member Functions
	SetupOptimizationMetric (const Self &)
void	operator= (const Self &)

FREE::SetupOptimizationMetric Class Reference [Metric controller, Setup optimization metric]

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

FREE::SetupOptimizationMetric Class Reference
[Metric controller, Setup optimization metric]