Public Types | Public Member Functions | Protected Member Functions | List of all members
mirtk::ImageToImage< TVoxel > Class Template Reference

#include <ImageToImage.h>

Inheritance diagram for mirtk::ImageToImage< TVoxel >:
Inheritance graph
Collaboration diagram for mirtk::ImageToImage< TVoxel >:
Collaboration graph

Public Types

typedef GenericImage< VoxelTypeImageType
 Input/output image type.
 
typedef TVoxel VoxelType
 Input/output image voxel type.
 

Public Member Functions

 ImageToImage ()
 Constructor.
 
virtual bool RequiresBuffering () const
 
virtual void Run ()
 Run filter on entire image.
 
virtual double Run (int, int, int, int=0)
 Run filter on single voxel.
 
virtual ~ImageToImage ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Object
virtual const char * NameOfClass () const =0
 Get name of class, which this object is an instance of.
 
virtual ParameterList Parameter () const
 Get parameter name/value pairs.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual bool Set (const char *name, const char *value)
 
virtual ~Object ()
 Destructor.
 

Protected Member Functions

virtual void Finalize ()
 
void Initialize (bool)
 
virtual void Initialize ()
 
 mirtkAggregateMacro (ImageType, Buffer)
 Buffer.
 
 mirtkPublicAggregateMacro (const ImageType, Input)
 Input image for filter.
 
 mirtkPublicAggregateMacro (ImageType, Output)
 Output image for filter.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 

Additional Inherited Members

- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 
- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 

Detailed Description

template<class TVoxel>
class mirtk::ImageToImage< TVoxel >

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 38 of file ImageToImage.h.

Member Function Documentation

§ Finalize()

template<class TVoxel>
virtual void mirtk::ImageToImage< TVoxel >::Finalize ( )
protectedvirtual

§ Initialize() [1/2]

template<class TVoxel>
void mirtk::ImageToImage< TVoxel >::Initialize ( bool  )
protected

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

§ Initialize() [2/2]

template<class TVoxel>
virtual void mirtk::ImageToImage< TVoxel >::Initialize ( )
protectedvirtual

§ RequiresBuffering()

template<class TVoxel>
virtual bool mirtk::ImageToImage< TVoxel >::RequiresBuffering ( ) const
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.


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