FREE::ConstrainedAccuracySOMetric< VImageDimension > Class Template Reference
[Setup optimization metric]

This class is a metric which evaluates setups with respect of there accuracy. More...

#include <freConstrainedAccuracySOMetric.h>

Inheritance diagram for FREE::ConstrainedAccuracySOMetric< VImageDimension >:

Inheritance graph
FREE::AccuracySOMetric\< VImageDimension \>FREE::SetupOptimizationMultiThreadMetric\< FREE::AccuracySOMetricMonitor, FREE::AccuracySOMetricThread\< VImageDimension \> \>FREE::SetupOptimizationMetricFREE::ConstrainedMetricInterface
[legend]
Collaboration diagram for FREE::ConstrainedAccuracySOMetric< VImageDimension >:

Collaboration graph
FREE::AccuracySOMetric\< VImageDimension \>FREE::ProgressEvent\< Self \>FREE::SetupOptimizationMultiThreadMetric\< FREE::AccuracySOMetricMonitor, FREE::AccuracySOMetricThread\< VImageDimension \> \>FREE::SetupOptimizationMetricFREE::StatisticsFREE::XMLStreamObjectFREE::IDPathFREE::ProgressEventBaseFREE::NotificationEventBaseFREE::ConstrainedMetricInterfaceFREE::SetupParameterConstraintsFREE::SmartCollectionBase\< FREE::SetupParameterConstraint \>FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>
[legend]

List of all members.

Public Types

typedef
ConstrainedAccuracySOMetric
< VImageDimension > 
Self
typedef
AccuracySOMetric
< VImageDimension > 
Superclass
typedef
itk::SmartPointer
< Self
Pointer
typedef
itk::SmartPointer
< const Self
ConstPointer
typedef
Superclass::DecomposedMeasureType 
DecomposedMeasureType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual
::itk::LightObject::Pointer 
CreateAnother (void) const
virtual unsigned int GetNumberOfValues (void) const

Static Public Member Functions

static Pointer New (void)

Protected Types

typedef
SetupOptimizationMetric::ParametersType 
ParametersType

Protected Member Functions

 ConstrainedAccuracySOMetric ()
virtual
DecomposedMeasureType 
ComputeDecomposedValue (const ParametersType &parameters) const

Private Member Functions

 ConstrainedAccuracySOMetric (const Self &)
void operator= (const Self &)


Detailed Description

template<unsigned int VImageDimension>
class FREE::ConstrainedAccuracySOMetric< VImageDimension >

This class is a metric which evaluates setups with respect of there accuracy.

ConstrainedAccuracySOMetric is used to estimate the accuracy of a registration by two options:
1. comparing resulting deformation fields with given reference deformation fields. The reference field of every adaptation must be stored in a media container. The IDPath to this media can be set via ReferenceFieldPath parameter.
2. by using the resulting deformation field to check if reference points of the moving image match the points of the reference. The IDPath to both media can be set via ReferencePointPath and MovingPointPath.
In addition to the normal AccuracySOMetric, the basic objective function can be modified by additional constraints, which will also produce metric values and are handled as barrier functions.
Equality constraints will result 0 as long as the constraint is met. Otherwise they will result MaxConstraintPenalty.
Inequality constraints will be transformed to an inequality greater or equal zero (c(x)>= 0). The BarrierSize indicates the size of the region in front of the border of the legal value range. The barrier function is modelled by log(c(x)/BarrierSize). Example:
The given constraint is 500<= param_1. Its barriersize is 50, so the barrier region is between 500 and 550.
The constraint will be transformed in 0 <= param_1 - 500. The barrier function will be 0 for any param_1 > 550 and min(-log((param_1 - 500)/50), MaxConstraintPenalty) for any other value of param_1.
The Metric has multiple metric values as return:

Remarks:
This version of an accuracy metric is very useful if you want to regard several constraints while optimizing, but the optimizer supports no constraints by default (e.g. amoeba simplex optimizer or Powell optimizer). This metric bypasses this problem by adding the constraints as boundary functions to the cost functions as additional metric values.

Definition at line 85 of file freConstrainedAccuracySOMetric.h.


Member Typedef Documentation

template<unsigned int VImageDimension>
typedef ConstrainedAccuracySOMetric<VImageDimension> FREE::ConstrainedAccuracySOMetric< VImageDimension >::Self

