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

This class is a metric evaluating setups with respect of their consistency. More...

#include <freConsistencySOMetric.h>

Inheritance diagram for FREE::ConsistencyRegistrationMetric< VImageDimension >:

[legend]

Collaboration diagram for FREE::ConsistencyRegistrationMetric< VImageDimension >:

[legend]

List of all members.

Public Types
typedef ConsistencyRegistrationMetric < VImageDimension >	Self
typedef SetupOptimizationMetric	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
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 Member Functions
	ConsistencyRegistrationMetric ()
virtual	~ConsistencyRegistrationMetric ()
void	OnNextIteration (const long lIteration, Statistics *pStatistic, void *pSender)
virtual DecomposedMeasureType	ComputeDecomposedValue (const ParametersType &parameters) const
virtual void	ComputeRegistrations (Setup *pSetup, Setup *pReverseSetup) const
Protected Attributes
IterationEvent < ConsistencyRegistrationMetric < 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
std::vector< double >	m_Errors
std::vector< double >	m_Vars
std::vector< long >	m_Samplesize
Private Member Functions
	ConsistencyRegistrationMetric (const Self &)
void	operator= (const Self &)

---

Detailed Description

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

This class is a metric evaluating setups with respect of their consistency.

ConsistencyRegistrationMetric is used to estimate the consistency of a registration. This is achieved by matching the moving to the fixed domaine and then doing a reverse matching. Both resulting deformation fields will be summed-up and result in an identity field, if there is perfect consistency.
The Metric has multiple metric values as return:

• absolute mean error (occurring difference/deffect of the registration))
• mean error standard deviation
• min absolute error
• max absolute error
• number of failed registrations (e.g. all points mapped outside the image, hence metric throws exception)

Definition at line 51 of file freConsistencySOMetric.h.

---

Member Typedef Documentation

template<unsigned int VImageDimension>

typedef ConsistencyRegistrationMetric<VImageDimension> FREE::ConsistencyRegistrationMetric< VImageDimension >::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 56 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 57 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 58 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 59 of file freConsistencySOMetric.h.

---

Constructor & Destructor Documentation

template<unsigned int VImageDimension>

FREE::ConsistencyRegistrationMetric< VImageDimension >::ConsistencyRegistrationMetric

(

)

[inline, protected]

Definition at line 109 of file freConsistencySOMetric.txx.

template<unsigned int VImageDimension>

virtual FREE::ConsistencyRegistrationMetric< VImageDimension >::~ConsistencyRegistrationMetric

(

)

[inline, protected, virtual]

Definition at line 72 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

FREE::ConsistencyRegistrationMetric< VImageDimension >::ConsistencyRegistrationMetric

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int VImageDimension>

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

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 63 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

(

void

)

[inline, static]

Definition at line 65 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

(

void

)

const [inline, virtual]

Definition at line 65 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

virtual unsigned int FREE::ConsistencyRegistrationMetric< 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 67 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

void FREE::ConsistencyRegistrationMetric< VImageDimension >::OnNextIteration	(	const long	lIteration,
		Statistics *	pStatistic,
		void *	pSender
	)			[inline, protected]

Function is plugged to the fnOnNextIteration 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 117 of file freConsistencySOMetric.txx.

template<unsigned int VImageDimension>

ConsistencyRegistrationMetric< VImageDimension >::DecomposedMeasureType FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeDecomposedValue

(

const ParametersType &

parameters

)

const [inline, protected, virtual]

Definition at line 43 of file freConsistencySOMetric.txx.

References FREE::GenericSetupToImageAdaptor::AdaptSetup(), FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeRegistrations(), FREE::SetupOptimizationMetric::fnOnEvaluationDone, FREE::ImageAdaptationInverter::InvertAdaptation(), FREE::ConsistencyRegistrationMetric< VImageDimension >::m_dErrorMean, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_dErrorVar, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_dMaxError, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_dMinError, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Errors, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_lActAdaptation, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_lFailedRegistrations, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Samplesize, FREE::SetupOptimizationMetric::m_smpAdaptations, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_smpSetup, FREE::SetupOptimizationMetric::m_Transform, FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Vars, FREE::Setup::New(), and throwExceptionMacro.

Here is the call graph for this function:

template<unsigned int VImageDimension>

void FREE::ConsistencyRegistrationMetric< VImageDimension >::ComputeRegistrations	(	Setup *	pSetup,
		Setup *	pReverseSetup
	)			const [inline, protected, virtual]

TODO consistency filter machen

Definition at line 126 of file freConsistencySOMetric.txx.

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

template<unsigned int VImageDimension>

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

(

const Self &

)

[private]

---

Member Data Documentation

template<unsigned int VImageDimension>

IterationEvent< ConsistencyRegistrationMetric<VImageDimension> >::Pointer FREE::ConsistencyRegistrationMetric< VImageDimension >::m_IterationEvent [protected]

Reimplemented from FREE::SetupOptimizationMetric.

Definition at line 72 of file freConsistencySOMetric.h.

template<unsigned int VImageDimension>

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

Definition at line 86 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 88 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 89 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 90 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 91 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 92 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

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

Definition at line 93 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

std::vector<double> FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Errors [mutable, protected]

Definition at line 95 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

std::vector<double> FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Vars [mutable, protected]

Definition at line 96 of file freConsistencySOMetric.h.

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

template<unsigned int VImageDimension>

std::vector<long> FREE::ConsistencyRegistrationMetric< VImageDimension >::m_Samplesize [mutable, protected]

Definition at line 97 of file freConsistencySOMetric.h.

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

---

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

• freConsistencySOMetric.h
• freConsistencySOMetric.txx

---