FREE::PointSupportedMetricControllerBase< TImageType, TPointSet > Class Template Reference
[Metric controller]

Controller class for a point set supported image to image metric. More...

#include <frePointSupportedMetricController.h>

Inheritance diagram for FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >:

Inheritance graph
FREE::PointSupported2DMetricController\< ImageTypes\< 2 \>::InternalImageType, FREE::ImageTypes\< 2 \>::PointSetType \>FREE::PointSupported3DMetricController\< ImageTypes\< 3 \>::InternalImageType, FREE::ImageTypes\< 3 \>::PointSetType \>FREE::ImageToImageMetricControllerBase\< itk::PointSupportedImageToImageMetric\< TImageType, TImageType, TPointSet, TPointSet \> \>FREE::SingleValuedMetricControllerBase\< itk::PointSupportedImageToImageMetric\< TImageType, TImageType, TPointSet, TPointSet \> \>FREE::MetricControllerBase\< itk::PointSupportedImageToImageMetric\< TImageType, TImageType, TPointSet, TPointSet \> \>FREE::ComponentControllerBase\< itk::PointSupportedImageToImageMetric\< TImageType, TImageType, TPointSet, TPointSet \> \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >:

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

List of all members.

Public Types

typedef
itk::PointSupportedImageToImageMetric
< TImageType,
TImageType,
TPointSet,
TPointSet > 
ComponentType
typedef
ImageToImageMetricControllerBase
< ComponentType
Superclass
typedef
PointSupportedMetricControllerBase
< TImageType,
TPointSet > 
Self
typedef
Superclass::GenericComponentType 
GenericComponentType
typedef
Superclass::GenericComponentPointer 
GenericComponentPointer
typedef
Superclass::GenericMediaPointer 
GenericMediaPointer

Public Member Functions

 itkTypeMacro (PointSupportedMetricControllerBase, ImageToImageMetricControllerBase)
 DeclareParameterMacro (Alpha)
 DeclareParameterMacro (DetailedStats)
 DeclareMediaIDMacro (fixedPointSet)
 DeclareMediaIDMacro (movingPointSet)
Parameter::Pointer GetParameter (const SessionComponentCache *pComponentCache, const std::string &sParameterName) const

