#include <itkGaborKernelFunction.h>

Detailed Description

template<typename TRealValueType>
class itk::GaborKernelFunction< TRealValueType >

Gabor kernel used for various computer vision tasks.

This class encapsulates a complex Gabor kernel used for various computer vision tasks such as texture segmentation, motion analysis, and object recognition. It is essentially a complex sinusoid enveloped within a Gaussian. See [60] for a basic discussion including additional references.

This implementation was contributed as a paper to the Insight Journal https://doi.org/10.54294/dhogdz

See also: KernelFunctionBase

Definition at line 46 of file itkGaborKernelFunction.h.

Inheritance diagram for itk::GaborKernelFunction< TRealValueType >:

Collaboration diagram for itk::GaborKernelFunction< TRealValueType >:

Public Types
using	Pointer = SmartPointer<Self>

using	Self = GaborKernelFunction

using	Superclass = KernelFunctionBase<TRealValueType>

Public Types inherited from itk::KernelFunctionBase< TRealValueType >
using	ConstPointer

using	ConstPointer

using	Pointer

using	Pointer

using	RealType

using	RealType

using	Self

using	Self

using	Superclass

using	Superclass

Public Types inherited from itk::FunctionBase< TRealValueType, TRealValueType >
using	ConstPointer

using	InputType

using	OutputType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override


TRealValueType	Evaluate (const TRealValueType &u) const override


virtual void	SetSigma (TRealValueType _arg)

virtual TRealValueType	GetSigma () const


virtual void	SetFrequency (TRealValueType _arg)

virtual TRealValueType	GetFrequency () const


virtual void	SetPhaseOffset (TRealValueType _arg)

virtual TRealValueType	GetPhaseOffset () const


virtual void	SetCalculateImaginaryPart (bool _arg)

virtual bool	GetCalculateImaginaryPart () const

virtual void	CalculateImaginaryPartOn ()

virtual void	CalculateImaginaryPartOff ()

Public Member Functions inherited from itk::KernelFunctionBase< TRealValueType >
const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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::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 ()

Protected Member Functions
	GaborKernelFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GaborKernelFunction () override=default

Protected Member Functions inherited from itk::KernelFunctionBase< TRealValueType >
	KernelFunctionBase ()=default

	KernelFunctionBase ()=default

	~KernelFunctionBase () override=default

	~KernelFunctionBase () override=default

Protected Member Functions inherited from itk::FunctionBase< TRealValueType, TRealValueType >
	FunctionBase ()=default

	FunctionBase ()=default

	~FunctionBase () override=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

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
bool	m_CalculateImaginaryPart {}

TRealValueType	m_Frequency {}

TRealValueType	m_PhaseOffset {}

