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

#include <itkDiscreteGaussianDerivativeImageFilter.h>

Detailed Description

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

Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gaussian derivative by separable convolution of an image and a discrete Gaussian derivative operator (kernel).

The Gaussian operators used here were described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.)

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.

Author

Ivan Macia, Vicomtech, Spain, https://www.vicomtech.org/en

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/mrg5is

See also

GaussianDerivativeOperator

Image

Neighborhood

NeighborhoodOperator

Definition at line 59 of file itkDiscreteGaussianDerivativeImageFilter.h.

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

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

Public Types
using	ArrayType = FixedArray< double, Self::ImageDimension >
using	ConstPointer = SmartPointer< const Self >
using	InputImageType = TInputImage
using	InputInternalPixelType = typename TInputImage::InternalPixelType
using	InputPixelType = typename TInputImage::PixelType
using	OrderArrayType = FixedArray< unsigned int, Self::ImageDimension >
using	OutputImageType = TOutputImage
using	OutputInternalPixelType = typename TOutputImage::InternalPixelType
using	OutputPixelType = typename TOutputImage::PixelType
using	Pointer = SmartPointer< Self >
using	Self = DiscreteGaussianDerivativeImageFilter
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
virtual unsigned int	GetInternalNumberOfStreamDivisions () const
const char *	GetNameOfClass () const override
virtual void	SetInternalNumberOfStreamDivisions (unsigned int _arg)
void	SetMaximumError (const typename ArrayType::ValueType v)
void	SetVariance (const typename ArrayType::ValueType v)
virtual void	SetOrder (OrderArrayType _arg)
virtual const OrderArrayType	GetOrder () const
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)
void	SetOrder (const typename OrderArrayType::ValueType v)
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing () const
virtual void	UseImageSpacingOn ()
virtual void	SetNormalizeAcrossScale (bool _arg)
virtual bool	GetNormalizeAcrossScale () const
virtual void	NormalizeAcrossScaleOn ()
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 void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual 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 void	SetNumberOfWorkUnits (ThreadIdType _arg)
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 = 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
	DiscreteGaussianDerivativeImageFilter ()
void	GenerateData () override
void	GenerateInputRequestedRegion () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~DiscreteGaussianDerivativeImageFilter () 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 () 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	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &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	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 () 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
unsigned int	m_InternalNumberOfStreamDivisions {}
ArrayType	m_MaximumError {}
int	m_MaximumKernelWidth {}
bool	m_NormalizeAcrossScale {}
OrderArrayType	m_Order {}
bool	m_UseImageSpacing {}
ArrayType	m_Variance {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
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

ArrayType

template<typename TInputImage , typename TOutputImage >

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

Typedef of double containers

Definition at line 92 of file itkDiscreteGaussianDerivativeImageFilter.h.

ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 68 of file itkDiscreteGaussianDerivativeImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage >

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

Image type information.

Definition at line 77 of file itkDiscreteGaussianDerivativeImageFilter.h.

InputInternalPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 85 of file itkDiscreteGaussianDerivativeImageFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 84 of file itkDiscreteGaussianDerivativeImageFilter.h.

OrderArrayType

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::OrderArrayType = FixedArray<unsigned int, Self::ImageDimension>

Array for storing desired order of derivatives

Definition at line 95 of file itkDiscreteGaussianDerivativeImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 78 of file itkDiscreteGaussianDerivativeImageFilter.h.

OutputInternalPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 83 of file itkDiscreteGaussianDerivativeImageFilter.h.

OutputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::DiscreteGaussianDerivativeImageFilter< 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 82 of file itkDiscreteGaussianDerivativeImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 67 of file itkDiscreteGaussianDerivativeImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage >

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

Standard class type aliases.

Definition at line 65 of file itkDiscreteGaussianDerivativeImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage >

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

Definition at line 66 of file itkDiscreteGaussianDerivativeImageFilter.h.

Constructor & Destructor Documentation

DiscreteGaussianDerivativeImageFilter()

template<typename TInputImage , typename TOutputImage >

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

inlineprotected

Definition at line 189 of file itkDiscreteGaussianDerivativeImageFilter.h.

~DiscreteGaussianDerivativeImageFilter()

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianDerivativeImageFilter< 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 >.

GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

DiscreteGaussianDerivativeImageFilter needs a larger input requested region than the output requested region (larger by the size of the Gaussian kernel). As such, DiscreteGaussianDerivativeImageFilter 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 >.

GetInternalNumberOfStreamDivisions()

template<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GetInternalNumberOfStreamDivisions ( ) const

virtual

GetMaximumError()

template<typename TInputImage , typename TOutputImage >

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

virtual

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

GetMaximumKernelWidth()

template<typename TInputImage , typename TOutputImage >

virtual int itk::DiscreteGaussianDerivativeImageFilter< 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 >

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

overridevirtual

See also

LightObject::GetNameOfClass()

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

GetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GetNormalizeAcrossScale ( ) const

virtual

Set/Get the flag for calculating scale-space normalized derivatives. Normalized derivatives are obtained multiplying by the scale parameter t.

GetOrder()

template<typename TInputImage , typename TOutputImage >

virtual const OrderArrayType itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GetOrder ( ) const

virtual

Order of derivatives in each dimension. Sets the derivative order independently for each dimension, but see also SetOrder(const unsigned int v). The default is 1 in each dimension.

GetUseImageSpacing()

template<typename TInputImage , typename TOutputImage >

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

virtual

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

GetVariance()

template<typename TInputImage , typename TOutputImage >

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

virtual

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

New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

NormalizeAcrossScaleOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::NormalizeAcrossScaleOn ( )

virtual

Set/Get the flag for calculating scale-space normalized derivatives. Normalized derivatives are obtained multiplying by the scale parameter t.

PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianDerivativeImageFilter< 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 >.

SetInternalNumberOfStreamDivisions()

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetInternalNumberOfStreamDivisions ( unsigned int  _arg )

virtual

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.

SetMaximumError() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< 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/2]

