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

#include <itkGradientRecursiveGaussianImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
class itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >

Computes the gradient of an image by convolution with the first derivative of a Gaussian.

This filter is implemented using the recursive gaussian filters.

This filter supports both scalar and vector pixel types within the input image, including VectorImage type.

ITK Sphinx Examples:
Examples
Examples/DataRepresentation/Image/ImageAdaptor3.cxx, Examples/Filtering/GradientRecursiveGaussianImageFilter.cxx, Examples/Filtering/VectorCurvatureAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/VectorGradientAnisotropicDiffusionImageFilter.cxx, Examples/IO/CovariantVectorImageWrite.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussian/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussianWithVectorInput/Code.cxx, and SphinxExamples/src/Filtering/ImageGradient/ImplementationOfSnakes/Code.cxx.

Definition at line 59 of file itkGradientRecursiveGaussianImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CovariantVectorType = CovariantVector< OutputComponentType, ImageDimension >
 
using DerivativeFilterPointer = typename DerivativeFilterType::Pointer
 
using DerivativeFilterType = RecursiveGaussianImageFilter< InputImageType, RealImageType >
 
using GaussianFilterPointer = typename GaussianFilterType::Pointer
 
using GaussianFilterType = RecursiveGaussianImageFilter< RealImageType, RealImageType >
 
using GradientVectorType = CovariantVector< ScalarRealType, ImageDimension >
 
using InputImageType = TInputImage
 
using InternalRealType = typename NumericTraits< RealType >::FloatType
 
using InternalScalarRealType = typename NumericTraits< InternalRealType >::ValueType
 
using OutputComponentType = typename NumericTraits< OutputPixelType >::ValueType
 
using OutputImageAdaptorPointer = typename OutputImageAdaptorType::Pointer
 
using OutputImageAdaptorType = NthElementImageAdaptor< TOutputImage, InternalScalarRealType >
 
using OutputImagePointer = typename TOutputImage::Pointer
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename OutputImageType::PixelType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealImageType = Image< InternalRealType, Self::ImageDimension >
 
using RealType = typename NumericTraits< PixelType >::RealType
 
using ScalarRealType = typename NumericTraits< PixelType >::ScalarRealType
 
using Self = GradientRecursiveGaussianImageFilter
 
using SigmaArrayType = FixedArray< ScalarRealType, Self::ImageDimension >
 
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

void GenerateInputRequestedRegion () override
 
ScalarRealType GetSigma () const
 
SigmaArrayType GetSigmaArray () const
 
 itkOverrideGetNameOfClassMacro (GradientRecursiveGaussianImageFilter)
 
void SetSigmaArray (const SigmaArrayType &sigma)
 
void SetSigma (ScalarRealType sigma)
 
void SetNormalizeAcrossScale (bool normalize)
 
virtual bool GetNormalizeAcrossScale () const
 
virtual void SetUseImageDirection (bool _arg)
 
virtual bool GetUseImageDirection () const
 
virtual void UseImageDirectionOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
 itkOverrideGetNameOfClassMacro (ImageToImageFilter)
 
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 >
OutputImageTypeGetOutput (unsigned int idx)
 
 itkOverrideGetNameOfClassMacro (ImageSource)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () 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 ()
 
MultiThreaderTypeGetMultiThreader () 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)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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::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 GenerateOutputInformation () override
 
 GradientRecursiveGaussianImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GradientRecursiveGaussianImageFilter () 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=default
 
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 ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 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 () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

template<template< typename, unsigned int > class P, class T , unsigned int VDimension>
void TransformOutputPixel (ImageRegionIterator< Image< P< T, VDimension >, VDimension >> &it)
 
template<typename T >
void TransformOutputPixel (ImageRegionIterator< T > &it)
 
template<typename TValue >
void TransformOutputPixel (ImageRegionIterator< VectorImage< TValue, ImageDimension >> &it)
 

Private Attributes

DerivativeFilterPointer m_DerivativeFilter {}
 
OutputImageAdaptorPointer m_ImageAdaptor {}
 
bool m_NormalizeAcrossScale {}
 
SigmaArrayType m_Sigma {}
 
std::vector< GaussianFilterPointerm_SmoothingFilters {}
 
bool m_UseImageDirection {}
 

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 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
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkGradientRecursiveGaussianImageFilter.h.

◆ CovariantVectorType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::CovariantVectorType = CovariantVector<OutputComponentType, ImageDimension>

Definition at line 124 of file itkGradientRecursiveGaussianImageFilter.h.

◆ DerivativeFilterPointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::DerivativeFilterPointer = typename DerivativeFilterType::Pointer

Pointer to a derivative filter.

Definition at line 115 of file itkGradientRecursiveGaussianImageFilter.h.

◆ DerivativeFilterType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::DerivativeFilterType = RecursiveGaussianImageFilter<InputImageType, RealImageType>

Derivative filter type, it will be the first in the pipeline

Definition at line 109 of file itkGradientRecursiveGaussianImageFilter.h.

◆ GaussianFilterPointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GaussianFilterPointer = typename GaussianFilterType::Pointer

Pointer to a gaussian filter.

Definition at line 112 of file itkGradientRecursiveGaussianImageFilter.h.

◆ GaussianFilterType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GaussianFilterType = RecursiveGaussianImageFilter<RealImageType, RealImageType>

Smoothing filter type

Definition at line 106 of file itkGradientRecursiveGaussianImageFilter.h.

◆ GradientVectorType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GradientVectorType = CovariantVector<ScalarRealType, ImageDimension>

