itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > Class Template Reference

#include <itkConvolutionImageFilterBase.h>

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

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

Detailed Description

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

Abstract base class for the convolution image filters.

See Also

ConvolutionImageFilter FFTConvolutionImageFilter

Definition at line 35 of file itkConvolutionImageFilterBase.h.

Public Types
using	BoundaryConditionPointerType = BoundaryConditionType *
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
enum	OutputRegionModeType {   SAME = 0,   VALID }
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	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
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
virtual const char *	GetNameOfClass () const
virtual void	SetBoundaryCondition (BoundaryConditionPointerType _arg)
virtual BoundaryConditionPointerType	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	NormalizeOff ()
virtual void	SetOutputRegionMode (const OutputRegionModeType _arg)
virtual OutputRegionModeType	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 *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
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 *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
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 const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
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 flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Attributes
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
	ConvolutionImageFilterBase ()
void	GenerateOutputInformation () override
OutputRegionType	GetValidRegion () const
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_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)
void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
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 &outputRegionForThread, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
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	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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions () ITKv5_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 idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 Attributes
BoundaryConditionPointerType	m_BoundaryCondition
DefaultBoundaryConditionType	m_DefaultBoundaryCondition
bool	m_Normalize { false }
OutputRegionModeType	m_OutputRegionMode

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
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)
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading
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

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

using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::BoundaryConditionPointerType = BoundaryConditionType *

Definition at line 71 of file itkConvolutionImageFilterBase.h.

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

using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::BoundaryConditionType = ImageBoundaryCondition< TInputImage >

Typedef to describe the boundary condition.

Definition at line 70 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 44 of file itkConvolutionImageFilterBase.h.

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

using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage >

Definition at line 72 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 52 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 58 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 55 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 65 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 61 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 54 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 60 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 57 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 67 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 63 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 53 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 59 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 56 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 66 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 62 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 43 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 41 of file itkConvolutionImageFilterBase.h.

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

using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SizeValueType = typename InputSizeType::SizeValueType

Definition at line 64 of file itkConvolutionImageFilterBase.h.

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

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

Definition at line 42 of file itkConvolutionImageFilterBase.h.

Member Enumeration Documentation

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

enum itk::ConvolutionImageFilterBase::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 91 of file itkConvolutionImageFilterBase.h.

Constructor & Destructor Documentation

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

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

protected

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

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

overrideprotecteddefault

Member Function Documentation

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

void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

The largest possible output region may differ from the largest possible input region.

Reimplemented from itk::ProcessObject.

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

virtual BoundaryConditionPointerType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetBoundaryCondition ( ) const

virtual

Set/get the boundary condition.

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

virtual const KernelImageType* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetKernelImage ( ) const

virtual

Set/get the image kernel.

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

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

virtual

Run-time type information ( and related methods )

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

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >, itk::ProjectedLandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >, itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::FFTConvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage, double >, and itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

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

virtual bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetNormalize ( ) const

virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

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

virtual OutputRegionModeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetOutputRegionMode ( ) const

virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

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

OutputRegionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetValidRegion ( ) const

protected

Get the valid region of the convolution.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::NormalizeOff ( )

virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::NormalizeOn ( )

virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

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

void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

Reimplemented in itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::FFTConvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage, double >, itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >, itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetBoundaryCondition ( BoundaryConditionPointerType  _arg )

virtual

Set/get the boundary condition.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetKernelImage ( const KernelImageType *  input )

virtual

Set/get the image kernel.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetNormalize ( bool  _arg )

virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionMode ( const OutputRegionModeType  _arg )

virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionModeToSame ( )

virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

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

virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionModeToValid ( )

virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

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

void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::VerifyInputInformation ( )

inlineoverrideprotectedvirtual

Default superclass implementation ensures that input images occupy same physical space. This is not needed for this filter.

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

Definition at line 127 of file itkConvolutionImageFilterBase.h.

Member Data Documentation

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

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

static

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

Definition at line 50 of file itkConvolutionImageFilterBase.h.

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

BoundaryConditionPointerType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_BoundaryCondition

private

Definition at line 133 of file itkConvolutionImageFilterBase.h.

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

DefaultBoundaryConditionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_DefaultBoundaryCondition

private

Definition at line 132 of file itkConvolutionImageFilterBase.h.

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

bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_Normalize { false }

private

Definition at line 130 of file itkConvolutionImageFilterBase.h.

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

OutputRegionModeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_OutputRegionMode

private

Definition at line 135 of file itkConvolutionImageFilterBase.h.

---

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

• itkConvolutionImageFilterBase.h