itk::GaborImageSource< TOutputImage > Class Template Reference

#include <itkGaborImageSource.h>

Inheritance diagram for itk::GaborImageSource< TOutputImage >:

Collaboration diagram for itk::GaborImageSource< TOutputImage >:

List of all members.

Public Types
typedef FixedArray< double, itkGetStaticConstMacro(ImageDimension) >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef OutputImageType::DirectionType	DirectionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef OutputImageType::PointType	PointType
typedef OutputImageType::RegionType	RegionType
typedef GaborImageSource	Self
typedef RegionType::SizeType	SizeType
typedef OutputImageType::SpacingType	SpacingType
typedef GenerateImageSource < TOutputImage >	Superclass
Public Types inherited from itk::GenerateImageSource< TOutputImage >
typedef TOutputImage::SizeValueType	SizeValueType
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	CalculateImaginaryPartOff ()
virtual void	CalculateImaginaryPartOn ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetCalculateImaginaryPart ()
virtual const double &	GetFrequency ()
virtual const ArrayType &	GetMean ()
virtual const char *	GetNameOfClass () const
virtual const ArrayType &	GetSigma ()
virtual void	SetCalculateImaginaryPart (bool _arg)
virtual void	SetFrequency (double _arg)
virtual void	SetMean (ArrayType _arg)
virtual void	SetSigma (ArrayType _arg)
Public Member Functions inherited from itk::GenerateImageSource< TOutputImage >
virtual void	SetSize (SizeType _arg)
virtual const SizeType &	GetSize ()
virtual void	SetSize (SizeValueType data[])
virtual void	SetSpacing (SpacingType _arg)
virtual const SpacingType &	GetSpacing ()
virtual void	SetSpacing (const float data[])
virtual void	SetOrigin (PointType _arg)
virtual const PointType &	GetOrigin ()
virtual void	SetOrigin (const float data[])
virtual void	SetDirection (DirectionType _arg)
virtual const DirectionType &	GetDirection ()
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 Attributes
static const unsigned int	ImageDimension = OutputImageType::ImageDimension
Static Public Attributes inherited from itk::GenerateImageSource< TOutputImage >
static const unsigned int	NDimensions = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
	GaborImageSource ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::GenerateImageSource< TOutputImage >
	GenerateImageSource ()
virtual void	GenerateOutputInformation ()
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
	GaborImageSource (const GaborImageSource &)
void	operator= (const GaborImageSource &)

Private Attributes
bool	m_CalculateImaginaryPart
double	m_Frequency
ArrayType	m_Mean
double	m_PhaseOffset
ArrayType	m_Sigma

---

Detailed Description

template<typename TOutputImage>
class itk::GaborImageSource< TOutputImage >

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

Definition at line 47 of file itkGaborImageSource.h.

---

Member Typedef Documentation

template<typename TOutputImage >

typedef FixedArray< double, itkGetStaticConstMacro(ImageDimension) > itk::GaborImageSource< TOutputImage >::ArrayType

Type used to store gabor parameters.

Definition at line 80 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef SmartPointer< const Self > itk::GaborImageSource< TOutputImage >::ConstPointer

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 56 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef OutputImageType::DirectionType itk::GaborImageSource< TOutputImage >::DirectionType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 64 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef TOutputImage itk::GaborImageSource< TOutputImage >::OutputImageType

Output image typedefs

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 59 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef OutputImageType::PixelType itk::GaborImageSource< TOutputImage >::PixelType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 60 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef SmartPointer< Self > itk::GaborImageSource< TOutputImage >::Pointer

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 55 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef OutputImageType::PointType itk::GaborImageSource< TOutputImage >::PointType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 63 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef OutputImageType::RegionType itk::GaborImageSource< TOutputImage >::RegionType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 61 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef GaborImageSource itk::GaborImageSource< TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 53 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef RegionType::SizeType itk::GaborImageSource< TOutputImage >::SizeType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 66 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef OutputImageType::SpacingType itk::GaborImageSource< TOutputImage >::SpacingType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 62 of file itkGaborImageSource.h.

template<typename TOutputImage >

typedef GenerateImageSource< TOutputImage > itk::GaborImageSource< TOutputImage >::Superclass

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 54 of file itkGaborImageSource.h.

---

Constructor & Destructor Documentation

template<typename TOutputImage >

itk::GaborImageSource< TOutputImage >::GaborImageSource ( )

protected

template<typename TOutputImage >

itk::GaborImageSource< TOutputImage >::GaborImageSource ( const GaborImageSource< TOutputImage > &  )

private

---

Member Function Documentation

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::CalculateImaginaryPartOff ( )

virtual

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::CalculateImaginaryPartOn ( )

virtual

template<typename TOutputImage >

virtual::itk::LightObject::Pointer itk::GaborImageSource< TOutputImage >::CreateAnother ( void  ) 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 TOutputImage >

void itk::GaborImageSource< TOutputImage >::GenerateData ( )

protectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage >

virtual const bool& itk::GaborImageSource< TOutputImage >::GetCalculateImaginaryPart ( )

virtual

template<typename TOutputImage >

virtual const double& itk::GaborImageSource< TOutputImage >::GetFrequency ( )

virtual

template<typename TOutputImage >

virtual const ArrayType& itk::GaborImageSource< TOutputImage >::GetMean ( )

virtual

template<typename TOutputImage >

virtual const char* itk::GaborImageSource< TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::GenerateImageSource< TOutputImage >.

template<typename TOutputImage >

virtual const ArrayType& itk::GaborImageSource< TOutputImage >::GetSigma ( )

virtual

template<typename TOutputImage >

static Pointer itk::GaborImageSource< TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TOutputImage >

void itk::GaborImageSource< TOutputImage >::operator= ( const GaborImageSource< TOutputImage > &  )

private

template<typename TOutputImage >

void itk::GaborImageSource< TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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::GenerateImageSource< TOutputImage >.

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::SetCalculateImaginaryPart ( bool  _arg )

virtual

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::SetFrequency ( double  _arg )

virtual

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::SetMean ( ArrayType  _arg )

virtual

template<typename TOutputImage >

virtual void itk::GaborImageSource< TOutputImage >::SetSigma ( ArrayType  _arg )

virtual

---

Member Data Documentation

template<typename TOutputImage >

const unsigned int itk::GaborImageSource< TOutputImage >::ImageDimension = OutputImageType::ImageDimension

static

Dimensionality of the output image

Definition at line 76 of file itkGaborImageSource.h.

template<typename TOutputImage >

bool itk::GaborImageSource< TOutputImage >::m_CalculateImaginaryPart

private

Parameters for the Gabor. Evaluate using the complex part

Definition at line 108 of file itkGaborImageSource.h.

template<typename TOutputImage >

double itk::GaborImageSource< TOutputImage >::m_Frequency

private

Modulation frequency of the sine or cosine component

Definition at line 111 of file itkGaborImageSource.h.

template<typename TOutputImage >

ArrayType itk::GaborImageSource< TOutputImage >::m_Mean

private

The mean in each direction.

Definition at line 120 of file itkGaborImageSource.h.

template<typename TOutputImage >

double itk::GaborImageSource< TOutputImage >::m_PhaseOffset

private

Evaluate using a stretched gabor filter (ensure zero dc response)

Definition at line 114 of file itkGaborImageSource.h.

template<typename TOutputImage >

ArrayType itk::GaborImageSource< TOutputImage >::m_Sigma

private

The standard deviation in each direction.

Definition at line 117 of file itkGaborImageSource.h.

---

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

• itkGaborImageSource.h