ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Image Filters » Intensity Image FiltersMultiThreading Support » | SingleThreaded FiltersGroup Filtering » | Module ITKSmoothing

#include <itkSmoothingRecursiveGaussianImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >

Computes the smoothing of an image by convolution with the Gaussian kernels implemented as IIR filters.

This filter is implemented using the recursive gaussian filters. For multi-component images, the filter works on each component independently.

For this filter to be able to run in-place the input and output image types need to be the same and/or the same type as the RealImageType.

Examples
Examples/Filtering/SmoothingRecursiveGaussianImageFilter2.cxx, Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, and SphinxExamples/src/Filtering/Smoothing/ComputesSmoothingWithGaussianKernel/Code.cxx.

Definition at line 50 of file itkSmoothingRecursiveGaussianImageFilter.h.

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

Public Types

using CastingFilterPointer = typename CastingFilterType::Pointer
 
using CastingFilterType = CastImageFilter< RealImageType, OutputImageType >
 
using ConstPointer = SmartPointer< const Self >
 
using FirstGaussianFilterPointer = typename FirstGaussianFilterType::Pointer
 
using FirstGaussianFilterType = RecursiveGaussianImageFilter< InputImageType, RealImageType >
 
using InputImageType = TInputImage
 
using InternalGaussianFilterPointer = typename InternalGaussianFilterType::Pointer
 
using InternalGaussianFilterType = RecursiveGaussianImageFilter< RealImageType, RealImageType >
 
using InternalRealType = typename NumericTraits< PixelType >::FloatType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = TOutputImage
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealImageType = typename InputImageType::template Rebind< InternalRealType >::Type
 
using RealType = typename NumericTraits< PixelType >::RealType
 
using ScalarRealType = typename NumericTraits< PixelType >::ScalarRealType
 
using Self = SmoothingRecursiveGaussianImageFilter
 
using SigmaArrayType = FixedArray< ScalarRealType, Self::ImageDimension >
 
using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

bool CanRunInPlace () const override
 
const char * GetNameOfClass () const override
 
ScalarRealType GetSigma () const
 
SigmaArrayType GetSigmaArray () const
 
void SetNumberOfWorkUnits (ThreadIdType nb) override
 
void SetSigmaArray (const SigmaArrayType &sigma)
 
void SetSigma (ScalarRealType sigma)
 
void SetNormalizeAcrossScale (bool normalize)
 
virtual bool GetNormalizeAcrossScale () const
 
virtual void NormalizeAcrossScaleOn ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = 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

void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SmoothingRecursiveGaussianImageFilter ()
 
 ~SmoothingRecursiveGaussianImageFilter () override=default
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- 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 () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void 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 PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

CastingFilterPointer m_CastingFilter {}
 
FirstGaussianFilterPointer m_FirstSmoothingFilter {}
 
bool m_NormalizeAcrossScale { false }
 
SigmaArrayType m_Sigma {}
 
InternalGaussianFilterPointer m_SmoothingFilters [ImageDimension - 1] {}
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ CastingFilterPointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::CastingFilterPointer = typename CastingFilterType::Pointer

Pointer to the casting image filter.

Definition at line 99 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ CastingFilterType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::CastingFilterType = CastImageFilter<RealImageType, OutputImageType>

Typedef for the casting image filter.

Definition at line 90 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ ConstPointer

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

Definition at line 59 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ FirstGaussianFilterPointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::FirstGaussianFilterPointer = typename FirstGaussianFilterType::Pointer

Pointer to the first Gaussian smoothing filter.

Definition at line 96 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ FirstGaussianFilterType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::FirstGaussianFilterType = RecursiveGaussianImageFilter<InputImageType, RealImageType>

Typedef for the first Gaussian smoothing in the pipeline.

Definition at line 84 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ InputImageType

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

Pixel type alias.

Definition at line 62 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ InternalGaussianFilterPointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InternalGaussianFilterPointer = typename InternalGaussianFilterType::Pointer

Pointer to the internal Gaussian filter.

