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

This class is a metric evaluating registration setups in respect to there accuracy. More...

#include <freFieldPrecisionSOMetric.h>

Inheritance diagram for FREE::PrecisionSOMetric< VImageDimension >:

[legend]

Collaboration diagram for FREE::PrecisionSOMetric< VImageDimension >:

[legend]

List of all members.

Public Types
typedef PrecisionSOMetric < VImageDimension >	Self
typedef SetupOptimizationMetric	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef Superclass::DecomposedMeasureType	DecomposedMeasureType
typedef PrecisionSOMetric	Self
typedef SetupOptimizationMetric	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
void	SetResultFieldPath (const IDPath &path)
IDPath &	GetResultFieldPath () const
void	SetInterimFieldPath (const std::string &path)
IDPath &	GetInterimFieldPath () const
virtual void	SetSaveInterimOnDisc (const bool _arg)
virtual bool	GetSaveInterimOnDisc ()
virtual void	SetSampleSize (const unsigned long _arg)
virtual unsigned long	GetSampleSize ()
virtual unsigned int	GetNumberOfValues (void) const
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	SetSampleSize (const unsigned long _arg)
virtual unsigned long	GetSampleSize ()
virtual void	SetEvaluationMetric (SetupOptimizationMetric *_arg)
virtual SetupOptimizationMetric *	GetEvaluationMetric ()
virtual void	Initialize ()
virtual unsigned int	GetNumberOfValues (void) const
Static Public Member Functions
static Pointer	New (void)
static Pointer	New (void)
Protected Types
typedef ImageTypes < VImageDimension > ::TransformationFieldType	TransformationFieldType
Protected Member Functions
	PrecisionSOMetric ()
virtual	~PrecisionSOMetric ()
void	OnEvaluationProgress (const long status, const std::string &sComment, void *pSender, long threadID)
virtual DecomposedMeasureType	ComputeDecomposedValue (const ParametersType &parameters) const
	PrecisionSOMetric ()
virtual DecomposedMeasureType	ComputeDecomposedValue (const ParametersType &parameters) const
void	EnlistInterimResultsToStatistic (const unsigned int iIndex, const DecomposedMeasureType &results, StatisticEntry &entry) const
void	EnlistDictionaryEntries (StatisticDictionary &dictionary) const
Protected Attributes
ProgressEvent < PrecisionSOMetric < VImageDimension > >::Pointer	m_IterationEvent
Setup::Pointer	m_smpSetup
double	m_dMinError
double	m_dMaxError
unsigned long	m_lFailedRegistrations
unsigned long	m_lActAdaptation
double	m_dErrorMean
double	m_dErrorVar
IDPath	m_ResultFieldPath
std::string	m_InterimFieldPath
bool	m_SaveInterimOnDisc
unsigned long	m_SampleSize
std::vector < DecomposedMeasureType >	m_Measures
SetupOptimizationMetric::Pointer	m_EvaluationMetric
Private Member Functions
	PrecisionSOMetric (const Self &)
void	operator= (const Self &)
	PrecisionSOMetric (const Self &)
void	operator= (const Self &)

---

Detailed Description

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

This class is a metric evaluating registration setups in respect to there accuracy.

This class is a metric evaluating setups in respect of the percision of their results.

PrecisionSOMetric is used to estimate the percision of a registration. This is done by computing a registration n-times and checking the resulting deformation field for variances. You may define if and where the interim defomration fields will be stored. Also it should be defined via IDPath (ResultFieldPath) where the result field of an adaption can be found.
The Metric has multiple metric values as return:

• absolute mean error (occuring when registrating the whole adaptation list)
• mean error standard deviation
• min absolute error
• max absolute error
• number of failed registration (e.g. all points mapped outside the image, hence metric throws exception)

PrecisionSOMetric is used to estimate the percision of setup results. More precisely the metric utilizes other setup optimization metrics (evaluation metric) and estimates the mean and variance of the measure of these metrics. The computation is done by evaluating the setup n-times and using the measurement results of the metrics. The metric values of this metric depend on the values of the evaluation metric. For each evaluation metric value, the metric has four values:

• mean of the evaluation metric value
• standard deviation of the evaluation metric value
• minimum of the evaluation metric value
• maximum deviation of the evaluation metric value

Definition at line 50 of file freFieldPrecisionSOMetric.h.

---

