FREE::CheckerBoardImageFilterControllerBase< TInputImage > Class Template Reference
[ITK image filter controller, Basic controllers]

Controller class for filters based on itk::CheckerBoardImageFilter. More...

#include <freCheckerBoardImageFilterController.h>

Inheritance diagram for FREE::CheckerBoardImageFilterControllerBase< TInputImage >:

[legend]

Collaboration diagram for FREE::CheckerBoardImageFilterControllerBase< TInputImage >:

[legend]

List of all members.

Public Types
typedef itk::CheckerBoardImageFilter < TInputImage >	ComponentType
typedef ImageToImageFilterControllerBase < ComponentType >	Superclass
typedef CheckerBoardImageFilterControllerBase < ComponentType >	Self
typedef ComponentType::Pointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
typedef ComponentType::OutputImageType	OutputImageType
typedef ComponentType::OutputImagePointer	OutputImagePointer
Public Member Functions
	DeclareParameterMacro (CheckerPattern)
	itkTypeMacro (CheckerBoardImageFilterControllerBase, ImageToImageFilterControllerBase)
virtual ValidityTag::Pointer	GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
Protected Member Functions
	CheckerBoardImageFilterControllerBase ()
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const

---

Detailed Description

template<class TInputImage>
class FREE::CheckerBoardImageFilterControllerBase< TInputImage >

Controller class for filters based on itk::CheckerBoardImageFilter.

CheckerBoardImageFilterControllerBase is derived from ImageToImageFilterControllerBase and is the controller for image processing tasks based on the itk::CheckerBoardImageFilter

Definition at line 43 of file freCheckerBoardImageFilterController.h.

---

Member Typedef Documentation

template<class TInputImage>

typedef itk::CheckerBoardImageFilter<TInputImage> FREE::CheckerBoardImageFilterControllerBase< TInputImage >::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::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 46 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef ImageToImageFilterControllerBase<ComponentType> FREE::CheckerBoardImageFilterControllerBase< TInputImage >::Superclass

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 47 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef CheckerBoardImageFilterControllerBase<ComponentType> FREE::CheckerBoardImageFilterControllerBase< TInputImage >::Self

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 48 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef ComponentType::Pointer FREE::CheckerBoardImageFilterControllerBase< TInputImage >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 50 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef Superclass::GenericComponentType FREE::CheckerBoardImageFilterControllerBase< TInputImage >::GenericComponentType

Generic component type

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 51 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef Superclass::GenericComponentPointer FREE::CheckerBoardImageFilterControllerBase< TInputImage >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 52 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef Superclass::GenericMediaPointer FREE::CheckerBoardImageFilterControllerBase< TInputImage >::GenericMediaPointer

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Reimplemented in FREE::CheckerBoard2DImageFilterController, and FREE::CheckerBoard3DImageFilterController.

Definition at line 53 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef ComponentType::OutputImageType FREE::CheckerBoardImageFilterControllerBase< TInputImage >::OutputImageType

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Definition at line 54 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

typedef ComponentType::OutputImagePointer FREE::CheckerBoardImageFilterControllerBase< TInputImage >::OutputImagePointer

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Definition at line 55 of file freCheckerBoardImageFilterController.h.

---

Constructor & Destructor Documentation

template<class TInputImage>

FREE::CheckerBoardImageFilterControllerBase< TInputImage >::CheckerBoardImageFilterControllerBase

(

)

[inline, protected]

Definition at line 75 of file freCheckerBoardImageFilterController.h.

---

Member Function Documentation

template<class TInputImage>

FREE::CheckerBoardImageFilterControllerBase< TInputImage >::DeclareParameterMacro

(

CheckerPattern

)

template<class TInputImage>

FREE::CheckerBoardImageFilterControllerBase< TInputImage >::itkTypeMacro	(	CheckerBoardImageFilterControllerBase< TInputImage >	,
		ImageToImageFilterControllerBase
	)

template<class TInputImage>

virtual ValidityTag::Pointer FREE::CheckerBoardImageFilterControllerBase< TInputImage >::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::CheckerBoardImageFilter< TInputImage > >.

Definition at line 61 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

virtual void FREE::CheckerBoardImageFilterControllerBase< TInputImage >::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::CheckerBoardImageFilter< TInputImage > >.

Definition at line 82 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

virtual void FREE::CheckerBoardImageFilterControllerBase< TInputImage >::SetMediaCasted	(	const MediaID &	mediaID,
		GenericMediaType *	pMedia,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const [inline, protected, virtual]

Reimplemented from FREE::ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter< TInputImage > >.

Definition at line 95 of file freCheckerBoardImageFilterController.h.

template<class TInputImage>

virtual void FREE::CheckerBoardImageFilterControllerBase< TInputImage >::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::CheckerBoardImageFilter< TInputImage > >.

Definition at line 105 of file freCheckerBoardImageFilterController.h.

---

The documentation for this class was generated from the following file:

• freCheckerBoardImageFilterController.h

---