itk::GaborKernelFunction< TRealValueType > Class Template Reference

#include <itkGaborKernelFunction.h>

Inheritance diagram for itk::GaborKernelFunction< TRealValueType >:

Collaboration diagram for itk::GaborKernelFunction< TRealValueType >:

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://hdl.handle.net/1926/500

See Also

KernelFunctionBase

Definition at line 50 of file itkGaborKernelFunction.h.

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
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::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
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 flag)
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 () override=default
Protected Member Functions inherited from itk::FunctionBase< TRealValueType, TRealValueType >
	FunctionBase ()=default
	~FunctionBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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

template<typename TRealValueType >

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

Definition at line 58 of file itkGaborKernelFunction.h.

template<typename TRealValueType >

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

Standard class type aliases.

Definition at line 56 of file itkGaborKernelFunction.h.

template<typename TRealValueType >

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

Definition at line 57 of file itkGaborKernelFunction.h.

Constructor & Destructor Documentation

template<typename TRealValueType >

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

inlineprotected

Definition at line 108 of file itkGaborKernelFunction.h.

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

template<typename TRealValueType >

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

overrideprotecteddefault

Member Function Documentation

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.

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.

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.

template<typename TRealValueType >

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

inlineoverridevirtual

Evaluate the function.

Implements itk::KernelFunctionBase< TRealValueType >.

Definition at line 67 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.

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 itk::GaborKernelFunction< TRealValueType >::PrintSelf().

template<typename TRealValueType >

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

virtual

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

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

template<typename TRealValueType >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::KernelFunctionBase< TRealValueType >.

template<typename TRealValueType >

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

virtual

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

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

template<typename TRealValueType >

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

virtual

Evaluate the function.

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

template<typename TRealValueType >

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

static

Method for creation through the object factory.

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::KernelFunctionBase< TRealValueType >.

Definition at line 116 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().

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.

template<typename TRealValueType >

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

virtual

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

template<typename TRealValueType >

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

virtual

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

template<typename TRealValueType >

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

virtual

Set/Get the standard deviation of the Gaussian envelope.

Member Data Documentation

template<typename TRealValueType >

bool itk::GaborKernelFunction< TRealValueType >::m_CalculateImaginaryPart

private

Definition at line 133 of file itkGaborKernelFunction.h.

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

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Frequency

private

Definition at line 129 of file itkGaborKernelFunction.h.

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

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset

private

Definition at line 131 of file itkGaborKernelFunction.h.

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

template<typename TRealValueType >

TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Sigma

private

Definition at line 127 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