Member Typedef Documentation

template<unsigned int VImageDimension>

typedef PrecisionSOMetric<VImageDimension> FREE::PrecisionSOMetric< VImageDimension >::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 55 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef SetupOptimizationMetric FREE::PrecisionSOMetric< VImageDimension >::Superclass

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 56 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<Self> FREE::PrecisionSOMetric< VImageDimension >::Pointer

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 57 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<const Self> FREE::PrecisionSOMetric< VImageDimension >::ConstPointer

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 58 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::DecomposedMeasureType FREE::PrecisionSOMetric< VImageDimension >::DecomposedMeasureType

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 60 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef ImageTypes<VImageDimension>::TransformationFieldType FREE::PrecisionSOMetric< VImageDimension >::TransformationFieldType [protected]

Definition at line 84 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef PrecisionSOMetric FREE::PrecisionSOMetric< VImageDimension >::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 55 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef SetupOptimizationMetric FREE::PrecisionSOMetric< VImageDimension >::Superclass

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 56 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<Self> FREE::PrecisionSOMetric< VImageDimension >::Pointer

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 57 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<const Self> FREE::PrecisionSOMetric< VImageDimension >::ConstPointer

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 58 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::DecomposedMeasureType FREE::PrecisionSOMetric< VImageDimension >::DecomposedMeasureType

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 60 of file frePrecisionSOMetric.h.

---

Constructor & Destructor Documentation

template<unsigned int VImageDimension>

FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric

(

)

[inline, protected]

Definition at line 161 of file freFieldPrecisionSOMetric.txx.

References FREE::PrecisionSOMetric< VImageDimension >::m_InterimFieldPath, FREE::PrecisionSOMetric< VImageDimension >::m_IterationEvent, FREE::PrecisionSOMetric< VImageDimension >::m_SaveInterimOnDisc, and FREE::ProgressEvent< T >::New().

Here is the call graph for this function:

template<unsigned int VImageDimension>

virtual FREE::PrecisionSOMetric< VImageDimension >::~PrecisionSOMetric

(

)

[inline, protected, virtual]

Definition at line 84 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric

(

const Self &

)

[private]

template<unsigned int VImageDimension>

FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric

(

)

[protected]

template<unsigned int VImageDimension>

FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int VImageDimension>

virtual const char* FREE::PrecisionSOMetric< VImageDimension >::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 63 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

static Pointer FREE::PrecisionSOMetric< VImageDimension >::New

(

void

)

[inline, static]

Definition at line 65 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual ::itk::LightObject::Pointer FREE::PrecisionSOMetric< VImageDimension >::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 65 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::SetResultFieldPath

(

const IDPath &

path

)

[inline]

Definition at line 41 of file freFieldPrecisionSOMetric.txx.

References FREE::PrecisionSOMetric< VImageDimension >::m_ResultFieldPath, and FREE::IDPath::ToStr().

Here is the call graph for this function:

template<unsigned int VImageDimension>

IDPath& FREE::PrecisionSOMetric< VImageDimension >::GetResultFieldPath

(

)

const [inline]

Definition at line 68 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::SetInterimFieldPath

(

const std::string &

path

)

[inline]

Definition at line 51 of file freFieldPrecisionSOMetric.txx.

References FREE::PrecisionSOMetric< VImageDimension >::m_InterimFieldPath.

template<unsigned int VImageDimension>

IDPath& FREE::PrecisionSOMetric< VImageDimension >::GetInterimFieldPath

(

)

const [inline]

Definition at line 71 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual void FREE::PrecisionSOMetric< VImageDimension >::SetSaveInterimOnDisc

(

const bool

_arg

)

[inline, virtual]

Definition at line 73 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual bool FREE::PrecisionSOMetric< VImageDimension >::GetSaveInterimOnDisc

(

)

[inline, virtual]

Definition at line 74 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual void FREE::PrecisionSOMetric< VImageDimension >::SetSampleSize

(

const unsigned long

_arg

)

[inline, virtual]

Definition at line 76 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual unsigned long FREE::PrecisionSOMetric< VImageDimension >::GetSampleSize

(

)

[inline, virtual]

Definition at line 77 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

unsigned int FREE::PrecisionSOMetric< 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

Implements FREE::SetupOptimizationMetric.

