Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::GaussianImageSource< TOutputImage > Class Template Reference
[Data Sources]

Generate an n-dimensional image of a Gaussian. More...

#include <itkGaussianImageSource.h>

Inheritance diagram for itk::GaussianImageSource< TOutputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::GaussianImageSource< TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef GaussianImageSource Self
typedef ImageSource< TOutputImage > Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::RegionType OutputImageRegionType
typedef FixedArray< double,
itkGetStaticConstMacro(NDimensions) 
ArrayType )

Public Member Functions

 itkStaticConstMacro (NDimensions, unsigned int, TOutputImage::ImageDimension)
virtual const char * GetClassName () const
virtual void SetSize (const unsigned long values[NDimensions])
virtual const unsigned long * GetSize () const
virtual const double * GetSpacing () const
virtual const double * GetOrigin () const
virtual void SetSpacing (const float values[NDimensions])
virtual void SetSpacing (const double values[NDimensions])
virtual void SetOrigin (const float values[NDimensions])
virtual void SetOrigin (const double values[NDimensions])
virtual void SetScale (double _arg)
virtual double GetScale ()
virtual void SetNormalized (bool _arg)
virtual bool GetNormalized ()
virtual void SetSigma (ArrayType _arg)
virtual ArrayType GetSigma ()
virtual void SetMean (ArrayType _arg)
virtual ArrayType GetMean ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 GaussianImageSource ()
 ~GaussianImageSource ()
void PrintSelf (std::ostream &os, Indent indent) const
void GenerateData ()
virtual void GenerateOutputInformation ()

Detailed Description

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

Generate an n-dimensional image of a Gaussian.

GaussianImageSource generates an image of a Gaussian. m_Normalized determines whether or not the Gaussian is normalized (whether or not the sum over infinite space is 1.0) When creating an image, it is preferable to _not_ normalize the Gaussian m_Scale scales the output of the Gaussian to span a range larger than 0->1, and is typically set to the maximum value of the output data type (for instance, 255 for uchars)

The output image may be of any dimension.

Definition at line 42 of file itkGaussianImageSource.h.


Member Typedef Documentation

template<typename TOutputImage>
typedef FixedArray<double, itkGetStaticConstMacro(NDimensions) itk::GaussianImageSource< TOutputImage >::ArrayType)
 

Type used to store gaussian parameters. Definition at line 61 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef SmartPointer<const Self> itk::GaussianImageSource< TOutputImage >::ConstPointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 49 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef TOutputImage::PixelType itk::GaussianImageSource< TOutputImage >::OutputImagePixelType
 

Typedef for the output image PixelType.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 52 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef TOutputImage::RegionType itk::GaussianImageSource< TOutputImage >::OutputImageRegionType
 

Typedef to describe the output image region type.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 55 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef SmartPointer<Self> itk::GaussianImageSource< TOutputImage >::Pointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 48 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef GaussianImageSource itk::GaussianImageSource< TOutputImage >::Self
 

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 46 of file itkGaussianImageSource.h.

template<typename TOutputImage>
typedef ImageSource<TOutputImage> itk::GaussianImageSource< TOutputImage >::Superclass
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 47 of file itkGaussianImageSource.h.


Constructor & Destructor Documentation

template<typename TOutputImage>
itk::GaussianImageSource< TOutputImage >::GaussianImageSource  )  [protected]
 

template<typename TOutputImage>
itk::GaussianImageSource< TOutputImage >::~GaussianImageSource  )  [protected]
 


Member Function Documentation

template<typename TOutputImage>
void itk::GaussianImageSource< TOutputImage >::GenerateData  )  [protected, virtual]
 

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 void itk::GaussianImageSource< TOutputImage >::GenerateOutputInformation  )  [protected, virtual]
 

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<typename TOutputImage>
virtual const char* itk::GaussianImageSource< TOutputImage >::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage>
virtual ArrayType itk::GaussianImageSource< TOutputImage >::GetMean  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual bool itk::GaussianImageSource< TOutputImage >::GetNormalized  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual const double* itk::GaussianImageSource< TOutputImage >::GetOrigin  )  const [virtual]
 

Get the origin of the output image.

template<typename TOutputImage>
virtual double itk::GaussianImageSource< TOutputImage >::GetScale  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual ArrayType itk::GaussianImageSource< TOutputImage >::GetSigma  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual const unsigned long* itk::GaussianImageSource< TOutputImage >::GetSize  )  const [virtual]
 

Get the size of the output image.

template<typename TOutputImage>
virtual const double* itk::GaussianImageSource< TOutputImage >::GetSpacing  )  const [virtual]
 

Get the spacing of the output image.

template<typename TOutputImage>
itk::GaussianImageSource< TOutputImage >::itkStaticConstMacro NDimensions  ,
unsigned  int,
TOutputImage::ImageDimension 
 

Dimensionality of the output image

template<typename TOutputImage>
Pointer itk::GaussianImageSource< TOutputImage >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TOutputImage>
void itk::GaussianImageSource< TOutputImage >::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

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

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetMean ArrayType  _arg  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetNormalized bool  _arg  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetOrigin const double  values[NDimensions]  )  [virtual]
 

Specify the origin of the output image.

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetOrigin const float  values[NDimensions]  )  [virtual]
 

Specify the origin of the output image.

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetScale double  _arg  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetSigma ArrayType  _arg  )  [virtual]
 

Gets and sets for gaussian parameters

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetSize const unsigned long  values[NDimensions]  )  [virtual]
 

Specify the size of the output image.

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetSpacing const double  values[NDimensions]  )  [virtual]
 

Specify the spacing of the output image.

template<typename TOutputImage>
virtual void itk::GaussianImageSource< TOutputImage >::SetSpacing const float  values[NDimensions]  )  [virtual]
 

Specify the spacing of the output image.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:44:04 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000