ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::GaussianImageSource< TOutputImage > Class Template Reference

#include <itkGaussianImageSource.h>

+ Inheritance diagram for itk::GaussianImageSource< TOutputImage >:
+ Collaboration diagram for itk::GaussianImageSource< TOutputImage >:

List of all members.

Public Types

typedef FixedArray< double,
itkGetStaticConstMacro(NDimensions) > 
ArrayType
typedef SmartPointer< const SelfConstPointer
typedef TOutputImage::DirectionType DirectionType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::RegionType OutputImageRegionType
typedef Superclass::ParametersType ParametersType
typedef
Superclass::ParametersValueType 
ParametersValueType
typedef SmartPointer< SelfPointer
typedef TOutputImage::PointType PointType
typedef GaussianImageSource Self
typedef TOutputImage::SizeType SizeType
typedef TOutputImage::SizeValueType SizeValueType
typedef TOutputImage::SpacingType SpacingType
typedef ParametricImageSource
< TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual unsigned int GetNumberOfParameters () const
virtual void SetScale (double _arg)
virtual const double & GetScale ()
virtual void SetNormalized (bool _arg)
virtual const bool & GetNormalized ()
virtual void SetSigma (ArrayType _arg)
virtual const ArrayTypeGetSigma ()
virtual void SetMean (ArrayType _arg)
virtual const ArrayTypeGetMean ()
virtual void SetParameters (const ParametersType &parameters)
virtual ParametersType GetParameters () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int NDimensions = TOutputImage::ImageDimension

Protected Member Functions

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

Private Member Functions

 GaussianImageSource (const GaussianImageSource &)
void operator= (const GaussianImageSource &)

Private Attributes

DirectionType m_Direction
ArrayType m_Mean
bool m_Normalized
PointType m_Origin
double m_Scale
ArrayType m_Sigma
SizeType m_Size
SpacingType m_Spacing

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 44 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 76 of file itkGaussianImageSource.h.

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

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 52 of file itkGaussianImageSource.h.

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

Direction typedef support. The direction is the direction cosines of the image.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 70 of file itkGaussianImageSource.h.

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

Typedef for the output image PixelType.

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 55 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 58 of file itkGaussianImageSource.h.

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

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 84 of file itkGaussianImageSource.h.

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

Types for parameters.

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 83 of file itkGaussianImageSource.h.

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

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 51 of file itkGaussianImageSource.h.

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

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 66 of file itkGaussianImageSource.h.

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

Standard class typedefs.

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 49 of file itkGaussianImageSource.h.

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

Size type matches that used for images

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 79 of file itkGaussianImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 80 of file itkGaussianImageSource.h.

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

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 62 of file itkGaussianImageSource.h.

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

Reimplemented from itk::ParametricImageSource< TOutputImage >.

Definition at line 50 of file itkGaussianImageSource.h.


Constructor & Destructor Documentation

template<typename TOutputImage >
itk::GaussianImageSource< TOutputImage >::GaussianImageSource ( ) [protected]
template<typename TOutputImage >
itk::GaussianImageSource< TOutputImage >::GaussianImageSource ( const GaussianImageSource< TOutputImage > &  ) [private]

Member Function Documentation

template<typename TOutputImage >
virtual::itk::LightObject::Pointer itk::GaussianImageSource< 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::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 const ArrayType& itk::GaussianImageSource< TOutputImage >::GetMean ( ) [virtual]

Gets and sets for Gaussian parameters

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

Run-time type information (and related methods).

Reimplemented from itk::ParametricImageSource< TOutputImage >.

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

Gets and sets for Gaussian parameters

template<typename TOutputImage >
virtual unsigned int itk::GaussianImageSource< TOutputImage >::GetNumberOfParameters ( ) const [virtual]

Get the number of parameters for this image source. When this source is templated over an N-dimensional output image type, the number of parameters is 2*N+1.

Implements itk::ParametricImageSource< TOutputImage >.

template<typename TOutputImage >
virtual ParametersType itk::GaussianImageSource< TOutputImage >::GetParameters ( ) const [virtual]

Set/get the parameters for this source. When this source is templated over an N-dimensional output image type, the first N values in the parameter array are the Sigma parameters in each dimension, the next N values are the Mean parameters in each dimension, and the last value is the Scale.

Implements itk::ParametricImageSource< TOutputImage >.

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

Gets and sets for Gaussian parameters

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

Gets and sets for Gaussian parameters

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TOutputImage >
void itk::GaussianImageSource< TOutputImage >::operator= ( const GaussianImageSource< TOutputImage > &  ) [private]
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::ParametricImageSource< TOutputImage >.

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 >::SetParameters ( const ParametersType parameters) [virtual]

Set/get the parameters for this source. When this source is templated over an N-dimensional output image type, the first N values in the parameter array are the Sigma parameters in each dimension, the next N values are the Mean parameters in each dimension, and the last value is the Scale.

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


Member Data Documentation

template<typename TOutputImage >
DirectionType itk::GaussianImageSource< TOutputImage >::m_Direction [private]

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 131 of file itkGaussianImageSource.h.

template<typename TOutputImage >
ArrayType itk::GaussianImageSource< TOutputImage >::m_Mean [private]

The mean in each direction.

Definition at line 139 of file itkGaussianImageSource.h.

template<typename TOutputImage >
bool itk::GaussianImageSource< TOutputImage >::m_Normalized [private]

Whether or not to normalize the Gaussian.

Definition at line 145 of file itkGaussianImageSource.h.

template<typename TOutputImage >
PointType itk::GaussianImageSource< TOutputImage >::m_Origin [private]

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 130 of file itkGaussianImageSource.h.

template<typename TOutputImage >
double itk::GaussianImageSource< TOutputImage >::m_Scale [private]

A scale factor multiplied by the true value of the Gaussian.

Definition at line 142 of file itkGaussianImageSource.h.

template<typename TOutputImage >
ArrayType itk::GaussianImageSource< TOutputImage >::m_Sigma [private]

Parameters for the Gaussian. The standard deviation in each direction.

Definition at line 136 of file itkGaussianImageSource.h.

template<typename TOutputImage >
SizeType itk::GaussianImageSource< TOutputImage >::m_Size [private]

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 128 of file itkGaussianImageSource.h.

template<typename TOutputImage >
SpacingType itk::GaussianImageSource< TOutputImage >::m_Spacing [private]

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 129 of file itkGaussianImageSource.h.

template<typename TOutputImage >
const unsigned int itk::GaussianImageSource< TOutputImage >::NDimensions = TOutputImage::ImageDimension [static]

Dimensionality of the output image

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 73 of file itkGaussianImageSource.h.


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