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::GridImageSource< TOutputImage > Class Template Reference

#include <itkGridImageSource.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TOutputImage::DirectionType DirectionType
typedef TOutputImage::RegionType ImageRegionType
typedef TOutputImage ImageType
typedef KernelFunctionBase
< double > 
KernelFunctionType
typedef TOutputImage::PointType OriginType
typedef TOutputImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef double RealType
typedef GridImageSource Self
typedef TOutputImage::SizeType SizeType
typedef TOutputImage::SpacingType SpacingType
typedef GenerateImageSource
< TOutputImage > 
Superclass
typedef FixedArray< RealType,
itkGetStaticConstMacro(ImageDimension) > 
ArrayType
typedef FixedArray< bool,
itkGetStaticConstMacro(ImageDimension) > 
BoolArrayType
typedef vnl_vector< RealTypePixelArrayType
typedef VectorContainer
< SizeValueType,
PixelArrayType
PixelArrayContainerType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const ArrayTypeGetGridOffset ()
virtual const ArrayTypeGetGridSpacing ()
virtual const char * GetNameOfClass () const
virtual const RealTypeGetScale ()
virtual const ArrayTypeGetSigma ()
virtual const BoolArrayTypeGetWhichDimensions ()
virtual void SetGridOffset (ArrayType _arg)
virtual void SetGridSpacing (ArrayType _arg)
virtual void SetScale (RealType _arg)
virtual void SetSigma (ArrayType _arg)
virtual void SetWhichDimensions (BoolArrayType _arg)
virtual void SetKernelFunction (KernelFunctionType *_arg)
virtual const
KernelFunctionType::Pointer
GetKernelFunction () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension

Protected Member Functions

virtual void BeforeThreadedGenerateData ()
 GridImageSource ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void ThreadedGenerateData (const ImageRegionType &outputRegionForThread, ThreadIdType threadId)

Private Member Functions

 GridImageSource (const GridImageSource &)
void operator= (const GridImageSource &)

Private Attributes

ArrayType m_GridOffset
ArrayType m_GridSpacing
KernelFunctionType::Pointer m_KernelFunction
PixelArrayContainerType::Pointer m_PixelArrays
RealType m_Scale
ArrayType m_Sigma
BoolArrayType m_WhichDimensions

Detailed Description

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

Generate an n-dimensional image of a grid.

GridImageSource generates an image of a grid. From the abstract... "Certain classes of images find disparate use amongst members of the ITK community for such purposes as visualization, simulation, testing, etc. Currently there exists two derived classes from the ImageSource class used for generating specific images for various applications, viz. RandomImageSource and GaussianImageSource. We propose to add to this set with the class GridImageSource which, obviously enough, produces a grid image. Such images are useful for visualizing deformation when used in conjunction with the WarpImageFilter, simulating magnetic resonance tagging images, or creating optical illusions with which to amaze your friends."

The output image may be of any dimension.

Author:
Tustison N., Avants B., Gee J. University of Pennsylvania

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/475

Definition at line 57 of file itkGridImageSource.h.


Member Typedef Documentation

template<typename TOutputImage >
typedef FixedArray< RealType, itkGetStaticConstMacro(ImageDimension) > itk::GridImageSource< TOutputImage >::ArrayType

Other convenient types.

Definition at line 91 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef FixedArray< bool, itkGetStaticConstMacro(ImageDimension) > itk::GridImageSource< TOutputImage >::BoolArrayType

Other convenient types.

Definition at line 93 of file itkGridImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 65 of file itkGridImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 85 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef TOutputImage::RegionType itk::GridImageSource< TOutputImage >::ImageRegionType

Definition at line 81 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef TOutputImage itk::GridImageSource< TOutputImage >::ImageType

Typedef for the output image types.

Definition at line 80 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef KernelFunctionBase<double> itk::GridImageSource< TOutputImage >::KernelFunctionType

Definition at line 88 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef TOutputImage::PointType itk::GridImageSource< TOutputImage >::OriginType

