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

This class is a metric evaluating the difference between two images. More...

#include <freImageDifferenceSOMetric.h>

Inheritance diagram for FREE::ImageDifferenceSOMetric< VImageDimension >:

[legend]

Collaboration diagram for FREE::ImageDifferenceSOMetric< VImageDimension >:

[legend]

List of all members.

Public Types
typedef ImageDifferenceSOMetric < VImageDimension >	Self
typedef SetupOptimizationMultiThreadMetric < ImageDifferenceSOMetricMonitor, ImageDifferenceSOMetricThread < VImageDimension > >	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef Superclass::MonitorType	MonitorType
typedef Superclass::MonitorPointer	MonitorPointer
typedef Superclass::ThreadType	ThreadType
typedef Superclass::ThreadPointer	ThreadPointer
typedef Superclass::EvaluationResultType	EvaluationResultType
typedef Superclass::DecomposedMeasureType	DecomposedMeasureType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	SetResultImagePath (const IDPath &path)
IDPath &	GetResultImagePath () const
void	SetReferenceImagePath (const IDPath &path)
IDPath &	GetReferenceImagePath () const
virtual unsigned int	GetNumberOfValues (void) const
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	ImageDifferenceSOMetric ()
virtual	~ImageDifferenceSOMetric ()
virtual void	InitializeValueComputation () const
virtual void	InitializeMonitor (MonitorType &monitor) const
virtual void	InitializeThread (ThreadType &thread) const
virtual DecomposedMeasureType	ComputeMeasure (MonitorType &monitor) const
Protected Attributes
double	m_dMinError
double	m_dMaxError
double	m_dErrorMean
double	m_dErrorDev
double	m_dMinImageError
double	m_dMaxImageError
double	m_dImageErrorMean
double	m_dImageErrorDev
unsigned long	m_lFailedProcessings
double	m_dDurMean
double	m_dDurDev
double	m_dMinDur
double	m_dMaxDur
std::vector< double >	m_Errors
std::vector< double >	m_Vars
std::vector< long >	m_Samplesize
std::vector< long >	m_Durations
std::vector< double >	m_ImageErrors
IDPath	m_ReferenceImagePath
IDPath	m_ResultImagePath
Private Member Functions
	ImageDifferenceSOMetric (const Self &)
void	operator= (const Self &)

---

Detailed Description

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

This class is a metric evaluating the difference between two images.

ImageDifferenceSOMetric is used to estimate the accuracy of an image processing by computing the difference of pixel values of a reference image and the result of the processing. The reference image of every adaptation must be stored in a media container. The IDPath to this media can be set via ReferenceImagePath parameter.
Also it is needed to define the path of the output image, that should be used for evaluation. The IDPath to this media can be set via ResultImagePath parameter.
The Metric has multiple metric values as return:

• absolute mean pixel difference (occurring when processing the whole adaptation list)
• mean pixel difference standard deviation
• min absolute pixel difference
• max absolute pixel difference
• absolute mean image difference (the absolut sum of errors in an image)
• mean image difference standard deviation
• min absolute image difference
• max absolute image difference
• number of failed evaluations
• mean duration of an evaluation (in tenth of a second (ToS))
• standard deviation of the evaluation (in ToS)
• min duration (in ToS)
• max duration (in ToS)

Definition at line 65 of file freImageDifferenceSOMetric.h.

---

Member Typedef Documentation

template<unsigned int VImageDimension>

typedef ImageDifferenceSOMetric<VImageDimension> FREE::ImageDifferenceSOMetric< VImageDimension >::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 70 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef SetupOptimizationMultiThreadMetric<ImageDifferenceSOMetricMonitor, ImageDifferenceSOMetricThread<VImageDimension> > FREE::ImageDifferenceSOMetric< VImageDimension >::Superclass

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 72 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 73 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 74 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::MonitorType FREE::ImageDifferenceSOMetric< VImageDimension >::MonitorType

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 76 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::MonitorPointer FREE::ImageDifferenceSOMetric< VImageDimension >::MonitorPointer

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 77 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::ThreadType FREE::ImageDifferenceSOMetric< VImageDimension >::ThreadType

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 78 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::ThreadPointer FREE::ImageDifferenceSOMetric< VImageDimension >::ThreadPointer

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 79 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

typedef Superclass::EvaluationResultType FREE::ImageDifferenceSOMetric< VImageDimension >::EvaluationResultType

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 80 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

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

Reimplemented from FREE::SetupOptimizationMetric.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 81 of file freImageDifferenceSOMetric.h.

---

Constructor & Destructor Documentation

template<unsigned int VImageDimension>

FREE::ImageDifferenceSOMetric< VImageDimension >::ImageDifferenceSOMetric

(

)

[inline, protected]

Definition at line 61 of file freImageDifferenceSOMetric.txx.

References FREE::ImageDifferenceSOMetric< VImageDimension >::m_ReferenceImagePath, FREE::ImageDifferenceSOMetric< VImageDimension >::m_ResultImagePath, and FREE::IDPath::Reset().

Here is the call graph for this function:

template<unsigned int VImageDimension>

virtual FREE::ImageDifferenceSOMetric< VImageDimension >::~ImageDifferenceSOMetric

(

)

[inline, protected, virtual]

Definition at line 99 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

FREE::ImageDifferenceSOMetric< VImageDimension >::ImageDifferenceSOMetric

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int VImageDimension>

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

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 84 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

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

(

void

)

[inline, static]

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 86 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

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

(

void

)

const [inline, virtual]

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 86 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

