FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension > Class Template Reference
[Media controller]

Base class for intensity (grayscale) image media. More...

#include <freIntensityImageMediaController.h>

Inheritance diagram for FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >:

Inheritance graph
FREE::CharImage2DMediaController\< PixelType, char, 2 \>FREE::CharImage3DMediaController\< PixelType, char, 3 \>FREE::IntensityImage2DMediaController\< PixelType, unsigned short, 2 \>FREE::IntensityImage3DMediaController\< PixelType, unsigned short, 3 \>FREE::RegionImageMediaControllerBase\< TInternalPixel, TExternalPixel, VDimension \>FREE::RegionImageMediaControllerBase\< PixelType, unsigned short, 2 \>FREE::RegionImageMediaControllerBase\< PixelType, unsigned short, 3 \>FREE::ShortImage2DMediaController\< PixelType, short, 2 \>FREE::ShortImage3DMediaController\< PixelType, short, 3 \>FREE::UnsignedCharImage2DMediaController\< PixelType, unsigned char, 2 \>FREE::UnsignedCharImage3DMediaController\< PixelType, unsigned char, 3 \>FREE::UnsignedShortImage2DMediaController\< PixelType, unsigned short, 2 \>FREE::UnsignedShortImage3DMediaController\< PixelType, unsigned short, 3 \>FREE::ImageMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::MediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::ComponentControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::ComponentControllerInterfaceFREE::MediaControllerInterfaceFREE::StoreableMediaControllerInterfaceFREE::RegionImage2DMediaController\< PixelType, unsigned short, 2 \>FREE::RegionImage3DMediaController\< PixelType, unsigned short, 3 \>
[legend]
Collaboration diagram for FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >:

Collaboration graph
FREE::ImageMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::MediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::ComponentControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObjectFREE::MediaControllerInterfaceFREE::StoreableMediaControllerInterface
[legend]

List of all members.

Public Types

typedef itk::Image
< TInternalPixel,
VDimension > 
ComponentType
typedef ComponentType ImageType
typedef
ImageMediaControllerBase
< ComponentType
Superclass
typedef
Superclass::ComponentPointer 
ComponentPointer
typedef
Superclass::GenericMediaPointer 
GenericMediaPointer

Public Member Functions

 itkTypeMacro (IntensityImageMediaControllerBase, ImageMediaControllerBase)
 DeclareParameterMacro (RescaleImage)
 DeclareParameterMacro (RescaleOutputRange)
 IntensityImageMediaControllerBase ()
virtual
GenericMediaPointer 
ComputeActualizedMedia (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationField) const
virtual
GenericMediaPointer 
ComputeActualizedMediaByFunction (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationFunction) const
virtual bool SaveMedia (std::string sMediaPath, GenericMediaType *pMedia) const
virtual bool SaveMedia (SessionComponentCache *pCache) const
virtual bool LoadMedia (SessionComponentCache *pCache) const

Protected Member Functions

virtual void SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
virtual void GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const


Detailed Description

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
class FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >

Base class for intensity (grayscale) image media.

Definition at line 42 of file freIntensityImageMediaController.h.


Member Typedef Documentation

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
typedef itk::Image< TInternalPixel, VDimension > FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::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::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Reimplemented in FREE::CharImage2DMediaController, FREE::CharImage3DMediaController, FREE::UnsignedCharImage2DMediaController, FREE::UnsignedCharImage3DMediaController, FREE::IntensityImage2DMediaController, FREE::IntensityImage3DMediaController, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImage2DMediaController, FREE::RegionImage3DMediaController, FREE::ShortImage2DMediaController, FREE::ShortImage3DMediaController, FREE::UnsignedShortImage2DMediaController, FREE::UnsignedShortImage3DMediaController, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 45 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
typedef ComponentType FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::ImageType

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 46 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
typedef ImageMediaControllerBase<ComponentType> FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::Superclass

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Reimplemented in FREE::CharImage2DMediaController, FREE::CharImage3DMediaController, FREE::UnsignedCharImage2DMediaController, FREE::UnsignedCharImage3DMediaController, FREE::IntensityImage2DMediaController, FREE::IntensityImage3DMediaController, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImage2DMediaController, FREE::RegionImage3DMediaController, FREE::ShortImage2DMediaController, FREE::ShortImage3DMediaController, FREE::UnsignedShortImage2DMediaController, FREE::UnsignedShortImage3DMediaController, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 47 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
typedef Superclass::ComponentPointer FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Definition at line 48 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
typedef Superclass::GenericMediaPointer FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::GenericMediaPointer

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 49 of file freIntensityImageMediaController.h.


Constructor & Destructor Documentation

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::IntensityImageMediaControllerBase (  )  [inline]

Definition at line 56 of file freIntensityImageMediaController.h.


Member Function Documentation

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::itkTypeMacro ( IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >  ,
ImageMediaControllerBase   
)

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::DeclareParameterMacro ( RescaleImage   ) 

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::DeclareParameterMacro ( RescaleOutputRange   ) 

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual GenericMediaPointer FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::ComputeActualizedMedia ( GenericMediaType pGenericMedia,
GenericMediaType pGenericTransformationField 
) const [inline, virtual]

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 63 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual GenericMediaPointer FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::ComputeActualizedMediaByFunction ( GenericMediaType pGenericMedia,
GenericMediaType pGenericTransformationFunction 
) const [inline, virtual]

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, and FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >.

Definition at line 96 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual bool FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::SaveMedia ( std::string  sMediaPath,
GenericMediaType pMedia 
) const [inline, virtual]

This function saves the media passed. The location is specified by the passed path.

Parameters:
[in] sMediaPath Path locating the destination of the save operation.
[in] pMedia Pointer to media.
Returns:
Returns if the media was successfully saved.

Implements FREE::StoreableMediaControllerInterface.

Definition at line 129 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual bool FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::SaveMedia ( SessionComponentCache pCache  )  const [inline, virtual]

This function saves the media passed within the cache as component. to the path specified by the parameter ImageFile, if the parameter ImageSource == 1.

Parameters:
[in] pCache Cache containg the media to be saved as component.
Returns:
Returns if the media was successfully saved.

Reimplemented from FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Definition at line 149 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual bool FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::LoadMedia ( SessionComponentCache pCache  )  const [inline, virtual]

This function loads the media and stored it as component in the cache. The loading behavior depends on the controller (e.g. image media controller will save the media to the path specified in the component setup).

Parameters:
[in,out] pCache Cache containg the component setup most controller need to load the media. The media will be stored as component in the passed cache.
Returns:
Returns if the media was successfully loaded.

Reimplemented from FREE::MediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Definition at line 204 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual void FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::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::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Definition at line 269 of file freIntensityImageMediaController.h.

template<class TInternalPixel, class TExternalPixel, unsigned int VDimension>
virtual void FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >::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::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >.

Definition at line 304 of file freIntensityImageMediaController.h.


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