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

#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
 
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
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 ()
 
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 &time)
 
- 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://hdl.handle.net/1926/500

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

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

◆ 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

◆ 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

◆ m_Frequency

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

◆ m_PhaseOffset

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

◆ m_Sigma

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

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