SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ConvolutionImageFilter Class Reference

Convolve a given image with an arbitrary image kernel. More...

#include <sitkConvolutionImageFilter.h>

+ Inheritance diagram for itk::simple::ConvolutionImageFilter:
+ Collaboration diagram for itk::simple::ConvolutionImageFilter:

Public Types

enum  BoundaryConditionType {
enum  OutputRegionModeType {
using PixelIDTypeList = BasicPixelIDTypeList
using Self = ConvolutionImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

 ConvolutionImageFilter ()
Image Execute (const Image &image, const Image &kernelImage)
BoundaryConditionType GetBoundaryCondition () const
std::string GetName () const
bool GetNormalize () const
OutputRegionModeType GetOutputRegionMode () const
SelfNormalizeOff ()
SelfNormalizeOn ()
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
SelfSetNormalize (bool Normalize)
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
std::string ToString () const
virtual ~ConvolutionImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const
virtual void SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int GetNumberOfWorkUnits () const

Private Types

using MemberFunctionType = Image(Self::*)(const Image *image, const Image *kernelImage)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *kernelImage)

Private Attributes

BoundaryConditionType m_BoundaryCondition {itk::simple::ConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
bool m_Normalize {false}
OutputRegionModeType m_OutputRegionMode {itk::simple::ConvolutionImageFilter::SAME}


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 NonCopyable (const NonCopyable &)=delete
NonCopyableoperator= (const NonCopyable &)=delete
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Convolve a given image with an arbitrary image kernel.

This filter operates by centering the flipped kernel at each pixel in the image and computing the inner product between pixel values in the image and pixel values in the kernel. The center of the kernel is defined as \( \lfloor (2*i+s-1)/2 \rfloor \) where \(i\) is the index and \(s\) is the size of the largest possible region of the kernel image. For kernels with odd sizes in all dimensions, this corresponds to the center pixel. If a dimension of the kernel image has an even size, then the center index of the kernel in that dimension will be the largest integral index that is less than the continuous index of the image center.

The kernel can optionally be normalized to sum to 1 using NormalizeOn() . Normalization is off by default.

This filter ignores the spacing, origin, and orientation of the kernel image and treats them as identical to those in the input image.

This code was contributed in the Insight Journal paper:

"Image Kernel Convolution" by Tustison N., Gee J.

Nicholas J. Tustison
James C. Gee
See also
itk::simple::Convolution for the procedural interface
itk::ConvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 56 of file sitkConvolutionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ConvolutionImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * kernelImage )

Setup for member function dispatching

Definition at line 120 of file sitkConvolutionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkConvolutionImageFilter.h.

◆ Self

Definition at line 58 of file sitkConvolutionImageFilter.h.

Member Enumeration Documentation

◆ BoundaryConditionType


Definition at line 85 of file sitkConvolutionImageFilter.h.

◆ OutputRegionModeType


Definition at line 95 of file sitkConvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~ConvolutionImageFilter()

virtual itk::simple::ConvolutionImageFilter::~ConvolutionImageFilter ( )


◆ ConvolutionImageFilter()

itk::simple::ConvolutionImageFilter::ConvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::ConvolutionImageFilter::Execute ( const Image image,
const Image kernelImage 

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::ConvolutionImageFilter::ExecuteInternal ( const Image image,
const Image kernelImage 

◆ GetBoundaryCondition()

BoundaryConditionType itk::simple::ConvolutionImageFilter::GetBoundaryCondition ( ) const

Definition at line 93 of file sitkConvolutionImageFilter.h.

◆ GetName()

std::string itk::simple::ConvolutionImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkConvolutionImageFilter.h.

◆ GetNormalize()

bool itk::simple::ConvolutionImageFilter::GetNormalize ( ) const

Definition at line 83 of file sitkConvolutionImageFilter.h.

◆ GetOutputRegionMode()

OutputRegionModeType itk::simple::ConvolutionImageFilter::GetOutputRegionMode ( ) const

Definition at line 103 of file sitkConvolutionImageFilter.h.

◆ NormalizeOff()

Self& itk::simple::ConvolutionImageFilter::NormalizeOff ( )

Definition at line 79 of file sitkConvolutionImageFilter.h.

◆ NormalizeOn()

Self& itk::simple::ConvolutionImageFilter::NormalizeOn ( )

Set the value of Normalize to true or false respectfully.

Definition at line 78 of file sitkConvolutionImageFilter.h.

◆ SetBoundaryCondition()

Self& itk::simple::ConvolutionImageFilter::SetBoundaryCondition ( BoundaryConditionType  BoundaryCondition)

Definition at line 89 of file sitkConvolutionImageFilter.h.

◆ SetNormalize()

Self& itk::simple::ConvolutionImageFilter::SetNormalize ( bool  Normalize)

Normalize the output image by the sum of the kernel components

Definition at line 75 of file sitkConvolutionImageFilter.h.

References itk::simple::Normalize().

◆ SetOutputRegionMode()

Self& itk::simple::ConvolutionImageFilter::SetOutputRegionMode ( OutputRegionModeType  OutputRegionMode)

Definition at line 99 of file sitkConvolutionImageFilter.h.

◆ ToString()

std::string itk::simple::ConvolutionImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 124 of file sitkConvolutionImageFilter.h.

Member Data Documentation

◆ m_BoundaryCondition

BoundaryConditionType itk::simple::ConvolutionImageFilter::m_BoundaryCondition {itk::simple::ConvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}

Definition at line 132 of file sitkConvolutionImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ConvolutionImageFilter::m_MemberFactory

Definition at line 126 of file sitkConvolutionImageFilter.h.

◆ m_Normalize

bool itk::simple::ConvolutionImageFilter::m_Normalize {false}

Definition at line 130 of file sitkConvolutionImageFilter.h.

◆ m_OutputRegionMode

OutputRegionModeType itk::simple::ConvolutionImageFilter::m_OutputRegionMode {itk::simple::ConvolutionImageFilter::SAME}

Definition at line 134 of file sitkConvolutionImageFilter.h.

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