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

#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 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.

+ 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 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 ()
 
- 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
 
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
 
 itkTypeMacroNoParent (LightObject)
 
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 () 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 &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 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

Definition at line 109 of file itkGaborKernelFunction.h.

◆ ~GaborKernelFunction()

template<typename TRealValueType >
itk::GaborKernelFunction< TRealValueType >::~GaborKernelFunction ( )
overrideprotecteddefault

Member Function Documentation

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

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

◆ GetFrequency()

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

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

◆ 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

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

◆ GetSigma()

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

Set/Get the standard deviation of the Gaussian envelope.

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

Definition at line 118 of file itkGaborKernelFunction.h.

◆ 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 135 of file itkGaborKernelFunction.h.

◆ m_Frequency

template<typename TRealValueType >
TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Frequency {}
private

Definition at line 131 of file itkGaborKernelFunction.h.

◆ m_PhaseOffset

template<typename TRealValueType >
TRealValueType itk::GaborKernelFunction< TRealValueType >::m_PhaseOffset {}
private

Definition at line 133 of file itkGaborKernelFunction.h.

◆ m_Sigma

template<typename TRealValueType >
TRealValueType itk::GaborKernelFunction< TRealValueType >::m_Sigma {}
private

Definition at line 129 of file itkGaborKernelFunction.h.


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