Gradient vector type alias

Definition at line 86 of file itkGradientRecursiveGaussianImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Pixel Type of the input image. May be scalar or vector.

Definition at line 71 of file itkGradientRecursiveGaussianImageFilter.h.

◆ InternalRealType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InternalRealType = typename NumericTraits<RealType>::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 79 of file itkGradientRecursiveGaussianImageFilter.h.

◆ InternalScalarRealType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::InternalScalarRealType = typename NumericTraits<InternalRealType>::ValueType

Definition at line 80 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputComponentType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputComponentType = typename NumericTraits<OutputPixelType>::ValueType

Definition at line 123 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputImageAdaptorPointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImageAdaptorPointer = typename OutputImageAdaptorType::Pointer

Definition at line 100 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputImageAdaptorType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImageAdaptorType = NthElementImageAdaptor<TOutputImage, InternalScalarRealType>

Output Image Nth Element Adaptor This adaptor allows to use conventional scalar smoothing filters to compute each one of the components of the gradient image pixels.

Definition at line 98 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename TOutputImage::Pointer

Pointer to the Output Image

Definition at line 118 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Type of the output Image

Definition at line 121 of file itkGradientRecursiveGaussianImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 122 of file itkGradientRecursiveGaussianImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::PixelType = typename TInputImage::PixelType

Definition at line 72 of file itkGradientRecursiveGaussianImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkGradientRecursiveGaussianImageFilter.h.

◆ RealImageType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::RealImageType = Image<InternalRealType, Self::ImageDimension>

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 91 of file itkGradientRecursiveGaussianImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<PixelType>::RealType

Definition at line 73 of file itkGradientRecursiveGaussianImageFilter.h.

◆ ScalarRealType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType

Definition at line 74 of file itkGradientRecursiveGaussianImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::Self = GradientRecursiveGaussianImageFilter

Standard class type aliases.

Definition at line 65 of file itkGradientRecursiveGaussianImageFilter.h.

◆ SigmaArrayType

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>

Define the type for the sigma array

Definition at line 103 of file itkGradientRecursiveGaussianImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
using itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 66 of file itkGradientRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ GradientRecursiveGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GradientRecursiveGaussianImageFilter ( )
protected

◆ ~GradientRecursiveGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::~GradientRecursiveGaussianImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< 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 = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Generate Data

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overridevirtual

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

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

◆ GetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
virtual bool itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetNormalizeAcrossScale ( ) const
virtual

Define which normalization factor will be used for the Gaussian

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

◆ GetSigma()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
ScalarRealType itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetSigma ( ) const

Get the value of Sigma along the first dimension.

◆ GetSigmaArray()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
SigmaArrayType itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetSigmaArray ( ) const

◆ GetUseImageDirection()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
virtual bool itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetUseImageDirection ( ) const
virtual

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::itkOverrideGetNameOfClassMacro ( GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >  )

Runtime information support.

◆ New()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
static Pointer itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< 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 >.

◆ SetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetNormalizeAcrossScale ( bool  normalize)

Define which normalization factor will be used for the Gaussian

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

◆ SetSigma()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSigma ( ScalarRealType  sigma)

Set/Get the Sigma value. Sigma is measured in the units of image spacing.

◆ SetSigmaArray()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSigmaArray ( const SigmaArrayType sigma)

Set/Get the Sigma value. Sigma is measured in the units of image spacing.

◆ SetUseImageDirection()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
virtual void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageDirection ( bool  _arg)
virtual

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

◆ TransformOutputPixel() [1/3]

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
template<template< typename, unsigned int > class P, class T , unsigned int VDimension>
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel ( ImageRegionIterator< Image< P< T, VDimension >, VDimension >> &  it)
inlineprivate

Definition at line 245 of file itkGradientRecursiveGaussianImageFilter.h.

◆ TransformOutputPixel() [2/3]

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
template<typename T >
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel ( ImageRegionIterator< T > &  it)
inlineprivate

◆ TransformOutputPixel() [3/3]

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
template<typename TValue >
void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel ( ImageRegionIterator< VectorImage< TValue, ImageDimension >> &  it)
inlineprivate

Definition at line 205 of file itkGradientRecursiveGaussianImageFilter.h.

◆ UseImageDirectionOn()

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
virtual void itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::UseImageDirectionOn ( )
virtual

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
constexpr unsigned int itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Image dimension.

Definition at line 83 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_DerivativeFilter

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
DerivativeFilterPointer itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_DerivativeFilter {}
private

Definition at line 254 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_ImageAdaptor

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
OutputImageAdaptorPointer itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_ImageAdaptor {}
private

Definition at line 255 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_NormalizeAcrossScale

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
bool itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_NormalizeAcrossScale {}
private

Normalize the image across scale space

Definition at line 258 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_Sigma

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
SigmaArrayType itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_Sigma {}
private

Standard deviation of the gaussian

Definition at line 264 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_SmoothingFilters

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
std::vector<GaussianFilterPointer> itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_SmoothingFilters {}
private

Definition at line 253 of file itkGradientRecursiveGaussianImageFilter.h.

◆ m_UseImageDirection

template<typename TInputImage , typename TOutputImage = Image< CovariantVector<typename NumericTraits<typename TInputImage::PixelType>::RealType, TInputImage::ImageDimension>, TInputImage::ImageDimension>>
bool itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_UseImageDirection {}
private

Take into account image orientation when computing the Gradient

Definition at line 261 of file itkGradientRecursiveGaussianImageFilter.h.


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