TRealValueType	m_Sigma {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ Pointer

template<typename TRealValueType>

using itk::GaborKernelFunction< TRealValueType >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkGaborKernelFunction.h.

◆ Self

template<typename TRealValueType>

using itk::GaborKernelFunction< TRealValueType >::Self = GaborKernelFunction

Standard class type aliases.

Definition at line 52 of file itkGaborKernelFunction.h.

◆ Superclass

template<typename TRealValueType>

using itk::GaborKernelFunction< TRealValueType >::Superclass = KernelFunctionBase<TRealValueType>

Definition at line 53 of file itkGaborKernelFunction.h.

Constructor & Destructor Documentation

◆ GaborKernelFunction()

template<typename TRealValueType>

itk::GaborKernelFunction< TRealValueType >::GaborKernelFunction ( )

inlineprotected

Definition at line 102 of file itkGaborKernelFunction.h.

References m_CalculateImaginaryPart, m_Frequency, m_PhaseOffset, and m_Sigma.

Referenced by GetNameOfClass().

◆ ~GaborKernelFunction()

template<typename TRealValueType>

itk::GaborKernelFunction< TRealValueType >::~GaborKernelFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ CalculateImaginaryPartOff()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::CalculateImaginaryPartOff ( )

virtual

Set/Get whether the kernel function evaluation is performed using the complex part. Default is false.

◆ CalculateImaginaryPartOn()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::CalculateImaginaryPartOn ( )

virtual

Set/Get whether the kernel function evaluation is performed using the complex part. Default is false.

◆ CreateAnother()

template<typename TRealValueType>

virtual::itk::LightObject::Pointer itk::GaborKernelFunction< TRealValueType >::CreateAnother ( ) const

virtual

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

Reimplemented from itk::LightObject.

◆ Evaluate()

template<typename TRealValueType>

TRealValueType itk::GaborKernelFunction< TRealValueType >::Evaluate ( const TRealValueType & u ) const

inlineoverridevirtual

Evaluate the function.

Implements itk::KernelFunctionBase< TRealValueType >.

Definition at line 64 of file itkGaborKernelFunction.h.

References m_CalculateImaginaryPart, m_Frequency, m_PhaseOffset, m_Sigma, and itk::Math::pi.

◆ GetCalculateImaginaryPart()

template<typename TRealValueType>

virtual bool itk::GaborKernelFunction< TRealValueType >::GetCalculateImaginaryPart ( ) const

virtual

Set/Get whether the kernel function evaluation is performed using the complex part. Default is false.

Referenced by PrintSelf().

◆ GetFrequency()

template<typename TRealValueType>

virtual TRealValueType itk::GaborKernelFunction< TRealValueType >::GetFrequency ( ) const

virtual

Set/Get the modulation frequency of the sine or cosine component.

Referenced by PrintSelf().

◆ GetNameOfClass()

template<typename TRealValueType>

const char * itk::GaborKernelFunction< TRealValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FunctionBase< TRealValueType, TRealValueType >.

References GaborKernelFunction().

◆ GetPhaseOffset()

template<typename TRealValueType>

virtual TRealValueType itk::GaborKernelFunction< TRealValueType >::GetPhaseOffset ( ) const

virtual

Set/Get the phase offset of the sine or cosine component .

Referenced by PrintSelf().

◆ GetSigma()

template<typename TRealValueType>

virtual TRealValueType itk::GaborKernelFunction< TRealValueType >::GetSigma ( ) const

virtual

Set/Get the standard deviation of the Gaussian envelope.

Referenced by PrintSelf().

◆ New()

template<typename TRealValueType>

static Pointer itk::GaborKernelFunction< TRealValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TRealValueType>

void itk::GaborKernelFunction< TRealValueType >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

inlineoverrideprotectedvirtual

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::LightObject.

Definition at line 111 of file itkGaborKernelFunction.h.

References GetCalculateImaginaryPart(), GetFrequency(), GetPhaseOffset(), GetSigma(), and itk::LightObject::PrintSelf().

◆ SetCalculateImaginaryPart()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::SetCalculateImaginaryPart ( bool _arg )

virtual

Set/Get whether the kernel function evaluation is performed using the complex part. Default is false.

◆ SetFrequency()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::SetFrequency ( TRealValueType _arg )

virtual

Set/Get the modulation frequency of the sine or cosine component.

◆ SetPhaseOffset()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::SetPhaseOffset ( TRealValueType _arg )

virtual

Set/Get the phase offset of the sine or cosine component .

◆ SetSigma()

template<typename TRealValueType>

virtual void itk::GaborKernelFunction< TRealValueType >::SetSigma ( TRealValueType _arg )

virtual

Set/Get the standard deviation of the Gaussian envelope.

Member Data Documentation

◆ m_CalculateImaginaryPart

template<typename TRealValueType>

bool itk::GaborKernelFunction< TRealValueType >::m_CalculateImaginaryPart {}

private

Definition at line 128 of file itkGaborKernelFunction.h.

Referenced by Evaluate(), and GaborKernelFunction().

◆ m_Frequency

template<typename TRealValueType>

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Frequency {}

private

Definition at line 124 of file itkGaborKernelFunction.h.

Referenced by Evaluate(), and GaborKernelFunction().

◆ m_PhaseOffset

template<typename TRealValueType>

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset {}

private

Definition at line 126 of file itkGaborKernelFunction.h.

Referenced by Evaluate(), and GaborKernelFunction().

◆ m_Sigma

template<typename TRealValueType>

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Sigma {}

private

Definition at line 122 of file itkGaborKernelFunction.h.

Referenced by Evaluate(), and GaborKernelFunction().

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

itkGaborKernelFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GaborKernelFunction()

◆ ~GaborKernelFunction()

Member Function Documentation

◆ CalculateImaginaryPartOff()

◆ CalculateImaginaryPartOn()

◆ CreateAnother()

◆ Evaluate()

◆ GetCalculateImaginaryPart()

◆ GetFrequency()

◆ GetNameOfClass()

◆ GetPhaseOffset()

◆ GetSigma()

◆ New()

◆ PrintSelf()

◆ SetCalculateImaginaryPart()

◆ SetFrequency()

◆ SetPhaseOffset()

◆ SetSigma()

Member Data Documentation

◆ m_CalculateImaginaryPart

◆ m_Frequency

◆ m_PhaseOffset

◆ m_Sigma