#include <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 = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	RealType = TRealValueType

using	Self = KernelFunctionBase

using	Superclass = FunctionBase< TRealValueType, TRealValueType >

Public Types inherited from itk::FunctionBase< TRealValueType, TRealValueType >
using	ConstPointer = SmartPointer< const Self >

using	InputType = TRealValueType

using	OutputType = TRealValueType

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

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

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::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

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)

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

TRealValueType	m_Sigma

TRealValueType	m_Frequency

TRealValueType	m_PhaseOffset

bool	m_CalculateImaginaryPart

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

	GaborKernelFunction ()

	~GaborKernelFunction () override=default

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

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

	~KernelFunctionBase () override=default

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

	~FunctionBase () override=default

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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 the discussion in

Andreas Klein, Forester Lee, and Amir A. Amini, "Quantitative Coronary Angiography with Deformable Spline Models", IEEE-TMI 16(5):468-482, October 1997.

for a basic discussion including additional references.

This implementation was contributed as a paper to the Insight Journal https://www.insight-journal.org/browse/publication/150

See also: KernelFunctionBase

Definition at line 51 of file itkGaborKernelFunction.h.

Member Typedef Documentation

◆ Pointer

template<typename TRealValueType >

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

Definition at line 59 of file itkGaborKernelFunction.h.

◆ Self

template<typename TRealValueType >

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

Standard class type aliases.

Definition at line 57 of file itkGaborKernelFunction.h.

◆ Superclass

template<typename TRealValueType >

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

Definition at line 58 of file itkGaborKernelFunction.h.

Constructor & Destructor Documentation

◆ GaborKernelFunction()

template<typename TRealValueType >

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

inlineprotected

Evaluate the function.

Definition at line 110 of file itkGaborKernelFunction.h.

References itk::GaborKernelFunction< TRealValueType >::m_CalculateImaginaryPart, itk::GaborKernelFunction< TRealValueType >::m_Frequency, itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset, itk::GaborKernelFunction< TRealValueType >::m_Sigma, itk::NumericTraits< T >::OneValue(), and itk::NumericTraits< T >::ZeroValue().

◆ ~GaborKernelFunction()

template<typename TRealValueType >

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

overrideprotecteddefault

Evaluate the function.

Member Function Documentation

◆ CalculateImaginaryPartOff()

template<typename TRealValueType >

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

virtual

Evaluate the function.

◆ CalculateImaginaryPartOn()

template<typename TRealValueType >

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

virtual

Evaluate the function.

◆ 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::Object.

◆ Evaluate()

template<typename TRealValueType >

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

inlineoverridevirtual

Evaluate the function.

Implements itk::KernelFunctionBase< TRealValueType >.

Definition at line 69 of file itkGaborKernelFunction.h.

References itk::GaborKernelFunction< TRealValueType >::m_CalculateImaginaryPart, itk::GaborKernelFunction< TRealValueType >::m_Frequency, itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset, itk::GaborKernelFunction< TRealValueType >::m_Sigma, and itk::Math::pi.

◆ GetCalculateImaginaryPart()

template<typename TRealValueType >

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

virtual

Evaluate the function.

Referenced by itk::GaborKernelFunction< TRealValueType >::PrintSelf().

◆ GetFrequency()

template<typename TRealValueType >

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

virtual

Evaluate the function.

Referenced by itk::GaborKernelFunction< TRealValueType >::PrintSelf().

◆ GetNameOfClass()

template<typename TRealValueType >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::KernelFunctionBase< TRealValueType >.

◆ GetPhaseOffset()

template<typename TRealValueType >

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

virtual

Evaluate the function.

Referenced by itk::GaborKernelFunction< TRealValueType >::PrintSelf().

◆ GetSigma()

template<typename TRealValueType >

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

virtual

Evaluate the function.

Referenced by itk::GaborKernelFunction< TRealValueType >::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

Evaluate the function.

Reimplemented from itk::KernelFunctionBase< TRealValueType >.

Definition at line 119 of file itkGaborKernelFunction.h.

References itk::GaborKernelFunction< TRealValueType >::GetCalculateImaginaryPart(), itk::GaborKernelFunction< TRealValueType >::GetFrequency(), itk::GaborKernelFunction< TRealValueType >::GetPhaseOffset(), itk::GaborKernelFunction< TRealValueType >::GetSigma(), and itk::KernelFunctionBase< TRealValueType >::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

Evaluate the function.

Definition at line 136 of file itkGaborKernelFunction.h.

Referenced by itk::GaborKernelFunction< TRealValueType >::Evaluate(), and itk::GaborKernelFunction< TRealValueType >::GaborKernelFunction().

◆ m_Frequency

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Frequency

private

Evaluate the function.

Definition at line 132 of file itkGaborKernelFunction.h.

Referenced by itk::GaborKernelFunction< TRealValueType >::Evaluate(), and itk::GaborKernelFunction< TRealValueType >::GaborKernelFunction().

◆ m_PhaseOffset

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset

private

Evaluate the function.

Definition at line 134 of file itkGaborKernelFunction.h.

Referenced by itk::GaborKernelFunction< TRealValueType >::Evaluate(), and itk::GaborKernelFunction< TRealValueType >::GaborKernelFunction().

◆ m_Sigma

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Sigma

private

Evaluate the function.

Definition at line 130 of file itkGaborKernelFunction.h.

Referenced by itk::GaborKernelFunction< TRealValueType >::Evaluate(), and itk::GaborKernelFunction< TRealValueType >::GaborKernelFunction().

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

itkGaborKernelFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

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

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