template<typename TInputImage , typename TOutputImage >

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

inline

Definition at line 159 of file itkDiscreteGaussianDerivativeImageFilter.h.

SetMaximumKernelWidth()

template<typename TInputImage , typename TOutputImage >

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

virtual

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

SetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetNormalizeAcrossScale ( bool  _arg )

virtual

Set/Get the flag for calculating scale-space normalized derivatives. Normalized derivatives are obtained multiplying by the scale parameter t.

SetOrder() [1/2]

template<typename TInputImage , typename TOutputImage >

void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetOrder ( const typename OrderArrayType::ValueType  v )

inline

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

Definition at line 144 of file itkDiscreteGaussianDerivativeImageFilter.h.

SetOrder() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::SetOrder ( OrderArrayType  _arg )

virtual

Order of derivatives in each dimension. Sets the derivative order independently for each dimension, but see also SetOrder(const unsigned int v). The default is 1 in each dimension.

SetUseImageSpacing()

template<typename TInputImage , typename TOutputImage >

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

virtual

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

SetVariance() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< 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/2]

template<typename TInputImage , typename TOutputImage >

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

inline

Definition at line 152 of file itkDiscreteGaussianDerivativeImageFilter.h.

UseImageSpacingOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::UseImageSpacingOn ( )

virtual

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

Member Data Documentation

ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::DiscreteGaussianDerivativeImageFilter< 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 89 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_InternalNumberOfStreamDivisions

template<typename TInputImage , typename TOutputImage >

unsigned int itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_InternalNumberOfStreamDivisions {}

private

Number of pieces to divide the input on the internal composite pipeline. The upstream pipeline will not be effected.

Definition at line 246 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_MaximumError

template<typename TInputImage , typename TOutputImage >

ArrayType itk::DiscreteGaussianDerivativeImageFilter< 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 232 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_MaximumKernelWidth

template<typename TInputImage , typename TOutputImage >

int itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_MaximumKernelWidth {}

private

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

Definition at line 236 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_NormalizeAcrossScale

template<typename TInputImage , typename TOutputImage >

bool itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_NormalizeAcrossScale {}

private

Flag for scale-space normalization of derivatives.

Definition at line 242 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_Order

template<typename TInputImage , typename TOutputImage >

OrderArrayType itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_Order {}

private

The order of the derivatives in each dimensional direction.

Definition at line 223 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_UseImageSpacing

template<typename TInputImage , typename TOutputImage >

bool itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing {}

private

Flag to indicate whether to use image spacing

Definition at line 239 of file itkDiscreteGaussianDerivativeImageFilter.h.

m_Variance

template<typename TInputImage , typename TOutputImage >

ArrayType itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::m_Variance {}

private

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

Definition at line 227 of file itkDiscreteGaussianDerivativeImageFilter.h.

---

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

• itkDiscreteGaussianDerivativeImageFilter.h