SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GridImageSource Class Reference

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

#include <sitkGridImageSource.h>

+ Inheritance diagram for itk::simple::GridImageSource:
+ Collaboration diagram for itk::simple::GridImageSource:

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef GridImageSource 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 > &gridSpacing, const std::vector< double > &gridOffset, double scale, const std::vector< double > &origin, const std::vector< double > &spacing, std::vector< double > direction)
 
std::vector< double > GetDirection () const
 
std::vector< double > GetGridOffset () const
 
std::vector< double > GetGridSpacing () const
 
std::string GetName () const
 
std::vector< double > GetOrigin () const
 
PixelIDValueEnum GetOutputPixelType () const
 
double GetScale () const
 
std::vector< double > GetSigma () const
 
std::vector< unsigned int > GetSize () const
 
std::vector< double > GetSpacing () const
 
 GridImageSource ()
 
SelfSetDirection (std::vector< double > Direction)
 
SelfSetGridOffset (const std::vector< double > &GridOffset)
 
SelfSetGridSpacing (const std::vector< double > &GridSpacing)
 
SelfSetOrigin (const std::vector< double > &Origin)
 
SelfSetOutputPixelType (PixelIDValueEnum OutputPixelType)
 
SelfSetScale (double Scale)
 
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 ~GridImageSource ()
 
- 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
 
std::vector< double > m_GridOffset
 
std::vector< double > m_GridSpacing
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_Origin
 
PixelIDValueEnum m_OutputPixelType
 
double m_Scale
 
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 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: https://hdl.handle.net/1926/475

See also
itk::simple::GridSource for the procedural interface
itk::GridImageSource for the Doxygen on the original ITK class.

Definition at line 48 of file sitkGridImageSource.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 168 of file sitkGridImageSource.h.

Define the pixels types supported by this filter

Definition at line 60 of file sitkGridImageSource.h.

Definition at line 50 of file sitkGridImageSource.h.

Constructor & Destructor Documentation

virtual itk::simple::GridImageSource::~GridImageSource ( )
virtual

Destructor

itk::simple::GridImageSource::GridImageSource ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::GridImageSource::Execute ( )

Execute the filter on the input image

Image itk::simple::GridImageSource::Execute ( PixelIDValueEnum  outputPixelType,
const std::vector< unsigned int > &  size,
const std::vector< double > &  sigma,
const std::vector< double > &  gridSpacing,
const std::vector< double > &  gridOffset,
double  scale,
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::GridImageSource::ExecuteInternal ( )
private
std::vector<double> itk::simple::GridImageSource::GetDirection ( ) const
inline

Definition at line 148 of file sitkGridImageSource.h.

std::vector<double> itk::simple::GridImageSource::GetGridOffset ( ) const
inline

Set/Get the grid offset.

Definition at line 114 of file sitkGridImageSource.h.

std::vector<double> itk::simple::GridImageSource::GetGridSpacing ( ) const
inline

Set/Get the grid spacing of the peaks.

Definition at line 104 of file sitkGridImageSource.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 150 of file sitkGridImageSource.h.

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

Definition at line 132 of file sitkGridImageSource.h.

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

Definition at line 72 of file sitkGridImageSource.h.

double itk::simple::GridImageSource::GetScale ( ) const
inline

Set/Get the scale factor to multiply the true value of the grid.

Definition at line 124 of file sitkGridImageSource.h.

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

Set/Get the standard deviation of the Gaussians or width of the box functions.

Definition at line 94 of file sitkGridImageSource.h.

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

Definition at line 80 of file sitkGridImageSource.h.

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

Definition at line 140 of file sitkGridImageSource.h.

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

Definition at line 144 of file sitkGridImageSource.h.

Self& itk::simple::GridImageSource::SetGridOffset ( const std::vector< double > &  GridOffset)
inline

Set/Get the grid offset.

Definition at line 109 of file sitkGridImageSource.h.

Self& itk::simple::GridImageSource::SetGridSpacing ( const std::vector< double > &  GridSpacing)
inline

Set/Get the grid spacing of the peaks.

Definition at line 99 of file sitkGridImageSource.h.

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

Definition at line 128 of file sitkGridImageSource.h.

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

Definition at line 68 of file sitkGridImageSource.h.

Self& itk::simple::GridImageSource::SetScale ( double  Scale)
inline

Set/Get the scale factor to multiply the true value of the grid.

Definition at line 119 of file sitkGridImageSource.h.

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

Set/Get the standard deviation of the Gaussians or width of the box functions.

Definition at line 85 of file sitkGridImageSource.h.

Self& itk::simple::GridImageSource::SetSigma ( double  value)
inline

Set the values of the Sigma vector all to value

Definition at line 88 of file sitkGridImageSource.h.

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

Definition at line 76 of file sitkGridImageSource.h.

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

Definition at line 136 of file sitkGridImageSource.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 172 of file sitkGridImageSource.h.

Member Data Documentation

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

Definition at line 186 of file sitkGridImageSource.h.

std::vector<double> itk::simple::GridImageSource::m_GridOffset
private

Definition at line 181 of file sitkGridImageSource.h.

std::vector<double> itk::simple::GridImageSource::m_GridSpacing
private

Definition at line 180 of file sitkGridImageSource.h.

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

Definition at line 174 of file sitkGridImageSource.h.

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

Definition at line 183 of file sitkGridImageSource.h.

PixelIDValueEnum itk::simple::GridImageSource::m_OutputPixelType
private

Definition at line 177 of file sitkGridImageSource.h.

double itk::simple::GridImageSource::m_Scale
private

Definition at line 182 of file sitkGridImageSource.h.

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

Definition at line 179 of file sitkGridImageSource.h.

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

Definition at line 178 of file sitkGridImageSource.h.

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

Definition at line 184 of file sitkGridImageSource.h.


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