FREE::ImageDifferenceSOMetricMonitor Class Reference
[Setup optimization metric]

This base class is for monitoring the progress of ImageDifferenceSOMetric. More...

#include <freImageDifferenceSOMetricMonitor.h>

Inheritance diagram for FREE::ImageDifferenceSOMetricMonitor:

[legend]

Collaboration diagram for FREE::ImageDifferenceSOMetricMonitor:

[legend]

List of all members.

Public Types
typedef ImageDifferenceSOMetricMonitor	Self
typedef SetupOptimizationMetricMonitorBase < ImageDifferenceSOMetricResult >	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef ImageDifferenceSOMetricResult	ResultType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	ImageDifferenceSOMetricMonitor ()
virtual	~ImageDifferenceSOMetricMonitor ()
virtual void	InsertEvaluationResults (const ResultType &results)
virtual void	CopyAdaptationResults (const ResultIndexType &index, ResultType &results) const
virtual void	EnlistResultsToStatistic (const ResultType &results, StatisticEntry &entry)
virtual void	EnlistDictionaryEntries (StatisticDictionary &dictionary)
Protected Attributes
std::vector< double >	m_Errors
std::vector< double >	m_Vars
std::vector< double >	m_MinErrors
std::vector< double >	m_MaxErrors
std::vector< double >	m_ImageErrors
std::vector < unsigned long >	m_Samplesize
std::vector < unsigned long >	m_Durations
Private Member Functions
	ImageDifferenceSOMetricMonitor (const Self &)
void	operator= (const Self &)

---

Detailed Description

This base class is for monitoring the progress of ImageDifferenceSOMetric.

ImageDifferenceSOMetricMonitor is used by ImageDifferenceSOMetric to coordinate the evaluation of adaptations, the storing of results and the event interactions of a singel thread. Every evaluation thread uses the monitor to get the next adaptation, to return the results or to notify a processing failure.

Definition at line 99 of file freImageDifferenceSOMetricMonitor.h.

---

Member Typedef Documentation

typedef ImageDifferenceSOMetricMonitor FREE::ImageDifferenceSOMetricMonitor::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 104 of file freImageDifferenceSOMetricMonitor.h.

typedef SetupOptimizationMetricMonitorBase<ImageDifferenceSOMetricResult> FREE::ImageDifferenceSOMetricMonitor::Superclass

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 105 of file freImageDifferenceSOMetricMonitor.h.

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

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 106 of file freImageDifferenceSOMetricMonitor.h.

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

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 107 of file freImageDifferenceSOMetricMonitor.h.

typedef ImageDifferenceSOMetricResult FREE::ImageDifferenceSOMetricMonitor::ResultType

Class containing the results of one adaptation evaluation depends on the monitored metric and therefore a template.

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 111 of file freImageDifferenceSOMetricMonitor.h.

---

Constructor & Destructor Documentation

FREE::ImageDifferenceSOMetricMonitor::ImageDifferenceSOMetricMonitor

(

)

[protected]

Implementation of FREE::ImageDifferenceSOMetricMonitor /////////////

Definition at line 58 of file freImageDifferenceSOMetricMonitor.cxx.

FREE::ImageDifferenceSOMetricMonitor::~ImageDifferenceSOMetricMonitor

(

)

[protected, virtual]

Definition at line 62 of file freImageDifferenceSOMetricMonitor.cxx.

FREE::ImageDifferenceSOMetricMonitor::ImageDifferenceSOMetricMonitor

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::ImageDifferenceSOMetricMonitor::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 114 of file freImageDifferenceSOMetricMonitor.h.

static Pointer FREE::ImageDifferenceSOMetricMonitor::New

(

void

)

[inline, static]

Definition at line 116 of file freImageDifferenceSOMetricMonitor.h.

virtual ::itk::LightObject::Pointer FREE::ImageDifferenceSOMetricMonitor::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 116 of file freImageDifferenceSOMetricMonitor.h.

void FREE::ImageDifferenceSOMetricMonitor::InsertEvaluationResults

(

const ResultType &

results

)

[protected, virtual]

Definition at line 68 of file freImageDifferenceSOMetricMonitor.cxx.

References FREE::ImageDifferenceSOMetricResult::GetDuration(), FREE::ImageDifferenceSOMetricResult::GetError(), FREE::ImageDifferenceSOMetricResult::GetImageError(), FREE::ImageDifferenceSOMetricResult::GetMaxError(), FREE::ImageDifferenceSOMetricResult::GetMinError(), FREE::ImageDifferenceSOMetricResult::GetSamplesize(), FREE::ImageDifferenceSOMetricResult::GetVariance(), m_Durations, m_Errors, m_ImageErrors, m_MaxErrors, m_MinErrors, m_Samplesize, and m_Vars.

Here is the call graph for this function:

void FREE::ImageDifferenceSOMetricMonitor::CopyAdaptationResults	(	const ResultIndexType &	index,
		ResultType &	results
	)			const [protected, virtual]

Definition at line 81 of file freImageDifferenceSOMetricMonitor.cxx.

References m_Durations, m_Errors, m_ImageErrors, m_MaxErrors, m_MinErrors, m_Samplesize, m_Vars, FREE::ImageDifferenceSOMetricResult::SetDuration(), FREE::ImageDifferenceSOMetricResult::SetError(), FREE::ImageDifferenceSOMetricResult::SetImageError(), FREE::ImageDifferenceSOMetricResult::SetMaxError(), FREE::ImageDifferenceSOMetricResult::SetMinError(), FREE::ImageDifferenceSOMetricResult::SetSamplesize(), and FREE::ImageDifferenceSOMetricResult::SetVariance().

Here is the call graph for this function:

void FREE::ImageDifferenceSOMetricMonitor::EnlistResultsToStatistic	(	const ResultType &	results,
		StatisticEntry &	entry
	)			[protected, virtual]

Definition at line 94 of file freImageDifferenceSOMetricMonitor.cxx.

References FREE::StatisticEntry::AddValue(), FREE::ImageDifferenceSOMetricResult::GetDuration(), FREE::ImageDifferenceSOMetricResult::GetError(), FREE::ImageDifferenceSOMetricResult::GetImageError(), FREE::ImageDifferenceSOMetricResult::GetMaxError(), FREE::ImageDifferenceSOMetricResult::GetMinError(), FREE::ImageDifferenceSOMetricResult::GetVariance(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::ImageDifferenceSOMetricMonitor::EnlistDictionaryEntries

(

StatisticDictionary &

dictionary

)

[protected, virtual]

This method should be implemented in derived classes. The method is called by Initialize(). When entering the method it is ensured that the statistics are locked for this thread. The method should just add the dictonary entries needed to specify the values found in each step.

Parameters:

[out]	step	Reference to the step where the results should be added.
[in]	results	The results that should be added.

Implements FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 106 of file freImageDifferenceSOMetricMonitor.cxx.

References FREE::StatisticDictionary::AddValueDefinition().

Here is the call graph for this function:

void FREE::ImageDifferenceSOMetricMonitor::operator=

(

const Self &

)

[private]

---

Member Data Documentation

std::vector<double> FREE::ImageDifferenceSOMetricMonitor::m_Errors [protected]

interim mean error of every adaptation of the current evaluation

Definition at line 135 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<double> FREE::ImageDifferenceSOMetricMonitor::m_Vars [protected]

interim error variance of every adaptation of the current evaluation

Definition at line 137 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<double> FREE::ImageDifferenceSOMetricMonitor::m_MinErrors [protected]

interim minimum error of every adaptation of the current evaluation

Definition at line 139 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<double> FREE::ImageDifferenceSOMetricMonitor::m_MaxErrors [protected]

interim maximum error of every adaptation of the current evaluation

Definition at line 141 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<double> FREE::ImageDifferenceSOMetricMonitor::m_ImageErrors [protected]

interim image error of every adaptation of the current evaluation

Definition at line 143 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<unsigned long> FREE::ImageDifferenceSOMetricMonitor::m_Samplesize [protected]

sample size of every adaptation of the current evaluation

Definition at line 146 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<unsigned long> FREE::ImageDifferenceSOMetricMonitor::m_Durations [protected]

duration of every adaptation of the current evaluation

Definition at line 148 of file freImageDifferenceSOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

---

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

• freImageDifferenceSOMetricMonitor.h
• freImageDifferenceSOMetricMonitor.cxx

---