SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GaborImageSource Class Reference

Generate an n-dimensional image of a Gabor filter. More...

#include <sitkGaborImageSource.h>

+ Inheritance diagram for itk::simple::GaborImageSource:
+ Collaboration diagram for itk::simple::GaborImageSource:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = GaborImageSource
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute ()
 
 GaborImageSource ()
 
std::vector< double > GetDirection () const
 
double GetFrequency () const
 
std::vector< double > GetMean () const
 
std::string GetName () const
 
std::vector< double > GetOrigin () const
 
PixelIDValueEnum GetOutputPixelType () const
 
std::vector< double > GetSigma () const
 
std::vector< unsigned int > GetSize () const
 
std::vector< double > GetSpacing () const
 
SelfSetDirection (std::vector< double > Direction)
 
SelfSetFrequency (double Frequency)
 
SelfSetMean (double value)
 
SelfSetMean (std::vector< double > Mean)
 
SelfSetOrigin (std::vector< double > Origin)
 
SelfSetOutputPixelType (PixelIDValueEnum OutputPixelType)
 
SelfSetSigma (double value)
 
SelfSetSigma (std::vector< double > Sigma)
 
SelfSetSize (std::vector< unsigned int > Size)
 
SelfSetSpacing (std::vector< double > Spacing)
 
std::string ToString () const
 
virtual ~GaborImageSource ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)()
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal ()
 

Private Attributes

std::vector< double > m_Direction {std::vector<double>()}
 
double m_Frequency {0.4}
 
std::vector< double > m_Mean {std::vector<double>(3, 32.0)}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_Origin {std::vector<double>(3, 0.0)}
 
PixelIDValueEnum m_OutputPixelType {itk::simple::sitkFloat32}
 
std::vector< double > m_Sigma {std::vector<double>(3, 16.0)}
 
std::vector< unsigned int > m_Size {std::vector<unsigned int>(3, 64)}
 
std::vector< double > m_Spacing {std::vector<double>(3, 1.0)}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Generate an n-dimensional image of a Gabor filter.

GaborImageSource generates an image of either the real (i.e. symmetric) or complex (i.e. antisymmetric) part of the Gabor filter with the orientation directed along the x-axis. The GaborKernelFunction is used to evaluate the contribution along the x-axis whereas a non-normalized 1-D Gaussian envelope provides the contribution in each of the remaining N dimensions. Orientation can be manipulated via the Transform classes of the toolkit.

The output image may be of any dimension.

This implementation was contributed as a paper to the Insight Journal https://hdl.handle.net/1926/500

See also
itk::simple::GaborSource for the procedural interface
itk::GaborImageSource for the Doxygen on the original ITK class.

Definition at line 46 of file sitkGaborImageSource.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 156 of file sitkGaborImageSource.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkGaborImageSource.h.

◆ Self

Definition at line 48 of file sitkGaborImageSource.h.

Constructor & Destructor Documentation

◆ ~GaborImageSource()

virtual itk::simple::GaborImageSource::~GaborImageSource ( )
virtual

Destructor

◆ GaborImageSource()

itk::simple::GaborImageSource::GaborImageSource ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::GaborImageSource::Execute ( )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::GaborImageSource::ExecuteInternal ( )
private

◆ GetDirection()

std::vector<double> itk::simple::GaborImageSource::GetDirection ( ) const
inline

Definition at line 138 of file sitkGaborImageSource.h.

◆ GetFrequency()

double itk::simple::GaborImageSource::GetFrequency ( ) const
inline

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

Definition at line 114 of file sitkGaborImageSource.h.

◆ GetMean()

std::vector<double> itk::simple::GaborImageSource::GetMean ( ) const
inline

Set/Get the mean in each direction.

Definition at line 104 of file sitkGaborImageSource.h.

◆ GetName()

std::string itk::simple::GaborImageSource::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 141 of file sitkGaborImageSource.h.

◆ GetOrigin()

std::vector<double> itk::simple::GaborImageSource::GetOrigin ( ) const
inline

Definition at line 122 of file sitkGaborImageSource.h.

◆ GetOutputPixelType()

PixelIDValueEnum itk::simple::GaborImageSource::GetOutputPixelType ( ) const
inline

Definition at line 70 of file sitkGaborImageSource.h.

◆ GetSigma()

std::vector<double> itk::simple::GaborImageSource::GetSigma ( ) const
inline

