FREE::AccuracySOMetricMonitor Class Reference
[Setup optimization metric]

This base class is used for monitoring the progress of AccuracySOMetric. More...

#include <freAccuracySOMetricMonitor.h>

Inheritance diagram for FREE::AccuracySOMetricMonitor:

[legend]

Collaboration diagram for FREE::AccuracySOMetricMonitor:

[legend]

List of all members.

Public Types
typedef AccuracySOMetricMonitor	Self
typedef SetupOptimizationMetricMonitorBase < AccuracySOMetricResult >	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef AccuracySOMetricResult	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
	AccuracySOMetricMonitor ()
virtual	~AccuracySOMetricMonitor ()
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 < ResultType::PointErrorListType >	m_PointErrors
std::vector < unsigned long >	m_Samplesize
std::vector < unsigned long >	m_Durations
std::vector < unsigned long >	m_UnevaluatedPoints
Private Member Functions
	AccuracySOMetricMonitor (const Self &)
void	operator= (const Self &)

---

Detailed Description

This base class is used for monitoring the progress of AccuracySOMetric.

AccuracySOMetricMonitor is used by AccuracySOMetric to coordinate the evaluation of adaptations, the storing of results and the event interaction of a single 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 103 of file freAccuracySOMetricMonitor.h.

---

Member Typedef Documentation

typedef AccuracySOMetricMonitor FREE::AccuracySOMetricMonitor::Self

Standard class typedefs.

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 108 of file freAccuracySOMetricMonitor.h.

typedef SetupOptimizationMetricMonitorBase<AccuracySOMetricResult> FREE::AccuracySOMetricMonitor::Superclass

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 109 of file freAccuracySOMetricMonitor.h.

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

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 110 of file freAccuracySOMetricMonitor.h.

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

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 111 of file freAccuracySOMetricMonitor.h.

typedef AccuracySOMetricResult FREE::AccuracySOMetricMonitor::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 115 of file freAccuracySOMetricMonitor.h.

---

Constructor & Destructor Documentation

FREE::AccuracySOMetricMonitor::AccuracySOMetricMonitor

(

)

[protected]

Implementation of FREE::AccuracySOMetricMonitor ////////////////////

Definition at line 60 of file freAccuracySOMetricMonitor.cxx.

FREE::AccuracySOMetricMonitor::~AccuracySOMetricMonitor

(

)

[protected, virtual]

Definition at line 64 of file freAccuracySOMetricMonitor.cxx.

FREE::AccuracySOMetricMonitor::AccuracySOMetricMonitor

(

const Self &

)

[private]

---

Member Function Documentation

virtual const char* FREE::AccuracySOMetricMonitor::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Reimplemented from FREE::SetupOptimizationMetricMonitorBase< TResultClass >.

Definition at line 118 of file freAccuracySOMetricMonitor.h.

static Pointer FREE::AccuracySOMetricMonitor::New

(

void

)

[inline, static]

Definition at line 120 of file freAccuracySOMetricMonitor.h.

virtual ::itk::LightObject::Pointer FREE::AccuracySOMetricMonitor::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 120 of file freAccuracySOMetricMonitor.h.

void FREE::AccuracySOMetricMonitor::InsertEvaluationResults

(

const ResultType &

results

)

[protected, virtual]

Definition at line 70 of file freAccuracySOMetricMonitor.cxx.

References FREE::AccuracySOMetricResult::GetDuration(), FREE::AccuracySOMetricResult::GetError(), FREE::AccuracySOMetricResult::GetMaxError(), FREE::AccuracySOMetricResult::GetMinError(), FREE::AccuracySOMetricResult::GetPointErrors(), FREE::AccuracySOMetricResult::GetSamplesize(), FREE::AccuracySOMetricResult::GetUnevaluatedPoints(), FREE::AccuracySOMetricResult::GetVariance(), m_Durations, m_Errors, m_MaxErrors, m_MinErrors, m_PointErrors, m_Samplesize, m_UnevaluatedPoints, and m_Vars.

Here is the call graph for this function:

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

Definition at line 84 of file freAccuracySOMetricMonitor.cxx.

References m_Durations, m_Errors, m_MaxErrors, m_MinErrors, m_PointErrors, m_Samplesize, m_UnevaluatedPoints, m_Vars, FREE::AccuracySOMetricResult::SetDuration(), FREE::AccuracySOMetricResult::SetError(), FREE::AccuracySOMetricResult::SetMaxError(), FREE::AccuracySOMetricResult::SetMinError(), FREE::AccuracySOMetricResult::SetPointErrors(), FREE::AccuracySOMetricResult::SetSamplesize(), FREE::AccuracySOMetricResult::SetUnevaluatedPoints(), and FREE::AccuracySOMetricResult::SetVariance().

Here is the call graph for this function:

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

Definition at line 98 of file freAccuracySOMetricMonitor.cxx.

References FREE::StatisticEntry::AddValue(), FREE::AccuracySOMetricResult::GetDuration(), FREE::AccuracySOMetricResult::GetError(), FREE::AccuracySOMetricResult::GetMaxError(), FREE::AccuracySOMetricResult::GetMinError(), FREE::AccuracySOMetricResult::GetPointErrors(), FREE::AccuracySOMetricResult::GetUnevaluatedPoints(), FREE::AccuracySOMetricResult::GetVariance(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::AccuracySOMetricMonitor::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 118 of file freAccuracySOMetricMonitor.cxx.

References FREE::StatisticDictionary::AddValueDefinition().

Here is the call graph for this function:

void FREE::AccuracySOMetricMonitor::operator=

(

const Self &

)

[private]

---

Member Data Documentation

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

interim mean error of every adaptation of the current evaluation

Definition at line 139 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

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

interim error variance of every adaptation of the current evaluation

Definition at line 141 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

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

interim minimum error of every adaptation of the current evaluation

Definition at line 143 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

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

interim maximum error of every adaptation of the current evaluation

Definition at line 145 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<ResultType::PointErrorListType> FREE::AccuracySOMetricMonitor::m_PointErrors [protected]

error of all reference points of the current evaluation; only used if m_bUseField = false.

Definition at line 148 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

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

sample size of every adaptation of the current evaluation

Definition at line 151 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

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

duration of every adaptation of the current evaluation

Definition at line 153 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

std::vector<unsigned long> FREE::AccuracySOMetricMonitor::m_UnevaluatedPoints [protected]

Definition at line 155 of file freAccuracySOMetricMonitor.h.

Referenced by CopyAdaptationResults(), and InsertEvaluationResults().

---

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

• freAccuracySOMetricMonitor.h
• freAccuracySOMetricMonitor.cxx

---