#include <freSetupOptimizationMetricMonitorBase.h>


SetupOptimizationMetricMonitorBase is used by multi threaded setup optimization metrics (e.g. AccuracySOMetric) 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. Derivate from this base class to realize a monitor for a metric.
Definition at line 66 of file freSetupOptimizationMetricMonitorBase.h.
| typedef SetupOptimizationMetricMonitorBase<TResultClass> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Self |
Standard class typedefs.
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 71 of file freSetupOptimizationMetricMonitorBase.h.
| typedef itk::Object FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Superclass |
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 72 of file freSetupOptimizationMetricMonitorBase.h.
| typedef itk::SmartPointer<Self> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Pointer |
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 73 of file freSetupOptimizationMetricMonitorBase.h.
| typedef itk::SmartPointer<const Self> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ConstPointer |
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 74 of file freSetupOptimizationMetricMonitorBase.h.
| typedef TResultClass FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ResultType |
Class containing the results of one adaptation evaluation depends on the monitored metric and therefore a template.
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 78 of file freSetupOptimizationMetricMonitorBase.h.
| typedef unsigned long FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ThreadIDType |
Definition at line 80 of file freSetupOptimizationMetricMonitorBase.h.
| typedef long FREE::SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDType |
Definition at line 81 of file freSetupOptimizationMetricMonitorBase.h.
| typedef long FREE::SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationCountType |
Definition at line 82 of file freSetupOptimizationMetricMonitorBase.h.
| typedef long FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ResultIndexType |
Definition at line 83 of file freSetupOptimizationMetricMonitorBase.h.
| typedef std::vector<AdaptationIDType> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType |
Definition at line 85 of file freSetupOptimizationMetricMonitorBase.h.
typedef std::vector<AdaptationStateType> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationStateListType [private] |
Containes the state of all adaptations. Index of the vector is equal to the adaptation ID
Definition at line 268 of file freSetupOptimizationMetricMonitorBase.h.
typedef std::map<ThreadIDType,AdaptationIDType> FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ThreadMapType [private] |
Indicates which thread (thread ID is key) currently processes which adaptation.
Definition at line 279 of file freSetupOptimizationMetricMonitorBase.h.
| enum FREE::SetupOptimizationMetricMonitorBase::AdaptationStateType |
Definition at line 87 of file freSetupOptimizationMetricMonitorBase.h.
| FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase | ( | ) | [inline, protected] |
Definition at line 378 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrder, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_IsInitialized, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpAdaptations, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpGenericSetup.
| FREE::SetupOptimizationMetricMonitorBase< TResultClass >::~SetupOptimizationMetricMonitorBase | ( | ) | [inline, protected, virtual] |
Definition at line 391 of file freSetupOptimizationMetricMonitorBase.txx.
| FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase | ( | const Self & | ) | [private] |
| virtual const char* FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetNameOfClass | ( | ) | const [inline, virtual] |
Run-time type information (and related methods).
Reimplemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Definition at line 96 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize().
| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup | ( | const ThreadIDType & | threadID, | |
| AdaptationIDType & | adaptID, | |||
| Setup::Pointer & | smpSetup | |||
| ) | [inline] |
This function checks the list of adaptations for a pending evaluation. If found one, the according adapted setup and adaptation ID will be passed back. Also the return value of the method will be true. If there is no unprocessed adaptation left the return will be false. The monitor also raises an evaluation event, if the return is true.
| [in] | threadID | The ID of the thread, that wants a new task |
| [out] | adaptID | If result is true, it will be set to the adaptation ID of the new task. |
| [out] | smpSetup | If result is true, it will point to the adapted setup that describes the new task. Is null if result is false. |
Definition at line 34 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::GenericSetupToImageAdaptor::AdaptSetup(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASProcessing, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistThreadAsProcessing(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfPendingAdaptations(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_Adaptor, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_EventMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_SetupMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState(), throwExceptionMacro, and FREE::Convert::ToStr().

| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyFailedEvaluation | ( | const ThreadIDType & | threadID, | |
| const std::string & | sError | |||
| ) | [inline] |
This function is used by threads to notify a failed evluation. The adaptation currently processed by the thread will be marked as failed. This function executes the EvaluationFailed event.
| [in] | threadID | The ID of the thread, that notifies the failure |
| [in] | sError | A string that can be used to specify the reason for the failure. |
Definition at line 71 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASFailed, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_EventMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::RemoveThreadFromProcessingList(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState(), and throwExceptionMacro.

| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyProgress | ( | const ThreadIDType & | threadID, | |
| const ProgressCtrlEventBase::StatusID | status, | |||
| const std::string & | sComment | |||
| ) | [inline] |
This function is used by threads to notify any progress on his current adaptation he evaluates.
| [in] | threadID | The ID of the thread, that notifies the failure |
| [in] | status | The status ID of the progress event |
| [in] | sComment | Progress comment. |
Definition at line 89 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_EventMutex, and throwExceptionMacro.
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished | ( | const ThreadIDType & | threadID, | |
| const ResultType & | results | |||
| ) | [inline] |
This function is used by threads to transfere the results of its current evaluation to the monitor. The current processed adaptation will be marked as evaluated. This function executes the EvaluationDone event.
| [in] | threadID | The ID of the thread, that notifies the failure |
Definition at line 106 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::StatisticEntry::AddValue(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASEvaluated, FREE::StatisticEntry::CloseEntry(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistResultsToStatistic(), FREE::StatisticData::GetCurrentEntryID(), FREE::Statistics::GetData(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::InsertEvaluationResults(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrder, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrderMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_EventMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_ResultMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex, FREE::StatisticData::PostCreateChildEntry(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::RemoveThreadFromProcessingList(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState(), FREE::StatisticEntry::SetRefID(), throwExceptionMacro, and FREE::Convert::ToStr().

| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetMetricStatistic | ( | Statistics * | pStatistic | ) | [inline] |
Sets the statistic where metric results should be enlisted.
Definition at line 153 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex.
| Statistics * FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetMetricStatistic | ( | ) | [inline] |
Returns the metric statistic and locks the statistic mutex. To avoid any thread conflict.
Definition at line 163 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex.
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ReleaseMetricStatistic | ( | ) | [inline] |
Unlocks the metric, so it can be used by others.
Definition at line 172 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex.
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetGenericSetup | ( | Setup * | pSetup | ) | [inline] |
Sets the generic setup. Is protected via setup mutex.
Definition at line 180 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_SetupMutex, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpGenericSetup.
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationList | ( | Adaptation::AdaptationList * | pAdaptations | ) | [inline] |
Sets the adaptation list. Is protected via setup mutex.
Definition at line 190 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_SetupMutex, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpAdaptations.
| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationResults | ( | const AdaptationIDType & | adaptID, | |
| ResultType & | results | |||
| ) | const [inline] |
Returns the results of an adaptation, if processed. If the adatpation is still pending, processing or has failed the return is false and the results are not valid. This method is secured via the result mutex.
The method calls CopyAdaptationResults to transfere the information.
| [in] | adaptID | Specifies of which adaptation the results are needed. |
| [out] | results | If method result is true, it contains the results of the adaptation |
Definition at line 200 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASEvaluated, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::CopyAdaptationResults(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetResultIndexOfAdaptation(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_ResultMutex.

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfPendingAdaptations | ( | ) | const [inline] |
Returns the list of adaptations that are still waiting for being processed.
Definition at line 218 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASPending, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState().
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup().

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfProcessedAdaptations | ( | ) | const [inline] |
Returns the list of adaptations that are to be processed right now.
Definition at line 226 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASProcessing, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState().

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfFailedAdaptations | ( | ) | const [inline] |
Returns the list of adaptations that are finished and have failed.
Definition at line 234 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASFailed, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState().
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationIsFinished(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetFailureCount().

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfEvaluatedAdaptations | ( | ) | const [inline] |
Returns the list of adaptations that are finished and sucessfully evaluated.
Definition at line 242 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASEvaluated, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState().
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationIsFinished().

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState | ( | const AdaptationStateType & | state | ) | const [inline] |
Returns the list of adaptations that have the specified state.
Definition at line 250 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfEvaluatedAdaptations(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfFailedAdaptations(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfPendingAdaptations(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfProcessedAdaptations().
| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationStateType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationState | ( | const AdaptationIDType & | adaptID | ) | const [inline] |
Returns the state of the specified adaptation. Throws an exception if adaptation ID is out of bound.
Definition at line 267 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex, and throwExceptionMacro.
| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationIsFinished | ( | ) | const [inline] |
Returns true of all adaptations are in the "failed" or "evaluated" state. Otherwise the return is false.
Definition at line 290 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfEvaluatedAdaptations(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfFailedAdaptations(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex.

| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::IsInitialized | ( | ) | const [inline] |
Returns if monitor is initialized.
Definition at line 307 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_IsInitialized.
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize | ( | void | ) | [inline] |
Initializes the monitor. Prepares m_AdaptStates and ensures that generic setup, Adaptations and metric statistics are set.
Definition at line 317 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::GenericSetupToImageAdaptor::AddAdaptations(), FREE::StatisticDictionary::AddEntryDefinition(), FREE::StatisticDictionary::AddValueDefinition(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ASPending, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistDictionaryEntries(), FREE::Statistics::GetDictionary(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetNameOfClass(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_Adaptor, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrder, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrderMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThreadMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_IsInitialized, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_SetupMutex, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpAdaptations, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpGenericSetup, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex, FREE::Statistics::Reset(), FREE::GenericSetupToImageAdaptor::SetTemplateSetup(), and throwExceptionMacro.

| SetupOptimizationMetricMonitorBase< TResultClass >::AdaptationCountType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetFailureCount | ( | ) | const [inline] |
Returns the current count of failed adaptations.
Definition at line 371 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfFailedAdaptations().

| virtual void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::InsertEvaluationResults | ( | const ResultType & | results | ) | [protected, pure virtual] |
This method should be implemented in derived classes. The method is called by EvaluationFinished(). When entering the method it is ensured that the results are locked for this thread. The method should just add the adaptation results to the end of the result arrays.
| [in] | results | The Results that should be added. |
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished().
| virtual void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::CopyAdaptationResults | ( | const ResultIndexType & | index, | |
| ResultType & | results | |||
| ) | const [protected, pure virtual] |
This method should be implemented in derived classes. The method is called by GetAdaptationResults(). When entering the method it is ensured that the results are locked for this thread. The method should just copy the results from the result arrays to the parameter results. The parameter index indicates the position in the arrays that is requested. If Index is out of bound, an exception will be thrown.
| [in] | index | Indicates position in the result array(s). |
| [out] | results | Methods sets value(s) of parameter to the requested result(s). |
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationResults().
| virtual void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistResultsToStatistic | ( | const ResultType & | results, | |
| StatisticEntry & | entry | |||
| ) | [protected, pure virtual] |
This method should be implemented in derived classes. The method is called by EvaluationFinished(). When entering the method it is ensured that the statistics are locked for this thread. The method should just add the adaptation results passed with the parameter results to the also passed parameter step. The first value, the adaptation ID, has already been entered by EvaluationFinished().
| [out] | step | Reference to the step where the results should be added. |
| [in] | results | The results that should be added. |
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished().
| virtual void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistDictionaryEntries | ( | StatisticDictionary & | dictionary | ) | [protected, pure 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.
| [out] | step | Reference to the step where the results should be added. |
| [in] | results | The results that should be added. |
Implemented in FREE::AccuracySOMetricMonitor, FREE::ImageClassificationSOMetricMonitor, and FREE::ImageDifferenceSOMetricMonitor.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize().
| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptionProcessedByThread | ( | const ThreadIDType & | threadID, | |
| AdaptationIDType & | adaptationID | |||
| ) | const [inline, protected] |
Returns the adaptation ID currently processed by the specified thread. If thread processes no adaptation the return of the method will be false and therefore adaptationID then contains no valid value.
Definition at line 399 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThreadMutex.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ThreadIsProcessing().
| bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ThreadIsProcessing | ( | const ThreadIDType & | threadID | ) | const [inline, protected] |
Definition at line 420 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptionProcessedByThread().

| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistThreadAsProcessing | ( | const ThreadIDType & | threadID, | |
| const AdaptationIDType & | adaptationID | |||
| ) | [inline, protected] |
Inserts the passed thread in the list as processing the passed adaptation. If thread is already in the list, an exception will be thrown. Remove the a thread first via RemoveThreadFromProcessingList() before enlisting him again.
Definition at line 429 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThreadMutex, and throwExceptionMacro.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup().
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::RemoveThreadFromProcessingList | ( | const ThreadIDType & | threadID | ) | [inline, protected] |
removes the passed thread from the processing list.
Definition at line 445 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThreadMutex.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyFailedEvaluation().
| SetupOptimizationMetricMonitorBase< TResultClass >::ResultIndexType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetResultIndexOfAdaptation | ( | const AdaptationIDType & | adaptationID | ) | const [inline, protected] |
Returns the result index of the passed adaptation ID
Definition at line 461 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrder, and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrderMutex.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationResults().
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState | ( | const AdaptationIDType & | adaptID, | |
| const AdaptationStateType & | state | |||
| ) | [inline, protected] |
Sets the state of the specified adaptation. Throws an exception if adaptation ID is out of bound.
Definition at line 480 of file freSetupOptimizationMetricMonitorBase.txx.
References FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates, FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex, and throwExceptionMacro.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyFailedEvaluation().
| void FREE::SetupOptimizationMetricMonitorBase< TResultClass >::operator= | ( | const Self & | ) | [private] |
| ProgressEventBase::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::fnOnEvaluationProgress |
Definition at line 195 of file freSetupOptimizationMetricMonitorBase.h.
| ProgressEventBase::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::fnOnEvaluationDone |
Definition at line 196 of file freSetupOptimizationMetricMonitorBase.h.
| ProgressEventBase::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::fnOnNextAdaptation |
Definition at line 197 of file freSetupOptimizationMetricMonitorBase.h.
| ProgressEventBase::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::fnOnEvaluationFailed |
Definition at line 198 of file freSetupOptimizationMetricMonitorBase.h.
AdaptationStateListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStates [private] |
Definition at line 269 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationIsFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationState(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptStatesMutex [mutable, private] |
Definition at line 270 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationIsFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationState(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetListOfAdaptationsByState(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationState().
AdaptationIDListType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrder [private] |
Maps the index of the result arrays (same than this index) onto the adaptation ID (value of the elements)
Definition at line 274 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetResultIndexOfAdaptation(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptOrderMutex [mutable, private] |
Definition at line 275 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetResultIndexOfAdaptation(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize().
ThreadMapType FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThread [private] |
Definition at line 280 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistThreadAsProcessing(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptionProcessedByThread(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::RemoveThreadFromProcessingList(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_AdaptThreadMutex [mutable, private] |
Definition at line 281 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EnlistThreadAsProcessing(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptionProcessedByThread(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::RemoveThreadFromProcessingList().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_ResultMutex [mutable, private] |
Responsible for the access to all result arrays
Definition at line 284 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetAdaptationResults().
Statistics* FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_pMetricStatistics [private] |
Definition at line 286 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetMetricStatistic(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetMetricStatistic(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_StatisticMutex [mutable, private] |
Responsible for the access to the statistic
Definition at line 288 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetMetricStatistic(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::ReleaseMetricStatistic(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetMetricStatistic().
Setup::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpGenericSetup [private] |
Definition at line 290 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetGenericSetup(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
Adaptation::AdaptationList::Pointer FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_smpAdaptations [private] |
Definition at line 291 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationList(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
GenericSetupToImageAdaptor FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_Adaptor [private] |
Definition at line 292 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_SetupMutex [mutable, private] |
Responsible for the access to the statistic
Definition at line 294 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetAdaptationList(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetGenericSetup().
itk::SimpleMutexLock FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_EventMutex [mutable, private] |
Responsible for all event interactions
Definition at line 297 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::EvaluationFinished(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::GetUnevaluatedAdaptedSetup(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyFailedEvaluation(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::NotifyProgress().
bool FREE::SetupOptimizationMetricMonitorBase< TResultClass >::m_IsInitialized [private] |
Definition at line 299 of file freSetupOptimizationMetricMonitorBase.h.
Referenced by FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::IsInitialized(), and FREE::SetupOptimizationMetricMonitorBase< TResultClass >::SetupOptimizationMetricMonitorBase().
1.5.3 written by Dimitri van Heesch,
© 1997-2000