FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric > Class Template Reference
[Metric controllerSetup optimization metric]

Controller class for an image based classification quality metric. More...

#include <freConstrainedImageClassificationSOMetricController.h>

Inheritance diagram for FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >:

Inheritance graph
FREE::ConstrainedImageClassification2DSOMetricController\< FREE::ConstrainedImageClassificationSOMetric\< 2 \> \>FREE::ConstrainedImageClassification3DSOMetricController\< FREE::ConstrainedImageClassificationSOMetric\< 3 \> \>FREE::ImageClassificationSOMetricControllerBase\< TControlledMetric \>FREE::SetupOptimizationMultiThreadMetricControllerBase\< TControlledMetric \>FREE::SetupOptimizationMetricControllerBase\< TControlledMetric \>FREE::ComponentControllerBase\< TControlledMetric \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >:

Collaboration graph
FREE::ImageClassificationSOMetricControllerBase\< TControlledMetric \>FREE::SetupOptimizationMultiThreadMetricControllerBase\< TControlledMetric \>FREE::SetupOptimizationMetricControllerBase\< TControlledMetric \>FREE::ComponentControllerBase\< TControlledMetric \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef TControlledMetric ComponentType
typedef
ImageClassificationSOMetricControllerBase
< ComponentType
Superclass

Public Member Functions

 DeclareParameterMacro (MaxConstraintPenalty)
 DeclareParameterMacro (FailureThreshold)
 DeclareParameterMacro (Constraints)
 itkTypeMacro (ConstrainedImageClassificationSOMetricControllerBase, ImageClassificationSOMetricControllerBase)

Protected Member Functions

 ConstrainedImageClassificationSOMetricControllerBase ()
virtual void GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const
void SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const


Detailed Description

template<class TControlledMetric>
class FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >

Controller class for an image based classification quality metric.

ConstrainedImageClassificationSOMetricControllerBase is the base class for the control of metrics that are used as measure for the quality of image based classification.

Definition at line 42 of file freConstrainedImageClassificationSOMetricController.h.


Member Typedef Documentation

template<class TControlledMetric>
typedef TControlledMetric FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::ComponentType

The component class managed by the controller. The component class must be a derivation from itk::LightObject to ensure the ability to use the smartpointer concept of itk

Reimplemented from FREE::ImageClassificationSOMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::ConstrainedImageClassification2DSOMetricController, and FREE::ConstrainedImageClassification3DSOMetricController.

Definition at line 49 of file freConstrainedImageClassificationSOMetricController.h.

template<class TControlledMetric>
typedef ImageClassificationSOMetricControllerBase<ComponentType> FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::Superclass

Reimplemented from FREE::ImageClassificationSOMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::ConstrainedImageClassification2DSOMetricController, and FREE::ConstrainedImageClassification3DSOMetricController.

Definition at line 50 of file freConstrainedImageClassificationSOMetricController.h.


Constructor & Destructor Documentation

template<class TControlledMetric>
FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::ConstrainedImageClassificationSOMetricControllerBase (  )  [inline, protected]

Definition at line 55 of file freConstrainedImageClassificationSOMetricController.h.


Member Function Documentation

template<class TControlledMetric>
FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::DeclareParameterMacro ( MaxConstraintPenalty   ) 

template<class TControlledMetric>
FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::DeclareParameterMacro ( FailureThreshold   ) 

template<class TControlledMetric>
FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::DeclareParameterMacro ( Constraints   ) 

template<class TControlledMetric>
FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::itkTypeMacro ( ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >  ,
ImageClassificationSOMetricControllerBase   
)

template<class TControlledMetric>
virtual void FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::GenerateProfile ( CtrlProfile::ControllerProfile profile,
const SessionComponentCache pComponentCache,
bool  bRegardOldSetup 
) const [inline, protected, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:
[in,out] profile Reference of the current profile.
[in] pComponentCache Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in] bRegardOldSetup If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::ImageClassificationSOMetricControllerBase< TControlledMetric >.

Definition at line 64 of file freConstrainedImageClassificationSOMetricController.h.

template<class TControlledMetric>
virtual void FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::ActualizeMainComponent ( ComponentType pMainComponent,
SessionComponentCache pComponentCache,
SessionInfo pSessionInfo,
const unsigned int &  iActLevel 
) const [inline, protected, virtual]

This function (called by ActualizeComponent()) actualizes the passed component with the setup information considering the actual resolution level of the ongoing registration. In a derived class this function should be overridden to provide a specific behavior.

Parameters:
[in,out] pMainComponent Pointer to the main component. Can also be retrieved via component cache, but offered directly and already casted for more convenience.
[in,out] pComponentCache Pointer to the component cache that should be actualized.
[in] pSessionInfo Pointer to the session info.
[in] iActLevel Indicates which layer of a parameter should be used, if the parameter is layer sensitive (e.g. as resolution level of a registration). Default is 0.

Reimplemented from FREE::ImageClassificationSOMetricControllerBase< TControlledMetric >.

Definition at line 76 of file freConstrainedImageClassificationSOMetricController.h.

template<class TControlledMetric>
void FREE::ConstrainedImageClassificationSOMetricControllerBase< TControlledMetric >::SetStatisticEntryMainComponent ( StatisticEntry rStatisticEntry,
ComponentType pMainComponent,
SessionComponentCache pMainComponentCache,
SessionInfo pSessionInfo,
StatisticDictionary rDictionary 
) const [inline, protected, virtual]

This function (called by SetStatisticEntry()) records any statistical information of the passed component In a derived class this function should be overridden to provide a specific behavior.

Parameters:
[in,out] rStatisticEntry reference to the Statistic object, where the relevant information should be stored.
[in] pMainComponent Pointer to the casted component. Also available via cache, but already casted for convenience.
[in] pMainComponentCache Pointer to the component cache.
[in] pSessionInfo Pointer to the session info
[in,out] rDictionary Dictionary with information about the stored facts (e.g. Type, Name) The entry in the dictionary should set by the controller if needed.

Reimplemented from FREE::ImageClassificationSOMetricControllerBase< TControlledMetric >.

Definition at line 118 of file freConstrainedImageClassificationSOMetricController.h.


The documentation for this class was generated from the following file:
Generated at Sat Oct 13 18:22:30 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000