Set/Get the the standard deviation in each direction.

Definition at line 91 of file sitkGaborImageSource.h.

◆ GetSize()

std::vector<unsigned int> itk::simple::GaborImageSource::GetSize ( ) const
inline

Definition at line 78 of file sitkGaborImageSource.h.

◆ GetSpacing()

std::vector<double> itk::simple::GaborImageSource::GetSpacing ( ) const
inline

Definition at line 130 of file sitkGaborImageSource.h.

◆ SetDirection()

Self& itk::simple::GaborImageSource::SetDirection ( std::vector< double >  Direction)
inline

Definition at line 134 of file sitkGaborImageSource.h.

◆ SetFrequency()

Self& itk::simple::GaborImageSource::SetFrequency ( double  Frequency)
inline

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

Definition at line 109 of file sitkGaborImageSource.h.

◆ SetMean() [1/2]

Self& itk::simple::GaborImageSource::SetMean ( double  value)
inline

Set the values of the Mean vector all to value

Definition at line 99 of file sitkGaborImageSource.h.

◆ SetMean() [2/2]

Self& itk::simple::GaborImageSource::SetMean ( std::vector< double >  Mean)
inline

Set/Get the mean in each direction.

Definition at line 96 of file sitkGaborImageSource.h.

References itk::simple::Mean().

◆ SetOrigin()

Self& itk::simple::GaborImageSource::SetOrigin ( std::vector< double >  Origin)
inline

Definition at line 118 of file sitkGaborImageSource.h.

◆ SetOutputPixelType()

Self& itk::simple::GaborImageSource::SetOutputPixelType ( PixelIDValueEnum  OutputPixelType)
inline

Definition at line 66 of file sitkGaborImageSource.h.

◆ SetSigma() [1/2]

Self& itk::simple::GaborImageSource::SetSigma ( double  value)
inline

Set the values of the Sigma vector all to value

Definition at line 86 of file sitkGaborImageSource.h.

◆ SetSigma() [2/2]

Self& itk::simple::GaborImageSource::SetSigma ( std::vector< double >  Sigma)
inline

Set/Get the the standard deviation in each direction.

Definition at line 83 of file sitkGaborImageSource.h.

◆ SetSize()

Self& itk::simple::GaborImageSource::SetSize ( std::vector< unsigned int >  Size)
inline

Definition at line 74 of file sitkGaborImageSource.h.

◆ SetSpacing()

Self& itk::simple::GaborImageSource::SetSpacing ( std::vector< double >  Spacing)
inline

Definition at line 126 of file sitkGaborImageSource.h.

◆ ToString()

std::string itk::simple::GaborImageSource::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 160 of file sitkGaborImageSource.h.

Member Data Documentation

◆ m_Direction

std::vector<double> itk::simple::GaborImageSource::m_Direction {std::vector<double>()}
private

Definition at line 180 of file sitkGaborImageSource.h.

◆ m_Frequency

double itk::simple::GaborImageSource::m_Frequency {0.4}
private

Definition at line 173 of file sitkGaborImageSource.h.

◆ m_Mean

std::vector<double> itk::simple::GaborImageSource::m_Mean {std::vector<double>(3, 32.0)}
private

Definition at line 171 of file sitkGaborImageSource.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GaborImageSource::m_MemberFactory
private

Definition at line 162 of file sitkGaborImageSource.h.

◆ m_Origin

std::vector<double> itk::simple::GaborImageSource::m_Origin {std::vector<double>(3, 0.0)}
private

Definition at line 175 of file sitkGaborImageSource.h.

◆ m_OutputPixelType

PixelIDValueEnum itk::simple::GaborImageSource::m_OutputPixelType {itk::simple::sitkFloat32}
private

Definition at line 165 of file sitkGaborImageSource.h.

◆ m_Sigma

std::vector<double> itk::simple::GaborImageSource::m_Sigma {std::vector<double>(3, 16.0)}
private

Definition at line 169 of file sitkGaborImageSource.h.

◆ m_Size

std::vector<unsigned int> itk::simple::GaborImageSource::m_Size {std::vector<unsigned int>(3, 64)}
private

Definition at line 167 of file sitkGaborImageSource.h.

◆ m_Spacing

std::vector<double> itk::simple::GaborImageSource::m_Spacing {std::vector<double>(3, 1.0)}
private

Definition at line 177 of file sitkGaborImageSource.h.


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