Definition at line 79 of file freFieldPrecisionSOMetric.h.

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::OnEvaluationProgress	(	const long	status,
		const std::string &	sComment,
		void *	pSender,
		long	threadID
	)			[inline, protected]

Function is plugged to the fnOnEvaluationProgress function pointer of Registrator. It manages the gathering of statistical information and calls the function Self.fnOnNextIteration.

Parameters:

[in]	lIteration	The current iteration number.
[in,out]	pStatistic	Pointer to the statistic object, if set.
[in,out]	pSender	Void pointer to the sender of the event. Must be cast.

Definition at line 172 of file freFieldPrecisionSOMetric.txx.

References FREE::SetupOptimizationMetric::fnOnEvaluationProgress.

template<unsigned int VImageDimension>

PrecisionSOMetric::DecomposedMeasureType FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue

(

const ParametersType &

parameters

)

const [inline, protected, virtual]

Definition at line 61 of file freFieldPrecisionSOMetric.txx.

References FREE::GenericSetupToImageAdaptor::AdaptNextSetup(), FREE::GenericSetupToImageAdaptor::AddAdaptations(), FREE::ImageSampleCharacteristicsCalculator< TImage >::Compute(), FREE::SessionProcessor::DefineOutput(), FREE::GenericSetupToImageAdaptor::EndOfAdaptation(), FREE::SetupOptimizationMetric::fnOnEvaluationDone, FREE::SessionProcessor::GetCastedOutput(), FREE::GenericSetupToImageAdaptor::GetCurrentAdaptationID(), FREE::ImageSampleCharacteristicsCalculator< TImage >::GetMean(), FREE::ImageSampleCharacteristicsCalculator< TImage >::GetVariance(), FREE::SessionProcessor::InitializeSession(), FREE::PrecisionSOMetric< VImageDimension >::m_dErrorMean, FREE::PrecisionSOMetric< VImageDimension >::m_dErrorVar, FREE::PrecisionSOMetric< VImageDimension >::m_dMaxError, FREE::PrecisionSOMetric< VImageDimension >::m_dMinError, FREE::PrecisionSOMetric< VImageDimension >::m_InterimFieldPath, FREE::PrecisionSOMetric< VImageDimension >::m_lActAdaptation, FREE::PrecisionSOMetric< VImageDimension >::m_lFailedRegistrations, FREE::PrecisionSOMetric< VImageDimension >::m_SampleSize, FREE::PrecisionSOMetric< VImageDimension >::m_SaveInterimOnDisc, FREE::PrecisionSOMetric< VImageDimension >::m_smpSetup, FREE::SetupOptimizationMetric::m_Transform, FREE::ImageSampleCharacteristicsCalculator< TImage >::SetImage(), FREE::SessionProcessor::SetSetup(), FREE::GenericSetupToImageAdaptor::SetTemplateSetup(), and throwExceptionMacro.

Here is the call graph for this function:

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::operator=

(

const Self &

)

[private]

template<unsigned int VImageDimension>

virtual const char* FREE::PrecisionSOMetric< VImageDimension >::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 63 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

static Pointer FREE::PrecisionSOMetric< VImageDimension >::New

(

void

)

[inline, static]

Definition at line 65 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual ::itk::LightObject::Pointer FREE::PrecisionSOMetric< VImageDimension >::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 65 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual void FREE::PrecisionSOMetric< VImageDimension >::SetSampleSize

(

const unsigned long

_arg

)

[inline, virtual]

Definition at line 67 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual unsigned long FREE::PrecisionSOMetric< VImageDimension >::GetSampleSize

(

)

[inline, virtual]

Definition at line 68 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual void FREE::PrecisionSOMetric< VImageDimension >::SetEvaluationMetric

(

SetupOptimizationMetric *

_arg

)

[inline, virtual]

Definition at line 70 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

virtual SetupOptimizationMetric* FREE::PrecisionSOMetric< VImageDimension >::GetEvaluationMetric

(

)

[inline, virtual]

Definition at line 71 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::Initialize

(

void

)

[virtual]

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 35 of file frePrecisionSOMetric.cxx.

References FREE::PrecisionSOMetric< VImageDimension >::EnlistDictionaryEntries(), FREE::SetupOptimizationMetric::fnOnEvaluationProgress, FREE::SetupOptimizationMetric::Initialize(), FREE::PrecisionSOMetric< VImageDimension >::m_EvaluationMetric, and throwExceptionMacro.

