itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkDiscreteGaussianImageFilter.h>

Inheritance diagram for itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >

Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian blurring by separable convolution of an image and a discrete Gaussian operator (kernel).

The Gaussian operator used here was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.) The Gaussian kernel used here was designed so that smoothing and derivative operations commute after discretization.

The variance or standard deviation (sigma) will be evaluated as pixel units if SetUseImageSpacing is off (false) or as physical units if SetUseImageSpacing is on (true, default). The variance can be set independently in each dimension.

When the Gaussian kernel is small, this filter tends to run faster than itk::RecursiveGaussianImageFilter.

See Also

GaussianOperator

Image

Neighborhood

NeighborhoodOperator

RecursiveGaussianImageFilter

Wiki Examples:

• All Examples
• Smooth an image with a discrete Gaussian filter

Examples:

Examples/Filtering/DiscreteGaussianImageFilter.cxx, Examples/RegistrationITKv3/ImageRegistration2.cxx, Examples/RegistrationITKv3/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, WikiExamples/Registration/MutualInformation.cxx, WikiExamples/Registration/MutualInformationAffine.cxx, WikiExamples/Registration/WatchRegistration.cxx, and WikiExamples/Smoothing/DiscreteGaussianImageFilter.cxx.

Definition at line 62 of file itkDiscreteGaussianImageFilter.h.

Public Types
using	ArrayType = FixedArray< double, Self::ImageDimension >
using	ConstPointer = SmartPointer< const Self >
using	InputImageType = TInputImage
using	InputInternalPixelType = typename TInputImage::InternalPixelType
using	InputPixelType = typename TInputImage::PixelType
using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
using	OutputImageType = TOutputImage
using	OutputInternalPixelType = typename TOutputImage::InternalPixelType
using	OutputPixelType = typename TOutputImage::PixelType
using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType
using	Pointer = SmartPointer< Self >
using	Self = DiscreteGaussianImageFilter
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 ::itk::LightObject::Pointer	CreateAnother () const
void	GenerateInputRequestedRegion () override
virtual const char *	GetNameOfClass () const
	itkLegacyMacro (unsigned int GetInternalNumberOfStreamDivisions() const)
	itkLegacyMacro (void SetInternalNumberOfStreamDivisions(unsigned int))
void	SetMaximumError (const typename ArrayType::ValueType v)
void	SetMaximumError (const double *v)
void	SetMaximumError (const float *v)
void	SetUseImageSpacingOff ()
void	SetUseImageSpacingOn ()
void	SetVariance (const double *v)
void	SetVariance (const float *v)
virtual void	SetVariance (ArrayType _arg)
virtual const ArrayType	GetVariance () const
virtual void	SetMaximumError (ArrayType _arg)
virtual const ArrayType	GetMaximumError () const
virtual int	GetMaximumKernelWidth () const
virtual void	SetMaximumKernelWidth (int _arg)
virtual unsigned int	GetFilterDimensionality () const
virtual void	SetFilterDimensionality (unsigned int _arg)
void	SetVariance (const typename ArrayType::ValueType v)
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing () const
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
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 Member Functions
static Pointer	New ()
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::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
	DiscreteGaussianImageFilter ()
void	GenerateData () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~DiscreteGaussianImageFilter () 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 ()
void	VerifyInputInformation () ITKv5_CONST override
	~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)
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	GenerateOutputInformation ()
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
unsigned int	m_FilterDimensionality
ArrayType	m_MaximumError
int	m_MaximumKernelWidth
bool	m_UseImageSpacing
ArrayType	m_Variance

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)
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 TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::ArrayType = FixedArray< double, Self::ImageDimension >

Typedef of double containers

Definition at line 100 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 72 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type information.

Definition at line 81 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 89 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 88 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputPixelValueType = typename NumericTraits<InputPixelType>::ValueType

Pixel value type for Vector pixel types

Definition at line 92 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 82 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 87 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 86 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputPixelValueType = typename NumericTraits<OutputPixelType>::ValueType

Definition at line 93 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 71 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::Self = DiscreteGaussianImageFilter

Standard class type aliases.

Definition at line 69 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Definition at line 70 of file itkDiscreteGaussianImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >

itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::DiscreteGaussianImageFilter ( )

inlineprotected

Definition at line 240 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::~DiscreteGaussianImageFilter ( )

overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Standard pipeline method. While this class does not implement a ThreadedGenerateData(), its GenerateData() delegates all calculations to an NeighborhoodOperatorImageFilter. Since the NeighborhoodOperatorImageFilter is multithreaded, this filter is multithreaded by default.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overridevirtual

DiscreteGaussianImageFilter needs a larger input requested region than the output requested region (larger by the size of the Gaussian kernel). As such, DiscreteGaussianImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See Also

ImageToImageFilter::GenerateInputRequestedRegion()

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

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetFilterDimensionality ( ) const

virtual

Set the number of dimensions to smooth. Defaults to the image dimension. Can be set to less than ImageDimension, smoothing all the dimensions less than FilterDimensionality. For instance, to smooth the slices of a volume without smoothing in Z, set the FilterDimensionality to 2.

template<typename TInputImage , typename TOutputImage >

virtual const ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetMaximumError ( ) const

virtual

The algorithm will size the discrete kernel so that the error resulting from truncation of the kernel is no greater than MaximumError. The default is 0.01 in each dimension.

template<typename TInputImage , typename TOutputImage >

virtual int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetMaximumKernelWidth ( ) const

virtual

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

template<typename TInputImage , typename TOutputImage >

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

virtual

Run-time type information (and related methods).

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

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<typename TInputImage , typename TOutputImage >

virtual bool itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing ( ) const

virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<typename TInputImage , typename TOutputImage >

virtual const ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetVariance ( ) const

virtual

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. If UseImageSpacing is true, the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

template<typename TInputImage , typename TOutputImage >

itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::itkLegacyMacro

(

unsigned int GetInternalNumberOfStreamDivisions()

const

)

Set/Get number of pieces to divide the input for the internal composite pipeline. The upstream pipeline will not be effected.

The default value is $ImageDimension^2$.

This parameter was introduced to reduce the memory used by images internally, at the cost of performance.

template<typename TInputImage , typename TOutputImage >

itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::itkLegacyMacro

(

void

SetInternalNumberOfStreamDivisionsunsigned int

)

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, 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::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetFilterDimensionality ( unsigned int  _arg )

virtual

Set the number of dimensions to smooth. Defaults to the image dimension. Can be set to less than ImageDimension, smoothing all the dimensions less than FilterDimensionality. For instance, to smooth the slices of a volume without smoothing in Z, set the FilterDimensionality to 2.

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( ArrayType  _arg )

virtual

The algorithm will size the discrete kernel so that the error resulting from truncation of the kernel is no greater than MaximumError. The default is 0.01 in each dimension.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const typename ArrayType::ValueType  v )

inline

Definition at line 143 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const double *  v )

inline

Definition at line 171 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const float *  v )

inline

Definition at line 182 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumKernelWidth ( int  _arg )

virtual

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing ( bool  _arg )

virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOff ( )

inline

Ignore the image spacing. Use this option if you want to specify Gaussian variance in pixels. Default is ImageSpacingOn.

Definition at line 201 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOn ( )

inline

Use the image spacing information in calculations. Use this option if you want to specify Gaussian variance in real world units. Default is ImageSpacingOn.

Definition at line 196 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( ArrayType  _arg )

virtual

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. If UseImageSpacing is true, the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const typename ArrayType::ValueType  v )

inline

Convenience Set methods for setting all dimensional parameters to the same values.

Definition at line 136 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const double *  v )

inline

Definition at line 149 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const float *  v )

inline

Definition at line 160 of file itkDiscreteGaussianImageFilter.h.

Member Data Documentation

template<typename TInputImage , typename TOutputImage >

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

static

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 97 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_FilterDimensionality

private

Number of dimensions to process. Default is all dimensions

Definition at line 274 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_MaximumError

private

The maximum error of the gaussian blurring kernel in each dimensional direction. For definition of maximum error, see GaussianOperator.

See Also

GaussianOperator

Definition at line 267 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_MaximumKernelWidth

private

Maximum allowed kernel width for any dimension of the discrete Gaussian approximation

Definition at line 271 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

bool itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing

private

Flag to indicate whether to use image spacing

Definition at line 277 of file itkDiscreteGaussianImageFilter.h.

template<typename TInputImage , typename TOutputImage >

ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_Variance

private

The variance of the gaussian blurring kernel in each dimensional direction.

Definition at line 262 of file itkDiscreteGaussianImageFilter.h.

---

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

• itkDiscreteGaussianImageFilter.h