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

#include <CubicBSplineConvolution.h>

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

Public Member Functions

 CubicBSplineConvolution (double=2.)
 Constructor.
 
 CubicBSplineConvolution (double, double, double=0., double=0.)
 Constructor.
 
virtual void Radius (double)
 Set isotropic radius of spatial cubic B-spline support region.
 
virtual void Radius (double, double, double=0., double=0.)
 Set radius of cubic B-spline support region.
 
 ~CubicBSplineConvolution ()
 Destructor.
 
- Public Member Functions inherited from mirtk::SeparableConvolution< TVoxel >
bool CheckKernel (const KernelType *) const
 Check if given kernel is valid.
 
void Kernel (const KernelType *)
 Set isotropic convolution kernel for all dimensions.
 
virtual void Run ()
 Convolve image.
 
virtual void RunT ()
 Convolve image along t only.
 
virtual void RunX ()
 Convolve image along x only.
 
virtual void RunY ()
 Convolve image along y only.
 
virtual void RunZ ()
 Convolve image along z only.
 
 SeparableConvolution (const KernelType *k=nullptr)
 
 SeparableConvolution (const KernelType *kx, const KernelType *ky, const KernelType *kz=nullptr, const KernelType *kt=nullptr)
 
 ~SeparableConvolution ()
 Destructor.
 
- 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.
 

Static Public Member Functions

static int KernelSize (double)
 Kernel size used for a given radius (divided by voxel size)
 
- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 

Protected Types

typedef SeparableConvolution< TVoxel >::KernelType KernelType
 Type of convolution kernels.
 

Protected Member Functions

virtual void Initialize ()
 Initialize filter.
 
UniquePtr< KernelTypeInitializeKernel (double)
 Initialize 1D cubic B-spline kernel with radius given in voxel units.
 
 mirtkAttributeMacro (double, RadiusX)
 
 mirtkAttributeMacro (double, RadiusY)
 
 mirtkAttributeMacro (double, RadiusZ)
 
 mirtkAttributeMacro (double, RadiusT)
 
- Protected Member Functions inherited from mirtk::SeparableConvolution< TVoxel >
virtual void Finalize ()
 Finalize filter.
 
 mirtkPublicAggregateMacro (const KernelType, KernelX)
 Convolution kernel along x axis.
 
 mirtkPublicAggregateMacro (const KernelType, KernelY)
 Convolution kernel along y axis.
 
 mirtkPublicAggregateMacro (const KernelType, KernelZ)
 Convolution kernel along z axis.
 
 mirtkPublicAggregateMacro (const KernelType, KernelT)
 Convolution kernel along t axis.
 
 mirtkPublicAttributeMacro (bool, Normalize)
 Whether to normalize kernels.
 
 mirtkPublicAttributeMacro (bool, UseBackgroundMask)
 
 mirtkPublicAttributeMacro (bool, UseBackgroundValue)
 
 mirtkPublicAttributeMacro (bool, UsePaddingValue)
 
 mirtkPublicAttributeMacro (double, PaddingValue)
 Padding value.
 
 mirtkPublicAttributeMacro (int, Components)
 
- 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

- Public Types inherited from mirtk::SeparableConvolution< TVoxel >
typedef GenericImage< RealPixel > KernelType
 Type of convolution kernel.
 
- Public Types inherited from mirtk::ImageToImage< TVoxel >
typedef GenericImage< VoxelTypeImageType
 Input/output image type.
 
typedef TVoxel VoxelType
 Input/output image voxel 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::CubicBSplineConvolution< TVoxel >

Convolves image with separable cubic B-spline kernel

Definition at line 33 of file CubicBSplineConvolution.h.

Member Function Documentation

§ mirtkAttributeMacro() [1/4]

template<class TVoxel >
mirtk::CubicBSplineConvolution< TVoxel >::mirtkAttributeMacro ( double  ,
RadiusX   
)
protected

Radius of cubic B-spline support region along x axis

  • r<0: voxel units
  • r=0: no smoothing in x
  • r>0: mm units

§ mirtkAttributeMacro() [2/4]

template<class TVoxel >
mirtk::CubicBSplineConvolution< TVoxel >::mirtkAttributeMacro ( double  ,
RadiusY   
)
protected

Radius of cubic B-spline support region along y axis

  • r<0: voxel units
  • r=0: no smoothing in y
  • r>0: mm units

§ mirtkAttributeMacro() [3/4]

template<class TVoxel >
mirtk::CubicBSplineConvolution< TVoxel >::mirtkAttributeMacro ( double  ,
RadiusZ   
)
protected

Radius of cubic B-spline support region along z axis

  • r<0: voxel units
  • r=0: no smoothing in z
  • r>0: mm units

§ mirtkAttributeMacro() [4/4]

template<class TVoxel >
mirtk::CubicBSplineConvolution< TVoxel >::mirtkAttributeMacro ( double  ,
RadiusT   
)
protected

Radius of cubic B-spline support region along t axis

  • r<0: voxel units
  • r=0: no smoothing in t
  • r>0: mm units

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