#include <itkConvolutionImageFilter.h>

Detailed Description

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
class itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >

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://doi.org/10.54294/e292kx

Author: Nicholas J. Tustison; James C. Gee

ITK Sphinx Examples:

All ITK Sphinx Examples

Convolve Image With Kernel

Examples: SphinxExamples/src/Filtering/Convolution/ConvolveImageWithKernel/Code.cxx.

Definition at line 65 of file itkConvolutionImageFilter.h.

Inheritance diagram for itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >:

Collaboration diagram for itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageType = TInputImage

using	InputIndexType = typename InputImageType::IndexType

using	InputPixelType = typename InputImageType::PixelType

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	KernelImageType = TKernelImage

using	KernelIndexType = typename KernelImageType::IndexType

using	KernelPixelType = typename KernelImageType::PixelType

using	KernelRegionType = typename KernelImageType::RegionType

using	KernelSizeType = typename KernelImageType::SizeType

using	OutputImageType = TOutputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	Pointer = SmartPointer< Self >

using	Self = ConvolutionImageFilter

using	Superclass = ConvolutionImageFilterBase< TInputImage, TOutputImage >

Public Types inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
using	BoundaryConditionType = ImageBoundaryCondition< TInputImage >

using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage >

using	InputImageType = TInputImage

using	InputIndexType = typename InputImageType::IndexType

using	InputPixelType = typename InputImageType::PixelType

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	KernelImageType = TKernelImage

using	KernelIndexType = typename KernelImageType::IndexType

using	KernelPixelType = typename KernelImageType::PixelType

using	KernelRegionType = typename KernelImageType::RegionType

using	KernelSizeType = typename KernelImageType::SizeType

using	OutputImageType = TOutputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	Pointer = SmartPointer< Self >

using	Self = ConvolutionImageFilterBase

using	SizeValueType = typename InputSizeType::SizeValueType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
const char *	GetNameOfClass () const override

virtual void	SetBoundaryCondition (BoundaryConditionType *_arg)

virtual BoundaryConditionType *	GetBoundaryCondition () const

virtual void	SetKernelImage (const KernelImageType *input)

virtual const KernelImageType *	GetKernelImage () const

virtual void	SetNormalize (bool _arg)

virtual bool	GetNormalize () const

virtual void	NormalizeOn ()

virtual void	SetOutputRegionMode (const OutputRegionModeEnum _arg)

virtual OutputRegionModeEnum	GetOutputRegionMode () const

virtual void	SetOutputRegionModeToSame ()

virtual void	SetOutputRegionModeToValid ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
	ConvolutionImageFilter ()=default

void	GenerateData () override

void	GenerateInputRequestedRegion () override

bool	GetKernelNeedsPadding () const

KernelSizeType	GetKernelPadSize () const

template<typename TImage >
KernelSizeType	GetKernelRadius (const TImage *kernelImage) const

	~ConvolutionImageFilter () override=default

Protected Member Functions inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
	ConvolutionImageFilterBase ()

void	GenerateOutputInformation () override

OutputRegionType	GetValidRegion () const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ConvolutionImageFilterBase () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
template<typename TImage >
void	ComputeConvolution (const TImage kernelImage, ProgressAccumulator progress)

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 74 of file itkConvolutionImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputImageType = TInputImage

Definition at line 85 of file itkConvolutionImageFilter.h.

◆ InputIndexType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputIndexType = typename InputImageType::IndexType

Definition at line 91 of file itkConvolutionImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 88 of file itkConvolutionImageFilter.h.

◆ InputRegionType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputRegionType = typename InputImageType::RegionType

Definition at line 97 of file itkConvolutionImageFilter.h.

◆ InputSizeType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 94 of file itkConvolutionImageFilter.h.

◆ KernelImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelImageType = TKernelImage

Definition at line 87 of file itkConvolutionImageFilter.h.

◆ KernelIndexType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelIndexType = typename KernelImageType::IndexType

Definition at line 93 of file itkConvolutionImageFilter.h.

◆ KernelPixelType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelPixelType = typename KernelImageType::PixelType

Definition at line 90 of file itkConvolutionImageFilter.h.

◆ KernelRegionType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelRegionType = typename KernelImageType::RegionType

Definition at line 99 of file itkConvolutionImageFilter.h.

◆ KernelSizeType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelSizeType = typename KernelImageType::SizeType

Definition at line 96 of file itkConvolutionImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 86 of file itkConvolutionImageFilter.h.

◆ OutputIndexType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 92 of file itkConvolutionImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 89 of file itkConvolutionImageFilter.h.

◆ OutputRegionType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputRegionType = typename OutputImageType::RegionType

Definition at line 98 of file itkConvolutionImageFilter.h.

◆ OutputSizeType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 95 of file itkConvolutionImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 73 of file itkConvolutionImageFilter.h.

◆ Self

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Self = ConvolutionImageFilter

Definition at line 71 of file itkConvolutionImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

using itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Superclass = ConvolutionImageFilterBase<TInputImage, TOutputImage>

Definition at line 72 of file itkConvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ConvolutionImageFilter()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::ConvolutionImageFilter ( )

protecteddefault

◆ ~ConvolutionImageFilter()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::~ConvolutionImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeConvolution()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

template<typename TImage >

void itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::ComputeConvolution	(	const TImage *	kernelImage,
		ProgressAccumulator *	progress
	)

private

◆ GenerateData()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

void itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

This filter uses a minipipeline to compute the output.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

void itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

ConvolutionImageFilter needs the entire image kernel, which in general is going to be a different size then the output requested region. As such, this filter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetKernelNeedsPadding()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

bool itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetKernelNeedsPadding ( ) const

protected

The kernel needs padding if any of the sizes of its dimensions is even. This method checks for this condition.

◆ GetKernelPadSize()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

KernelSizeType itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetKernelPadSize ( ) const

protected

Calculates the padding width needed to make each dimension odd.

◆ GetKernelRadius()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

template<typename TImage >

KernelSizeType itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetKernelRadius ( const TImage * kernelImage ) const

protected

Calculates the radius of the kernel.

◆ GetNameOfClass()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

const char* itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ New()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

static Pointer itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>

constexpr unsigned int itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

Dimensionality of input and output data is assumed to be the same.

Definition at line 83 of file itkConvolutionImageFilter.h.

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

itkConvolutionImageFilter.h

Detailed Description

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage> class itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImageType

◆ InputIndexType

◆ InputPixelType

◆ InputRegionType

◆ InputSizeType

◆ KernelImageType

◆ KernelIndexType

◆ KernelPixelType

◆ KernelRegionType

◆ KernelSizeType

◆ OutputImageType

◆ OutputIndexType

◆ OutputPixelType

◆ OutputRegionType

◆ OutputSizeType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ConvolutionImageFilter()

◆ ~ConvolutionImageFilter()

Member Function Documentation

◆ ComputeConvolution()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetKernelNeedsPadding()

◆ GetKernelPadSize()

◆ GetKernelRadius()

◆ GetNameOfClass()

◆ New()

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
class itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >