FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField > Class Template Reference
[ITK image filter controller]

Controller class for itk::WarpImageFilter. More...

#include <freWarpImageFilterController.h>

Inheritance diagram for FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >:

Inheritance graph
FREE::Warp2DImageFilterController\< FREE::ImageTypes\< 2 \>::InternalImageType, FREE::ImageTypes\< 2 \>::TransformationFieldType \>FREE::Warp3DImageFilterController\< FREE::ImageTypes\< 3 \>::InternalImageType, FREE::ImageTypes\< 3 \>::TransformationFieldType \>FREE::ImageToImageFilterControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ProcessorControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ComponentControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >:

Collaboration graph
FREE::ImageToImageFilterControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ProcessorControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ComponentControllerBase\< itk::WarpImageFilter\< TInputImage, TInputImage, TDeformationField \> \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef
itk::WarpImageFilter
< TInputImage,
TInputImage,
TDeformationField > 
ComponentType
typedef
ImageToImageFilterControllerBase
< ComponentType
Superclass
typedef
WarpImageFilterControllerBase
< TInputImage,
TDeformationField > 
Self
typedef
ComponentType::Pointer 
ComponentPointer
typedef
Superclass::GenericComponentType 
GenericComponentType
typedef
Superclass::GenericComponentPointer 
GenericComponentPointer
typedef
Superclass::GenericMediaPointer 
GenericMediaPointer

Public Member Functions

 DeclareParameterMacro (EdgePaddingValue)
 DeclareParameterMacro (OutputOrigin)
 DeclareParameterMacro (OutputSpacing)
 DeclareParameterMacro (UseFieldInfo)
 itkTypeMacro (WarpImageFilterControllerBase, ImageToImageFilterControllerBase)
ValidityTag::Pointer GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const

Protected Member Functions

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


Detailed Description

template<class TInputImage, class TDeformationField>
class FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >

Controller class for itk::WarpImageFilter.

WarpImageFilterControllerBase is derived from ImageToImageFilterControllerBase and is the controller itk::WarpImageFilter.

Definition at line 45 of file freWarpImageFilterController.h.


Member Typedef Documentation

template<class TInputImage, class TDeformationField>
typedef itk::WarpImageFilter<TInputImage, TInputImage, TDeformationField> FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::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::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 48 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef ImageToImageFilterControllerBase<ComponentType> FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::Superclass

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 49 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef WarpImageFilterControllerBase<TInputImage, TDeformationField> FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::Self

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 50 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef ComponentType::Pointer FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 52 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef Superclass::GenericComponentType FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::GenericComponentType

Generic component type

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 53 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef Superclass::GenericComponentPointer FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 54 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
typedef Superclass::GenericMediaPointer FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::GenericMediaPointer

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Reimplemented in FREE::Warp2DImageFilterController, and FREE::Warp3DImageFilterController.

Definition at line 55 of file freWarpImageFilterController.h.


Constructor & Destructor Documentation

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::WarpImageFilterControllerBase (  )  [inline, protected]

Definition at line 79 of file freWarpImageFilterController.h.


Member Function Documentation

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::DeclareParameterMacro ( EdgePaddingValue   ) 

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::DeclareParameterMacro ( OutputOrigin   ) 

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::DeclareParameterMacro ( OutputSpacing   ) 

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::DeclareParameterMacro ( UseFieldInfo   ) 

template<class TInputImage, class TDeformationField>
FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::itkTypeMacro ( WarpImageFilterControllerBase< TInputImage, TDeformationField >  ,
ImageToImageFilterControllerBase   
)

template<class TInputImage, class TDeformationField>
ValidityTag::Pointer FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::GetMediaValidityTagRequirement ( const MediaID mediaID,
SessionComponentCache pComponentCache 
) const [inline, virtual]

Retrieves the validity tag requirement of the media specified by the mediaID. The requirement is the most up to date ValidityTag in the dependency chain of a media component.
Reimplement GetMediaValidityTagRequirement() to realize special controller behavior accordingly a certain dependency chain.
This version returns only the ValidityTag of the specified media; thus the media has no dependencies.

Parameters:
[in] mediaID ID specifying the wanted media.
[in] pComponentCache Pointer to the component cache.
Returns:
ValidityTag requirement

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 65 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
virtual void FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::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::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 86 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
virtual void FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::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::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 121 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
virtual GenericComponentType* FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::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::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 161 of file freWarpImageFilterController.h.

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

Definition at line 169 of file freWarpImageFilterController.h.

template<class TInputImage, class TDeformationField>
virtual GenericMediaPointer FREE::WarpImageFilterControllerBase< TInputImage, TDeformationField >::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::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 177 of file freWarpImageFilterController.h.

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

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::WarpImageFilter< TInputImage, TInputImage, TDeformationField > >.

Definition at line 187 of file freWarpImageFilterController.h.


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