FREE::HistogramMetricControllerBase< TControlledMetric > Class Template Reference
[Metric controller]

Basic controller class for histogram based metircs. More...

#include <freHistogramMetricControllerBase.h>

Inheritance diagram for FREE::HistogramMetricControllerBase< TControlledMetric >:

Inheritance graph
FREE::CorrelationCoefficientHistogramMetricControlleBase\< ImageTypes\< 2 \>::InternalImageType \>FREE::CorrelationCoefficientHistogramMetricControlleBase\< ImageTypes\< 3 \>::InternalImageType \>FREE::MutualInformationHistogramMetricControllerBase\< ImageTypes\< 2 \>::InternalImageType \>FREE::MutualInformationHistogramMetricControllerBase\< ImageTypes\< 3 \>::InternalImageType \>FREE::ImageToImageMetricControllerBase\< TControlledMetric \>FREE::SingleValuedMetricControllerBase\< TControlledMetric \>FREE::MetricControllerBase\< TControlledMetric \>FREE::ComponentControllerBase\< TControlledMetric \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::HistogramMetricControllerBase< TControlledMetric >:

Collaboration graph
FREE::ImageToImageMetricControllerBase\< TControlledMetric \>FREE::SingleValuedMetricControllerBase\< TControlledMetric \>FREE::MetricControllerBase\< TControlledMetric \>FREE::ComponentControllerBase\< TControlledMetric \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef TControlledMetric ComponentType
typedef
ImageToImageMetricControllerBase
< ComponentType
Superclass

Public Member Functions

 itkTypeMacro (HistogramMetricControllerBase, ImageToImageMetricControllerBase)

Protected Member Functions

 HistogramMetricControllerBase ()
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


Detailed Description

template<class TControlledMetric>
class FREE::HistogramMetricControllerBase< TControlledMetric >

Basic controller class for histogram based metircs.

HistogramMetricControllerBase is derived from ImageToImageMetricControllerBase and is the base controller for histogram based metrics derived from itk::HistogramImageToImageMetric.

Definition at line 44 of file freHistogramMetricControllerBase.h.


Member Typedef Documentation

template<class TControlledMetric>
typedef TControlledMetric FREE::HistogramMetricControllerBase< 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::ImageToImageMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::CorrelationCoefficientHistogramMetricControlleBase< TImageType >, FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 2 >::InternalImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, and FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >.

Definition at line 47 of file freHistogramMetricControllerBase.h.

template<class TControlledMetric>
typedef ImageToImageMetricControllerBase<ComponentType> FREE::HistogramMetricControllerBase< TControlledMetric >::Superclass

Reimplemented from FREE::ImageToImageMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::CorrelationCoefficientHistogramMetricControlleBase< TImageType >, FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 2 >::InternalImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, and FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >.

Definition at line 48 of file freHistogramMetricControllerBase.h.


Constructor & Destructor Documentation

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

The Constructor of this class is protected, because this class should be used only as ancestor for derived classes

Definition at line 55 of file freHistogramMetricControllerBase.h.


Member Function Documentation

template<class TControlledMetric>
FREE::HistogramMetricControllerBase< TControlledMetric >::itkTypeMacro ( HistogramMetricControllerBase< TControlledMetric >  ,
ImageToImageMetricControllerBase   
)

template<class TControlledMetric>
virtual void FREE::HistogramMetricControllerBase< 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::ImageToImageMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, and FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >.

Definition at line 62 of file freHistogramMetricControllerBase.h.

Referenced by FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile().

template<class TControlledMetric>
virtual void FREE::HistogramMetricControllerBase< 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. For more information see ControllerBase::ActualizeMainComponent.

Reimplemented from FREE::ComponentControllerBase< TControlledMetric >.

Reimplemented in FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 92 of file freHistogramMetricControllerBase.h.

Referenced by FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::ActualizeMainComponent().


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