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

#include <GradientImageFilter.h>

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

Public Types

enum  GradientType
 Type of image gradient to compute.
 
- Public Types inherited from mirtk::ImageToImage< TVoxel >
typedef GenericImage< VoxelTypeImageType
 Input/output image type.
 
typedef TVoxel VoxelType
 Input/output image voxel type.
 

Public Member Functions

 GradientImageFilter (GradientType type=GRADIENT_MAGNITUDE)
 Constructor.
 
virtual void Run ()
 Run the convolution filter.
 
- Public Member Functions inherited from mirtk::ImageToImage< TVoxel >
 ImageToImage ()
 Constructor.
 
virtual bool RequiresBuffering () const
 
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 ()
 Finalize filter execution.
 
virtual void Initialize ()
 Initialize filter after inputs and parameters are set.
 
 mirtkPublicAttributeMacro (GradientType, Type)
 Type of gradient.
 
 mirtkPublicAttributeMacro (bool, UseVoxelSize)
 Whether to return gradient in mm or voxel units.
 
 mirtkPublicAttributeMacro (bool, UseOrientation)
 Whether to return gradient in world orientation.
 
 mirtkPublicAttributeMacro (double, PaddingValue)
 Padding value.
 
- Protected Member Functions inherited from mirtk::ImageToImage< TVoxel >
void Initialize (bool)
 
 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::GradientImageFilter< TVoxel >

Class for calculating the gradient of an image.

The class provides an interface to calculating the gradient in the x, y and z directions. It also can process vector-valued input images, where each vector component is treated separately. If the output for each component is a 3D gradient vector, the output image contains first the gradient vector for the first input component, then the gradient vector of the second component, and so on. In case of a scalar gradient output such as the gradient vector magnitude, the output image has the same number of components (t dimension) as the input image.

Definition at line 43 of file GradientImageFilter.h.


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