Here is the call graph for this function:

template<unsigned int VImageDimension>

virtual unsigned int FREE::PrecisionSOMetric< VImageDimension >::GetNumberOfValues

(

void

)

const [virtual]

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

Implements FREE::SetupOptimizationMetric.

template<unsigned int VImageDimension>

virtual DecomposedMeasureType FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue

(

const ParametersType &

parameters

)

const [protected, virtual]

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::EnlistInterimResultsToStatistic	(	const unsigned int	iIndex,
		const DecomposedMeasureType &	results,
		StatisticEntry &	entry
	)			const [protected]

Definition at line 52 of file frePrecisionSOMetric.cxx.

References FREE::StatisticEntry::AddValue(), and FREE::Convert::ToStr().

Here is the call graph for this function:

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::EnlistDictionaryEntries

(

StatisticDictionary &

dictionary

)

const [protected]

Definition at line 64 of file frePrecisionSOMetric.cxx.

References FREE::StatisticDictionary::AddEntryDefinition(), FREE::StatisticDictionary::AddValueDefinition(), FREE::PrecisionSOMetric< VImageDimension >::GetNameOfClass(), FREE::PrecisionSOMetric< VImageDimension >::m_EvaluationMetric, and FREE::Convert::ToStr().

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

Here is the call graph for this function:

template<unsigned int VImageDimension>

void FREE::PrecisionSOMetric< VImageDimension >::operator=

(

const Self &

)

[private]

---

Member Data Documentation

template<unsigned int VImageDimension>

ProgressEvent< PrecisionSOMetric<VImageDimension> >::Pointer FREE::PrecisionSOMetric< VImageDimension >::m_IterationEvent [protected]

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 88 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

Setup::Pointer FREE::PrecisionSOMetric< VImageDimension >::m_smpSetup [mutable, protected]

Definition at line 100 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

double FREE::PrecisionSOMetric< VImageDimension >::m_dMinError [mutable, protected]

Definition at line 102 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

double FREE::PrecisionSOMetric< VImageDimension >::m_dMaxError [mutable, protected]

Definition at line 103 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

unsigned long FREE::PrecisionSOMetric< VImageDimension >::m_lFailedRegistrations [mutable, protected]

Definition at line 104 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

unsigned long FREE::PrecisionSOMetric< VImageDimension >::m_lActAdaptation [mutable, protected]

Definition at line 105 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

double FREE::PrecisionSOMetric< VImageDimension >::m_dErrorMean [mutable, protected]

Definition at line 106 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

double FREE::PrecisionSOMetric< VImageDimension >::m_dErrorVar [mutable, protected]

Definition at line 107 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

IDPath FREE::PrecisionSOMetric< VImageDimension >::m_ResultFieldPath [protected]

Definition at line 109 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

std::string FREE::PrecisionSOMetric< VImageDimension >::m_InterimFieldPath [protected]

Definition at line 111 of file freFieldPrecisionSOMetric.h.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric(), and FREE::PrecisionSOMetric< VImageDimension >::SetInterimFieldPath().

template<unsigned int VImageDimension>

bool FREE::PrecisionSOMetric< VImageDimension >::m_SaveInterimOnDisc [protected]

Definition at line 113 of file freFieldPrecisionSOMetric.h.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), and FREE::PrecisionSOMetric< VImageDimension >::PrecisionSOMetric().

template<unsigned int VImageDimension>

unsigned long FREE::PrecisionSOMetric< VImageDimension >::m_SampleSize [protected]

Definition at line 115 of file freFieldPrecisionSOMetric.h.

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

template<unsigned int VImageDimension>

std::vector<DecomposedMeasureType> FREE::PrecisionSOMetric< VImageDimension >::m_Measures [mutable, protected]

Definition at line 88 of file frePrecisionSOMetric.h.

template<unsigned int VImageDimension>

SetupOptimizationMetric::Pointer FREE::PrecisionSOMetric< VImageDimension >::m_EvaluationMetric [protected]

evaluation metric used to estimate the precision of the setup

Definition at line 91 of file frePrecisionSOMetric.h.

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

---

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

• freFieldPrecisionSOMetric.h
• frePrecisionSOMetric.h
• freFieldPrecisionSOMetric.txx
• frePrecisionSOMetric.cxx

---