SimpleITK  1.3.0.dev466
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

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef GaborImageSource Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute ()
 
Image Execute (PixelIDValueEnum outputPixelType, const std::vector< unsigned int > &size, const std::vector< double > &sigma, const std::vector< double > &mean, double frequency, const std::vector< double > &origin, const std::vector< double > &spacing, std::vector< double > direction)
 
 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 (const std::vector< double > &Mean)
 
SelfSetMean (double value)
 
SelfSetOrigin (const std::vector< double > &Origin)
 
SelfSetOutputPixelType (PixelIDValueEnum OutputPixelType)
 
SelfSetSigma (const std::vector< double > &Sigma)
 
SelfSetSigma (double value)
 
SelfSetSize (const std::vector< unsigned int > &Size)
 
SelfSetSpacing (const std::vector< double > &Spacing)
 
std::string ToString () const
 
virtual ~GaborImageSource ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) ()
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal ()
 

Private Attributes

std::vector< double > m_Direction
 
double m_Frequency
 
std::vector< double > m_Mean
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_Origin
 
PixelIDValueEnum m_OutputPixelType
 
std::vector< double > m_Sigma
 
std::vector< unsigned int > m_Size
 
std::vector< double > m_Spacing
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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

typedef Image(Self::* itk::simple::GaborImageSource::MemberFunctionType) ()
private

Setup for member function dispatching

Definition at line 160 of file sitkGaborImageSource.h.

Define the pixels types supported by this filter

Definition at line 58 of file sitkGaborImageSource.h.

Definition at line 48 of file sitkGaborImageSource.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::GaborImageSource::Execute ( PixelIDValueEnum  outputPixelType,
const std::vector< unsigned int > &  size,
const std::vector< double > &  sigma,
const std::vector< double > &  mean,
double  frequency,
const std::vector< double > &  origin,
const std::vector< double > &  spacing,
std::vector< double >  direction 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::GaborImageSource::ExecuteInternal ( )
private
std::vector<double> itk::simple::GaborImageSource::GetDirection ( ) const
inline

Definition at line 140 of file sitkGaborImageSource.h.

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

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

Definition at line 116 of file sitkGaborImageSource.h.

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

Set/Get the mean in each direction.

Definition at line 106 of file sitkGaborImageSource.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 142 of file sitkGaborImageSource.h.

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

Definition at line 124 of file sitkGaborImageSource.h.

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

Definition at line 70 of file sitkGaborImageSource.h.

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

Set/Get the the standard deviation in each direction.

Definition at line 92 of file sitkGaborImageSource.h.

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

Definition at line 78 of file sitkGaborImageSource.h.

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

Definition at line 132 of file sitkGaborImageSource.h.

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

Definition at line 136 of file sitkGaborImageSource.h.

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

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

Definition at line 111 of file sitkGaborImageSource.h.

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

Set/Get the mean in each direction.

Definition at line 97 of file sitkGaborImageSource.h.

References itk::simple::Mean().

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

Set the values of the Mean vector all to value

Definition at line 100 of file sitkGaborImageSource.h.

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

Definition at line 120 of file sitkGaborImageSource.h.

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

Definition at line 66 of file sitkGaborImageSource.h.

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

Set/Get the the standard deviation in each direction.

Definition at line 83 of file sitkGaborImageSource.h.

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.

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

Definition at line 74 of file sitkGaborImageSource.h.

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

Definition at line 128 of file sitkGaborImageSource.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 164 of file sitkGaborImageSource.h.

Member Data Documentation

std::vector<double> itk::simple::GaborImageSource::m_Direction
private

Definition at line 177 of file sitkGaborImageSource.h.

double itk::simple::GaborImageSource::m_Frequency
private

Definition at line 173 of file sitkGaborImageSource.h.

std::vector<double> itk::simple::GaborImageSource::m_Mean
private

Definition at line 172 of file sitkGaborImageSource.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GaborImageSource::m_MemberFactory
private

Definition at line 166 of file sitkGaborImageSource.h.

std::vector<double> itk::simple::GaborImageSource::m_Origin
private

Definition at line 174 of file sitkGaborImageSource.h.

PixelIDValueEnum itk::simple::GaborImageSource::m_OutputPixelType
private

Definition at line 169 of file sitkGaborImageSource.h.

std::vector<double> itk::simple::GaborImageSource::m_Sigma
private

Definition at line 171 of file sitkGaborImageSource.h.

std::vector<unsigned int> itk::simple::GaborImageSource::m_Size
private

Definition at line 170 of file sitkGaborImageSource.h.

std::vector<double> itk::simple::GaborImageSource::m_Spacing
private

Definition at line 175 of file sitkGaborImageSource.h.


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