Protected Member Functions

 PointSupportedMetricControllerBase ()
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
virtual
GenericMediaPointer 
GetMediaCasted (const MediaID &mediaID, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void SetSubComponentCasted (GenericComponentType *pSubComponent, ComponentType *pMainComponent, const ComponentID compID, SessionComponentCache *pMainComponentCache) const
virtual
GenericComponentType
GetSubComponentCasted (ComponentType *pMainComponent, const ComponentID &compID, SessionComponentCache *pMainComponentCache) const
virtual void SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
void ResetSubComponents (SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const


Detailed Description

template<class TImageType, class TPointSet>
class FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >

Controller class for a point set supported image to image metric.

PointSupportedMetricControllerBase is derived from ImageToImageMetricControllerBase and is the controller for a point set supported image to image metric implemented by itk::PointSupportedImageToImageMetric.

Definition at line 45 of file frePointSupportedMetricController.h.


Member Typedef Documentation

template<class TImageType, class TPointSet>
typedef itk::PointSupportedImageToImageMetric<TImageType,TImageType,TPointSet,TPointSet> FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::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::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Reimplemented in FREE::PointSupported2DMetricController, and FREE::PointSupported3DMetricController.

Definition at line 48 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
typedef ImageToImageMetricControllerBase<ComponentType> FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::Superclass

Reimplemented from FREE::ImageToImageMetricControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Reimplemented in FREE::PointSupported2DMetricController, and FREE::PointSupported3DMetricController.

Definition at line 49 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
typedef PointSupportedMetricControllerBase<TImageType,TPointSet> FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::Self

Definition at line 50 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
typedef Superclass::GenericComponentType FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GenericComponentType

Generic component type

Reimplemented from FREE::MetricControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 51 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
typedef Superclass::GenericComponentPointer FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::MetricControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 52 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
typedef Superclass::GenericMediaPointer FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GenericMediaPointer

Reimplemented from FREE::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 53 of file frePointSupportedMetricController.h.


Constructor & Destructor Documentation

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

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

Definition at line 86 of file frePointSupportedMetricController.h.


Member Function Documentation

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

template<class TImageType, class TPointSet>
FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::DeclareParameterMacro ( Alpha   ) 

template<class TImageType, class TPointSet>
FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::DeclareParameterMacro ( DetailedStats   ) 

template<class TImageType, class TPointSet>
FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::DeclareMediaIDMacro ( fixedPointSet   ) 

template<class TImageType, class TPointSet>
FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::DeclareMediaIDMacro ( movingPointSet   ) 

template<class TImageType, class TPointSet>
Parameter::Pointer FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GetParameter ( const SessionComponentCache pComponentCache,
const std::string &  sParameterName 
) const [inline, virtual]

Returns a smart pointer to the specified parameter which is provided by the component controller. To address the component, parameter, layer and value index an IDPath is used: ComponentName\.. (e.g. component@StepSize)

Remarks:
The parameter is passed as a smart pointer because it could be possible that the controller has generated the parameter values explicitly for this call (e.g. Parameter with access type "get") and is not responsible for the deallocation; this will be handled by the smart pointer.
Parameters:
[in] pComponentCache Pointer to component where the parameter should be located.
[in] sParameterName Name of the parameter with the wanted value.
Returns:
Smart pointer with the parameter. If the smart pointer is NULL the specified parameter couldn't be found. (See remarks concerning the result nature)

Reimplemented from FREE::MetricControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 63 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual void FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::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::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 93 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual void FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::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::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 122 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual GenericMediaPointer FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GetMediaCasted ( const MediaID mediaID,
ComponentType pComponent,
SessionComponentCache pComponentCache,
SessionInfo pSessionInfo 
) const [inline, protected, virtual]

Returns the media specified by the MediaID. If the media ID is not handled, an exception will be thrown.
Reimplement this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:
[in] mediaID ID specifying the wanted media.
[in] pComponent Pointer to the casted component of the passed cache.
[in] pComponentCache Pointer to the component cache.
[in] pSessionInfo Pointer to the session info.
Returns:
Smartpointer to the media.
Remarks:
If media is unknown to controller, an exception will be raised.

Reimplemented from FREE::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 138 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual void FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::SetSubComponentCasted ( GenericComponentType pSubComponent,
ComponentType pMainComponent,
const ComponentID  compID,
SessionComponentCache pMainComponentCache 
) const [inline, protected, virtual]

Definition at line 148 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual GenericComponentType* FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::GetSubComponentCasted ( ComponentType pMainComponent,
const ComponentID compID,
SessionComponentCache pMainComponentCache 
) const [inline, protected, virtual]

Returns the subcomponent specified by the ComponentID. If the component ID is not defined, the return is NULL.
Reimplement the virtual variant of this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:
[in] pMainComponent Pointer to the casted main component, containing the wanted subcomponent.
[in] compID ID specifying the wanted subcomponent.
[in] pMainComponentCache Pointer to the cache of the main component.

Reimplemented from FREE::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 155 of file frePointSupportedMetricController.h.

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

Definition at line 164 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
virtual void FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::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::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 172 of file frePointSupportedMetricController.h.

template<class TImageType, class TPointSet>
void FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >::ResetSubComponents ( SessionComponentCache pComponentCache,
SessionInfo pSessionInfo 
) const [inline, protected, virtual]

This function (called by ResetComponent()) resets all subcomponents In a derived class this function should be overridden, if a simple ResetComponent() call of all subcomponents is is not sufficient.

Parameters:
[in,out] pComponentCache Pointer to the component cache, that should be actualized.
[in] pSessionInfo Pointer to the session info.

Reimplemented from FREE::ComponentControllerBase< itk::PointSupportedImageToImageMetric< TImageType, TImageType, TPointSet, TPointSet > >.

Definition at line 249 of file frePointSupportedMetricController.h.


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