Definition at line 93 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ InternalGaussianFilterType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InternalGaussianFilterType = RecursiveGaussianImageFilter<RealImageType, RealImageType>

Typedef for the internal Gaussian smoothing filter.

Definition at line 87 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ InternalRealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InternalRealType = typename NumericTraits<PixelType>::FloatType

Define the image type for internal computations. RealType is usually 'double' in NumericTraits. Here we prefer float in order to save memory.

Definition at line 80 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Pointer to the Output Image

Definition at line 102 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ OutputImageType

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

Definition at line 63 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ PixelType

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

Definition at line 64 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ Pointer

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

Definition at line 58 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ RealImageType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::RealImageType = typename InputImageType::template Rebind<InternalRealType>::Type

Definition at line 81 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<PixelType>::RealType

Definition at line 65 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ ScalarRealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType

Definition at line 66 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 56 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ SigmaArrayType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>

Define the type for the sigma array.

Definition at line 75 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 57 of file itkSmoothingRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ SmoothingRecursiveGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SmoothingRecursiveGaussianImageFilter ( )
protected

◆ ~SmoothingRecursiveGaussianImageFilter()

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

Member Function Documentation

◆ CanRunInPlace()

template<typename TInputImage , typename TOutputImage = TInputImage>
bool itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::CanRunInPlace ( ) const
overridevirtual

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridden by InPlaceImageFilter subclasses to fine tune its behavior.

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

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  )
overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

SmoothingRecursiveGaussianImageFilter needs all of the input to produce an output. Therefore, SmoothingRecursiveGaussianImageFilter 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 >.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage = TInputImage>
const char* itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

◆ GetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual bool itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetNormalizeAcrossScale ( ) const
virtual

Set/Get the flag for normalizing the Gaussian over scale-space. This method does not effect the output of this filter.

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

◆ GetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetSigma ( ) const

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

◆ GetSigmaArray()

template<typename TInputImage , typename TOutputImage = TInputImage>
SigmaArrayType itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetSigmaArray ( ) const

Get the Sigma value.

◆ New()

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

Method for creation through the object factory.

◆ NormalizeAcrossScaleOn()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::NormalizeAcrossScaleOn ( )
virtual

Set/Get the flag for normalizing the Gaussian over scale-space. This method does not effect the output of this filter.

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< 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::InPlaceImageFilter< TInputImage, TOutputImage >.

◆ SetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetNormalizeAcrossScale ( bool  normalize)

Set/Get the flag for normalizing the Gaussian over scale-space. This method does not effect the output of this filter.

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

◆ SetNumberOfWorkUnits()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetNumberOfWorkUnits ( ThreadIdType  nb)
overridevirtual

Set the number of work units to create.

Reimplemented from itk::ProcessObject.

◆ SetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSigma ( ScalarRealType  sigma)

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.

◆ SetSigmaArray()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSigmaArray ( const SigmaArrayType &  sigma)

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.

Member Data Documentation

◆ ImageDimension

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

Image dimension.

Definition at line 72 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ m_CastingFilter

template<typename TInputImage , typename TOutputImage = TInputImage>
CastingFilterPointer itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_CastingFilter {}
private

Definition at line 176 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ m_FirstSmoothingFilter

template<typename TInputImage , typename TOutputImage = TInputImage>
FirstGaussianFilterPointer itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_FirstSmoothingFilter {}
private

Definition at line 175 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ m_NormalizeAcrossScale

template<typename TInputImage , typename TOutputImage = TInputImage>
bool itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_NormalizeAcrossScale { false }
private

Definition at line 178 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ m_Sigma

template<typename TInputImage , typename TOutputImage = TInputImage>
SigmaArrayType itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_Sigma {}
private

Definition at line 180 of file itkSmoothingRecursiveGaussianImageFilter.h.

◆ m_SmoothingFilters

template<typename TInputImage , typename TOutputImage = TInputImage>
InternalGaussianFilterPointer itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_SmoothingFilters[ImageDimension - 1] {}
private

Definition at line 174 of file itkSmoothingRecursiveGaussianImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16