Standard class typedefs.

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 90 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
typedef AccuracySOMetric<VImageDimension> FREE::ConstrainedAccuracySOMetric< VImageDimension >::Superclass

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 91 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
typedef itk::SmartPointer<Self> FREE::ConstrainedAccuracySOMetric< VImageDimension >::Pointer

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 92 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
typedef itk::SmartPointer<const Self> FREE::ConstrainedAccuracySOMetric< VImageDimension >::ConstPointer

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 93 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
typedef Superclass::DecomposedMeasureType FREE::ConstrainedAccuracySOMetric< VImageDimension >::DecomposedMeasureType

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 94 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
typedef SetupOptimizationMetric::ParametersType FREE::ConstrainedAccuracySOMetric< VImageDimension >::ParametersType [protected]

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

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 100 of file freConstrainedAccuracySOMetric.h.


Constructor & Destructor Documentation

template<unsigned int VImageDimension>
FREE::ConstrainedAccuracySOMetric< VImageDimension >::ConstrainedAccuracySOMetric (  )  [inline, protected]

Definition at line 65 of file freConstrainedAccuracySOMetric.txx.

References FREE::ConstrainedMetricInterface::m_MaxConstraintPenalty, and FREE::ConstrainedMetricInterface::ResetConstraints().

Here is the call graph for this function:

FREE::ConstrainedMetricInterface::ResetConstraintsFREE::CollectionBase::Reset

template<unsigned int VImageDimension>
FREE::ConstrainedAccuracySOMetric< VImageDimension >::ConstrainedAccuracySOMetric ( const Self  )  [private]


Member Function Documentation

template<unsigned int VImageDimension>
virtual const char* FREE::ConstrainedAccuracySOMetric< VImageDimension >::GetNameOfClass (  )  const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 96 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
static Pointer FREE::ConstrainedAccuracySOMetric< VImageDimension >::New ( void   )  [inline, static]

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 98 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
virtual ::itk::LightObject::Pointer FREE::ConstrainedAccuracySOMetric< VImageDimension >::CreateAnother ( void   )  const [inline, virtual]

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 98 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
virtual unsigned int FREE::ConstrainedAccuracySOMetric< VImageDimension >::GetNumberOfValues ( void   )  const [inline, virtual]

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

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.

Definition at line 100 of file freConstrainedAccuracySOMetric.h.

template<unsigned int VImageDimension>
ConstrainedAccuracySOMetric< VImageDimension >::DecomposedMeasureType FREE::ConstrainedAccuracySOMetric< VImageDimension >::ComputeDecomposedValue ( const ParametersType parameters  )  const [inline, protected, virtual]

Definition at line 33 of file freConstrainedAccuracySOMetric.txx.

References FREE::ConstrainedMetricInterface::ComputeConstraintPenalties(), and FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >::ComputeDecomposedValue().

Here is the call graph for this function:

FREE::ConstrainedMetricInterface::ComputeConstraintPenaltiesFREE::SetupOptimizationMultiThreadMetric::ComputeDecomposedValueFREE::ConstrainedMetricInterface::ComputeConstraintPenaltyFREE::CollectionBase::SizeFREE::SetupParameterConstraint::GetConstraintTermFREE::SetupParameterConstraint::GetDestinationIDFREE::SmartCollectionBase::GetElementFREE::SetupParameterConstraint::GetRelationTypeFREE::LogExceptionFREE::Convert::ToStrFREE::LogFileController::AddDirectEntryFREE::LogFileController::AddEntryFREE::LogFileController::StartLogFREE::LogFileController::StopLogFREE::ActTimeStampToStrFREE::LogFileController::OpenLogFileFREE::LogFileController::CloseLogFileFREE::SetupOptimizationMultiThreadMetric::ComputeMeasureFREE::SetupOptimizationMultiThreadMetric::InitializeMonitorFREE::SetupOptimizationMultiThreadMetric::InitializeThreadFREE::SetupOptimizationMultiThreadMetric::InitializeValueComputation

template<unsigned int VImageDimension>
void FREE::ConstrainedAccuracySOMetric< VImageDimension >::operator= ( const Self  )  [private]

Reimplemented from FREE::AccuracySOMetric< VImageDimension >.


The documentation for this class was generated from the following files:
Generated at Sat Oct 13 18:17:47 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000