ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkDiscreteGaussianImageFilter.h>

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

Public Types

using ArrayType = FixedArray< double, Self::ImageDimension >
 
using BoundaryConditionType = ImageBoundaryCondition< TInputImage >
 
using ConstPointer = SmartPointer< const Self >
 
using InputBoundaryConditionPointerType = BoundaryConditionType *
 
using InputDefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage >
 
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 RealBoundaryConditionPointerType = ImageBoundaryCondition< RealOutputImageType > *
 
using RealDefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< RealOutputImageType >
 
using RealOutputImageType = Image< OutputPixelType, ImageDimension >
 
using RealOutputPixelType = typename NumericTraits< OutputPixelType >::RealType
 
using RealOutputPixelValueType = typename NumericTraits< RealOutputPixelType >::ValueType
 
using ScalarRealType = double
 
using Self = DiscreteGaussianImageFilter
 
using SigmaArrayType = ArrayType
 
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
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (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 DataObjectIdentifierType &key, DataObject *input)
 
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 >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
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 ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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
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::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- 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
 
ArrayType m_Variance
 
ArrayType m_MaximumError
 
int m_MaximumKernelWidth
 
unsigned int m_FilterDimensionality
 
bool m_UseImageSpacing
 
InputBoundaryConditionPointerType m_InputBoundaryCondition
 
InputDefaultBoundaryConditionType m_InputDefaultBoundaryCondition
 
RealBoundaryConditionPointerType m_RealBoundaryCondition
 
RealDefaultBoundaryConditionType m_RealDefaultBoundaryCondition
 
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)
 
virtual void SetInputBoundaryCondition (InputBoundaryConditionPointerType _arg)
 
virtual InputBoundaryConditionPointerType GetInputBoundaryCondition () const
 
virtual void SetRealBoundaryCondition (RealBoundaryConditionPointerType _arg)
 
virtual RealBoundaryConditionPointerType GetRealBoundaryCondition () const
 
void SetVariance (const typename ArrayType::ValueType v)
 
void SetMaximumError (const typename ArrayType::ValueType v)
 
void SetVariance (const double *v)
 
void SetVariance (const float *v)
 
void SetSigmaArray (const ArrayType &sigmas)
 
void SetSigma (double sigma)
 
ArrayType GetSigmaArray () const
 
double GetSigma () const
 
void SetMaximumError (const double *v)
 
void SetMaximumError (const float *v)
 
void SetUseImageSpacingOn ()
 
void SetUseImageSpacingOff ()
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual bool GetUseImageSpacing () const
 
 itkLegacyMacro (unsigned int GetInternalNumberOfStreamDivisions() const)
 
 itkLegacyMacro (void SetInternalNumberOfStreamDivisions(unsigned int))
 
void GenerateInputRequestedRegion () override
 
 DiscreteGaussianImageFilter ()
 
 ~DiscreteGaussianImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 

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 >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
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
ITK Sphinx Examples:
Examples
Examples/Filtering/DiscreteGaussianImageFilter.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, SphinxExamples/src/Core/Transform/MutualInformationAffine/Code.cxx, SphinxExamples/src/Filtering/Smoothing/SmoothImageWithDiscreteGaussianFilter/Code.cxx, SphinxExamples/src/Registration/Common/MutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, and SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx.

Definition at line 63 of file itkDiscreteGaussianImageFilter.h.

Member Typedef Documentation

◆ ArrayType

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

Typedef of double containers

Definition at line 112 of file itkDiscreteGaussianImageFilter.h.

◆ BoundaryConditionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::BoundaryConditionType = ImageBoundaryCondition<TInputImage>

Typedef to describe the boundary condition.

Definition at line 105 of file itkDiscreteGaussianImageFilter.h.

◆ ConstPointer

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

Definition at line 72 of file itkDiscreteGaussianImageFilter.h.

◆ InputBoundaryConditionPointerType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputBoundaryConditionPointerType = BoundaryConditionType *

Definition at line 106 of file itkDiscreteGaussianImageFilter.h.

◆ InputDefaultBoundaryConditionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputDefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<TInputImage>

Definition at line 107 of file itkDiscreteGaussianImageFilter.h.

