FREE::MutualInformationMetricControllerBase< TImageType > Class Template Reference
[Metric controller]

Controllerclass for a mutual information metric. More...

#include <freMutualInformationMetricController.h>

Inheritance diagram for FREE::MutualInformationMetricControllerBase< TImageType >:

Inheritance graph
FREE::MutualInformation2DMetricController\< ImageTypes\< 2 \>::InternalImageType \>FREE::MutualInformation3DMetricController\< ImageTypes\< 3 \>::InternalImageType \>FREE::ImageToImageMetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::SingleValuedMetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::MetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::ComponentControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::MutualInformationMetricControllerBase< TImageType >:

Collaboration graph
FREE::ImageToImageMetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::SingleValuedMetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::MetricControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::ComponentControllerBase\< itk::MutualInformationImageToImageMetric\< TImageType, TImageType \> \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef
itk::MutualInformationImageToImageMetric
< TImageType,
TImageType > 
ComponentType
typedef
ImageToImageMetricControllerBase
< ComponentType
Superclass

Public Member Functions

 itkTypeMacro (MutualInformationMetricControllerBase, ImageToImageMetricControllerBase)
 DeclareParameterMacro (NrOfSmpl)
 DeclareParameterMacro (MovingStdDev)
 DeclareParameterMacro (FixedStdDev)
 DeclareParameterMacro (AbsoluteSamples)
 DeclareParameterMacro (InitialSeed)
 DeclareParameterMacro (UseInitialSeed)
 DeclareMediaIDMacro (sampleImage)

Protected Member Functions

 MutualInformationMetricControllerBase ()
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 SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const


Detailed Description

template<class TImageType>
class FREE::MutualInformationMetricControllerBase< TImageType >

Controllerclass for a mutual information metric.

MutualInformationMetricControllerBase is derived from ImageToImageMetricControllerBase and is the basic controller for a mutual information metric implemented by itk::MutualInformationImageToImageMetric.

Definition at line 45 of file freMutualInformationMetricController.h.


Member Typedef Documentation

template<class TImageType>
typedef itk::MutualInformationImageToImageMetric<TImageType,TImageType> FREE::MutualInformationMetricControllerBase< TImageType >::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< itk::MutualInformationImageToImageMetric< TImageType, TImageType > >.

Definition at line 48 of file freMutualInformationMetricController.h.

template<class TImageType>
typedef ImageToImageMetricControllerBase<ComponentType> FREE::MutualInformationMetricControllerBase< TImageType >::Superclass

Reimplemented from FREE::ImageToImageMetricControllerBase< itk::MutualInformationImageToImageMetric< TImageType, TImageType > >.

Definition at line 49 of file freMutualInformationMetricController.h.


Constructor & Destructor Documentation

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::MutualInformationMetricControllerBase (  )  [inline, protected]

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

Definition at line 65 of file freMutualInformationMetricController.h.


Member Function Documentation

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::itkTypeMacro ( MutualInformationMetricControllerBase< TImageType >  ,
ImageToImageMetricControllerBase   
)

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( NrOfSmpl   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( MovingStdDev   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( FixedStdDev   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( AbsoluteSamples   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( InitialSeed   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareParameterMacro ( UseInitialSeed   ) 

template<class TImageType>
FREE::MutualInformationMetricControllerBase< TImageType >::DeclareMediaIDMacro ( sampleImage   ) 

template<class TImageType>
virtual void FREE::MutualInformationMetricControllerBase< TImageType >::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< itk::MutualInformationImageToImageMetric< TImageType, TImageType > >.

Definition at line 72 of file freMutualInformationMetricController.h.

template<class TImageType>
virtual void FREE::MutualInformationMetricControllerBase< TImageType >::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< itk::MutualInformationImageToImageMetric< TImageType, TImageType > >.

Definition at line 115 of file freMutualInformationMetricController.h.

template<class TImageType>
void FREE::MutualInformationMetricControllerBase< TImageType >::SetMediaCasted ( const MediaID mediaID,
GenericMediaType pMedia,
ComponentType pComponent,
SessionComponentCache pComponentCache,
SessionInfo pSessionInfo 
) const [inline, protected]

Definition at line 173 of file freMutualInformationMetricController.h.


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