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 { ZERO_PAD, ZERO_FLUX_NEUMANN_PAD, PERIODIC_PAD }

enum	OutputRegionModeType { SAME, VALID }

typedef BasicPixelIDTypeList	PixelIDTypeList

typedef ConvolutionImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	ConvolutionImageFilter ()

Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, const Image &image2, bool normalize, ConvolutionImageFilter::BoundaryConditionType boundaryCondition, ConvolutionImageFilter::OutputRegionModeType outputRegionMode)

BoundaryConditionType	GetBoundaryCondition () const

std::string	GetName () const

bool	GetNormalize () const

OutputRegionModeType	GetOutputRegionMode () const

Self &	NormalizeOff ()

Self &	NormalizeOn ()

Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)

Self &	SetNormalize (bool Normalize)

Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)

std::string	ToString () const

	~ConvolutionImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1, const Image &image2)

Private Attributes
BoundaryConditionType	m_BoundaryCondition

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_Normalize

OutputRegionModeType	m_OutputRegionMode

Friends
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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

static const itk::EventObject &	GetITKEventObject (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.

Warning: 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. https://hdl.handle.net/1926/1323 http://www.insight-journal.org/browse/publication/208

Author: Nicholas J. Tustison

James C. Gee

Wiki Examples:

All Examples

Convolve an image with a kernel
See also
itk::simple::Convolution for the procedural interface

itk::ConvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 60 of file sitkConvolutionImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ConvolutionImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

private

Setup for member function dispatching

Definition at line 128 of file sitkConvolutionImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ConvolutionImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 72 of file sitkConvolutionImageFilter.h.

typedef ConvolutionImageFilter itk::simple::ConvolutionImageFilter::Self

Definition at line 62 of file sitkConvolutionImageFilter.h.

Member Enumeration Documentation

enum itk::simple::ConvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 90 of file sitkConvolutionImageFilter.h.

enum itk::simple::ConvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 100 of file sitkConvolutionImageFilter.h.

Constructor & Destructor Documentation

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

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

Image itk::simple::ConvolutionImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

Execute the filter on the input images

Image itk::simple::ConvolutionImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		bool	normalize,
		ConvolutionImageFilter::BoundaryConditionType	boundaryCondition,
		ConvolutionImageFilter::OutputRegionModeType	outputRegionMode
	)