◆ InputImageType

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

Image type information.

Definition at line 81 of file itkDiscreteGaussianImageFilter.h.

◆ InputInternalPixelType

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

Definition at line 89 of file itkDiscreteGaussianImageFilter.h.

◆ InputPixelType

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

Definition at line 88 of file itkDiscreteGaussianImageFilter.h.

◆ InputPixelValueType

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ OutputImageType

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

Definition at line 82 of file itkDiscreteGaussianImageFilter.h.

◆ OutputInternalPixelType

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

Definition at line 87 of file itkDiscreteGaussianImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ OutputPixelValueType

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

Definition at line 93 of file itkDiscreteGaussianImageFilter.h.

◆ Pointer

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

Definition at line 71 of file itkDiscreteGaussianImageFilter.h.

◆ RealBoundaryConditionPointerType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::RealBoundaryConditionPointerType = ImageBoundaryCondition<RealOutputImageType> *

Definition at line 108 of file itkDiscreteGaussianImageFilter.h.

◆ RealDefaultBoundaryConditionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::RealDefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<RealOutputImageType>

Definition at line 109 of file itkDiscreteGaussianImageFilter.h.

◆ RealOutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::RealOutputImageType = Image<OutputPixelType, ImageDimension>

Definition at line 101 of file itkDiscreteGaussianImageFilter.h.

◆ RealOutputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::RealOutputPixelType = typename NumericTraits<OutputPixelType>::RealType

Type of the pixel to use for intermediate results

Definition at line 100 of file itkDiscreteGaussianImageFilter.h.

◆ RealOutputPixelValueType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::RealOutputPixelValueType = typename NumericTraits<RealOutputPixelType>::ValueType

Definition at line 102 of file itkDiscreteGaussianImageFilter.h.

◆ ScalarRealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::ScalarRealType = double

Definition at line 114 of file itkDiscreteGaussianImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 69 of file itkDiscreteGaussianImageFilter.h.

◆ SigmaArrayType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SigmaArrayType = ArrayType

Definition at line 113 of file itkDiscreteGaussianImageFilter.h.

◆ Superclass

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

Definition at line 70 of file itkDiscreteGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ DiscreteGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::DiscreteGaussianImageFilter ( )
inlineprotected

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

Definition at line 315 of file itkDiscreteGaussianImageFilter.h.

◆ ~DiscreteGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::~DiscreteGaussianImageFilter ( )
overrideprotecteddefault

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

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage = TInputImage>
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 > >.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
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 > >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage>
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 >.

◆ GetFilterDimensionality()

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ GetInputBoundaryCondition()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual InputBoundaryConditionPointerType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetInputBoundaryCondition ( ) const
virtual

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

◆ GetMaximumError()

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

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

◆ GetMaximumKernelWidth()

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ GetNameOfClass()

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

◆ GetRealBoundaryCondition()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual RealBoundaryConditionPointerType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetRealBoundaryCondition ( ) const
virtual

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

◆ GetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>
double itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetSigma ( ) const
inline

Get the Sigma scalar. If the Sigma is anisotropic, we will just return the Sigma along the first dimension.

Definition at line 233 of file itkDiscreteGaussianImageFilter.h.

◆ GetSigmaArray()

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetSigmaArray ( ) const
inline

Get the Sigma value.

Definition at line 219 of file itkDiscreteGaussianImageFilter.h.

◆ GetUseImageSpacing()

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

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

◆ GetVariance()

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

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

◆ itkLegacyMacro() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ itkLegacyMacro() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::itkLegacyMacro ( void   SetInternalNumberOfStreamDivisionsunsigned int)

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

◆ SetFilterDimensionality()

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

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

◆ SetInputBoundaryCondition()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetInputBoundaryCondition ( InputBoundaryConditionPointerType  _arg)
virtual

Set/get the boundary condition.

◆ SetMaximumError() [1/4]

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ SetMaximumError() [2/4]

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

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

Definition at line 239 of file itkDiscreteGaussianImageFilter.h.

◆ SetMaximumError() [3/4]

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

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

Definition at line 251 of file itkDiscreteGaussianImageFilter.h.