Definition at line 84 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef VectorContainer< SizeValueType, PixelArrayType > itk::GridImageSource< TOutputImage >::PixelArrayContainerType

Other convenient types.

Definition at line 95 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef vnl_vector< RealType > itk::GridImageSource< TOutputImage >::PixelArrayType

Other convenient types.

Definition at line 94 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef TOutputImage::PixelType itk::GridImageSource< TOutputImage >::PixelType

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 82 of file itkGridImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 64 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef double itk::GridImageSource< TOutputImage >::RealType

Definition at line 71 of file itkGridImageSource.h.

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

Standard class typedefs.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 62 of file itkGridImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 86 of file itkGridImageSource.h.

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

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 83 of file itkGridImageSource.h.

template<typename TOutputImage >
typedef GenerateImageSource< TOutputImage > itk::GridImageSource< TOutputImage >::Superclass

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 63 of file itkGridImageSource.h.


Constructor & Destructor Documentation

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

Member Function Documentation

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage >
virtual::itk::LightObject::Pointer itk::GridImageSource< 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 >
virtual const ArrayType& itk::GridImageSource< TOutputImage >::GetGridOffset ( ) [virtual]
template<typename TOutputImage >
virtual const ArrayType& itk::GridImageSource< TOutputImage >::GetGridSpacing ( ) [virtual]
template<typename TOutputImage >
virtual const KernelFunctionType ::Pointer& itk::GridImageSource< TOutputImage >::GetKernelFunction ( ) const [virtual]

Gets and sets for grid parameters

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

Run-time type information (and related methods).

Reimplemented from itk::GenerateImageSource< TOutputImage >.

template<typename TOutputImage >
virtual const RealType& itk::GridImageSource< TOutputImage >::GetScale ( ) [virtual]
template<typename TOutputImage >
virtual const ArrayType& itk::GridImageSource< TOutputImage >::GetSigma ( ) [virtual]
template<typename TOutputImage >
virtual const BoolArrayType& itk::GridImageSource< TOutputImage >::GetWhichDimensions ( ) [virtual]
template<typename TOutputImage >
static Pointer itk::GridImageSource< TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

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

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetGridOffset ( ArrayType  _arg) [virtual]
template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetGridSpacing ( ArrayType  _arg) [virtual]
template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetKernelFunction ( KernelFunctionType _arg) [virtual]

Gets and sets for grid parameters

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetScale ( RealType  _arg) [virtual]
template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetSigma ( ArrayType  _arg) [virtual]
template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetWhichDimensions ( BoolArrayType  _arg) [virtual]
template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::ThreadedGenerateData ( const ImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

Member Data Documentation

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

Dimensionality of the output image

Definition at line 77 of file itkGridImageSource.h.

template<typename TOutputImage >
ArrayType itk::GridImageSource< TOutputImage >::m_GridOffset [private]

The grid spacing of the peaks.

Definition at line 148 of file itkGridImageSource.h.

template<typename TOutputImage >
ArrayType itk::GridImageSource< TOutputImage >::m_GridSpacing [private]

The grid spacing of the peaks.

Definition at line 145 of file itkGridImageSource.h.

template<typename TOutputImage >
KernelFunctionType::Pointer itk::GridImageSource< TOutputImage >::m_KernelFunction [private]

The kernel function used to create the grid

Definition at line 138 of file itkGridImageSource.h.

template<typename TOutputImage >
PixelArrayContainerType::Pointer itk::GridImageSource< TOutputImage >::m_PixelArrays [private]

Parameters for the grid. Internal variable to speed up the calculation of pixel values

Definition at line 135 of file itkGridImageSource.h.

template<typename TOutputImage >
RealType itk::GridImageSource< TOutputImage >::m_Scale [private]

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

Definition at line 154 of file itkGridImageSource.h.

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

The standard deviation of the gaussians or width of the box functions.

Definition at line 142 of file itkGridImageSource.h.

template<typename TOutputImage >
BoolArrayType itk::GridImageSource< TOutputImage >::m_WhichDimensions [private]

Which dimensions which are gridded.

Definition at line 151 of file itkGridImageSource.h.


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