irtkImageToImage< VoxelType > Class Template Reference

#include <irtkImageToImage.h>

Inheritance diagram for irtkImageToImage< VoxelType >:

Inheritance graph
[legend]
Collaboration diagram for irtkImageToImage< VoxelType >:

Collaboration graph
[legend]

List of all members.


Detailed Description

template<class VoxelType>
class irtkImageToImage< VoxelType >

Abstract base class for any general image to image filter.

This is the abstract base class which defines a common interface for all filters which take an image as input and produce an image as output. Each derived class has to implement all abstract member functions.

Definition at line 31 of file irtkImageToImage.h.


Public Member Functions

 irtkImageToImage ()
 Constructor.
virtual ~irtkImageToImage ()
 Deconstuctor.
virtual void SetInput (irtkGenericImage< VoxelType > *)
 Set input image for filter.
virtual void SetOutput (irtkGenericImage< VoxelType > *)
 Set output image for filter.
virtual void Run ()
 Run filter on entire image.
virtual double Run (int, int, int, int=0)
 Run filter on single voxel.
virtual Bool RequiresBuffering ()=0
 Returns whether the filter requires buffering.
virtual const char * NameOfClass ()=0
 Returns the name of the class.
 SetMacro (DebugFlag, Bool)
 Set debugging flag.
 GetMacro (DebugFlag, Bool)
 Get debugging flag.
virtual void Debug (const char *)
 Print debugging messages if debugging is enabled.

Protected Member Functions

virtual void Initialize ()
 Initialize the filter.
virtual void Finalize ()
 Finalize the filter.

Protected Attributes

irtkGenericImage< VoxelType > * _input
 Input image for filter.
irtkGenericImage< VoxelType > * _output
 Output image for filter.

Member Function Documentation

template<class VoxelType>
virtual void irtkImageToImage< VoxelType >::Initialize (  )  [protected, virtual]

Initialize the filter.

This function must be called by any derived filter class to perform some initialize tasks.

Reimplemented in irtkResampling< VoxelType >, and irtkResamplingWithPadding< VoxelType >.

template<class VoxelType>
virtual void irtkImageToImage< VoxelType >::Finalize (  )  [protected, virtual]

Finalize the filter.

This function must be called by any derived filter class to perform some initialize tasks.

template<class VoxelType>
virtual Bool irtkImageToImage< VoxelType >::RequiresBuffering (  )  [pure virtual]

Returns whether the filter requires buffering.

Any derived class must implement this member function to indicate whether the filter should buffer the input in case that input and output are equal. For example, filters which only require the voxel value to calculate their output should return False, otherwise True.

Implemented in irtkDilation< VoxelType >, irtkErosion< VoxelType >, irtkGaussianBlurring< VoxelType >, irtkGaussianBlurring4D< VoxelType >, irtkGaussianBlurringWithPadding< VoxelType >, irtkGradientImage< VoxelType >, irtkGradientImageX< VoxelType >, irtkGradientImageY< VoxelType >, irtkGradientImageZ< VoxelType >, irtkLargestConnectedComponent< VoxelType >, irtkLargestConnectedComponentIterative< VoxelType >, irtkNoise< VoxelType >, irtkResampling< VoxelType >, and irtkResamplingWithPadding< VoxelType >.


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