◆ SetMaximumError() [4/4]

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

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

Definition at line 166 of file itkDiscreteGaussianImageFilter.h.

◆ SetMaximumKernelWidth()

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

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

◆ SetRealBoundaryCondition()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetRealBoundaryCondition ( RealBoundaryConditionPointerType  _arg)
virtual

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

◆ SetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetSigma ( double  sigma)
inline

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

Definition at line 211 of file itkDiscreteGaussianImageFilter.h.

◆ SetSigmaArray()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetSigmaArray ( const ArrayType sigmas)
inline

Set the standard deviation of the Gaussian used for smoothing. Sigma is measured in the units of image spacing. You may use the method SetSigma to set the same value across each axis or use the method SetSigmaArray if you need different values along each axis.

Definition at line 201 of file itkDiscreteGaussianImageFilter.h.

◆ SetUseImageSpacing()

template<typename TInputImage , typename TOutputImage = TInputImage>
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

◆ SetUseImageSpacingOff()

template<typename TInputImage , typename TOutputImage = TInputImage>
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 274 of file itkDiscreteGaussianImageFilter.h.

◆ SetUseImageSpacingOn()

template<typename TInputImage , typename TOutputImage = TInputImage>
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 266 of file itkDiscreteGaussianImageFilter.h.

◆ SetVariance() [1/4]

template<typename TInputImage , typename TOutputImage = TInputImage>
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.

◆ SetVariance() [2/4]

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

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

Definition at line 173 of file itkDiscreteGaussianImageFilter.h.

◆ SetVariance() [3/4]

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

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

Definition at line 185 of file itkDiscreteGaussianImageFilter.h.

◆ SetVariance() [4/4]

template<typename TInputImage , typename TOutputImage = TInputImage>
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 158 of file itkDiscreteGaussianImageFilter.h.

Member Data Documentation

◆ ImageDimension

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

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.

◆ m_FilterDimensionality

template<typename TInputImage , typename TOutputImage = TInputImage>
unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_FilterDimensionality
private

Number of dimensions to process. Default is all dimensions

Definition at line 353 of file itkDiscreteGaussianImageFilter.h.

◆ m_InputBoundaryCondition

template<typename TInputImage , typename TOutputImage = TInputImage>
InputBoundaryConditionPointerType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_InputBoundaryCondition
private

Pointer to a persistent boundary condition object used for the image iterator.

Definition at line 360 of file itkDiscreteGaussianImageFilter.h.

◆ m_InputDefaultBoundaryCondition

template<typename TInputImage , typename TOutputImage = TInputImage>
InputDefaultBoundaryConditionType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_InputDefaultBoundaryCondition
private

Default boundary condition

Definition at line 363 of file itkDiscreteGaussianImageFilter.h.

◆ m_MaximumError

template<typename TInputImage , typename TOutputImage = TInputImage>
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 346 of file itkDiscreteGaussianImageFilter.h.

◆ m_MaximumKernelWidth

template<typename TInputImage , typename TOutputImage = TInputImage>
int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_MaximumKernelWidth
private

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

Definition at line 350 of file itkDiscreteGaussianImageFilter.h.

◆ m_RealBoundaryCondition

template<typename TInputImage , typename TOutputImage = TInputImage>
RealBoundaryConditionPointerType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_RealBoundaryCondition
private

Boundary condition use for the intermediate filters

Definition at line 366 of file itkDiscreteGaussianImageFilter.h.

◆ m_RealDefaultBoundaryCondition

template<typename TInputImage , typename TOutputImage = TInputImage>
RealDefaultBoundaryConditionType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_RealDefaultBoundaryCondition
private

Default boundary condition use for the intermediate filters

Definition at line 369 of file itkDiscreteGaussianImageFilter.h.

◆ m_UseImageSpacing

template<typename TInputImage , typename TOutputImage = TInputImage>
bool itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing
private

Flag to indicate whether to use image spacing

Definition at line 356 of file itkDiscreteGaussianImageFilter.h.

◆ m_Variance

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_Variance
private

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

Definition at line 341 of file itkDiscreteGaussianImageFilter.h.


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