void FREE::ImageDifferenceSOMetric< VImageDimension >::SetResultImagePath

(

const IDPath &

path

)

[inline]

Definition at line 52 of file freImageDifferenceSOMetric.txx.

References FREE::ImageDifferenceSOMetric< VImageDimension >::m_ResultImagePath, and FREE::IDPath::ToStr().

Referenced by FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent().

Here is the call graph for this function:

template<unsigned int VImageDimension>

IDPath& FREE::ImageDifferenceSOMetric< VImageDimension >::GetResultImagePath

(

)

const [inline]

Definition at line 89 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

void FREE::ImageDifferenceSOMetric< VImageDimension >::SetReferenceImagePath

(

const IDPath &

path

)

[inline]

Definition at line 42 of file freImageDifferenceSOMetric.txx.

References FREE::ImageDifferenceSOMetric< VImageDimension >::m_ReferenceImagePath, and FREE::IDPath::ToStr().

Referenced by FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent().

Here is the call graph for this function:

template<unsigned int VImageDimension>

IDPath& FREE::ImageDifferenceSOMetric< VImageDimension >::GetReferenceImagePath

(

)

const [inline]

Definition at line 92 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

virtual unsigned int FREE::ImageDifferenceSOMetric< 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.

Reimplemented in FREE::ConstrainedImageDifferenceSOMetric< VImageDimension >.

Definition at line 94 of file freImageDifferenceSOMetric.h.

template<unsigned int VImageDimension>

void FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation

(

)

const [inline, protected, virtual]

Implements FREE::SetupOptimizationMultiThreadMetric< TMonitor, TThread >.

Definition at line 70 of file freImageDifferenceSOMetric.txx.

References FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dErrorDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dErrorMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxDur, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxImageError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinDur, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinImageError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Durations, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Errors, FREE::ImageDifferenceSOMetric< VImageDimension >::m_lFailedProcessings, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Samplesize, and FREE::ImageDifferenceSOMetric< VImageDimension >::m_Vars.

template<unsigned int VImageDimension>

void FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeMonitor

(

MonitorType &

monitor

)

const [inline, protected, virtual]

Definition at line 97 of file freImageDifferenceSOMetric.txx.

template<unsigned int VImageDimension>

void FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeThread

(

ThreadType &

thread

)

const [inline, protected, virtual]

Definition at line 105 of file freImageDifferenceSOMetric.txx.

template<unsigned int VImageDimension>

ImageDifferenceSOMetric< VImageDimension >::DecomposedMeasureType FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure

(

MonitorType &

monitor

)

const [inline, protected, virtual]

Definition at line 114 of file freImageDifferenceSOMetric.txx.

References catchAllNPassMacro, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dErrorDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dErrorMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorDev, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorMean, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxDur, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxImageError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinDur, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinImageError, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Durations, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Errors, FREE::ImageDifferenceSOMetric< VImageDimension >::m_ImageErrors, FREE::ImageDifferenceSOMetric< VImageDimension >::m_lFailedProcessings, FREE::ImageDifferenceSOMetric< VImageDimension >::m_Samplesize, and FREE::ImageDifferenceSOMetric< VImageDimension >::m_Vars.

template<unsigned int VImageDimension>

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

(

const Self &

)

[private]

---

Member Data Documentation

template<unsigned int VImageDimension>

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

Definition at line 106 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

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

Definition at line 107 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

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

Definition at line 108 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dErrorDev [mutable, protected]

Definition at line 109 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinImageError [mutable, protected]

Definition at line 111 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxImageError [mutable, protected]

Definition at line 112 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorMean [mutable, protected]

Definition at line 113 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dImageErrorDev [mutable, protected]

Definition at line 114 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

unsigned long FREE::ImageDifferenceSOMetric< VImageDimension >::m_lFailedProcessings [mutable, protected]

Definition at line 116 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurMean [mutable, protected]

Definition at line 118 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dDurDev [mutable, protected]

Definition at line 119 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMinDur [mutable, protected]

Definition at line 120 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

double FREE::ImageDifferenceSOMetric< VImageDimension >::m_dMaxDur [mutable, protected]

Definition at line 121 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

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

Definition at line 123 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

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

Definition at line 124 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

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

Definition at line 125 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

std::vector<long> FREE::ImageDifferenceSOMetric< VImageDimension >::m_Durations [mutable, protected]

Definition at line 126 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure(), and FREE::ImageDifferenceSOMetric< VImageDimension >::InitializeValueComputation().

template<unsigned int VImageDimension>

std::vector<double> FREE::ImageDifferenceSOMetric< VImageDimension >::m_ImageErrors [mutable, protected]

Definition at line 127 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ComputeMeasure().

template<unsigned int VImageDimension>

IDPath FREE::ImageDifferenceSOMetric< VImageDimension >::m_ReferenceImagePath [protected]

Definition at line 129 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ImageDifferenceSOMetric(), and FREE::ImageDifferenceSOMetric< VImageDimension >::SetReferenceImagePath().

template<unsigned int VImageDimension>

IDPath FREE::ImageDifferenceSOMetric< VImageDimension >::m_ResultImagePath [protected]

Definition at line 130 of file freImageDifferenceSOMetric.h.

Referenced by FREE::ImageDifferenceSOMetric< VImageDimension >::ImageDifferenceSOMetric(), and FREE::ImageDifferenceSOMetric< VImageDimension >::SetResultImagePath().

---

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

• freImageDifferenceSOMetric.h
• freImageDifferenceSOMetric.txx

---