SimpleITK  2.0.0rc2.post21
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

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = GridImageSource
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute ()
 
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 (std::vector< double > GridOffset)
 
SelfSetGridSpacing (std::vector< double > GridSpacing)
 
SelfSetOrigin (std::vector< double > Origin)
 
SelfSetOutputPixelType (PixelIDValueEnum OutputPixelType)
 
SelfSetScale (double Scale)
 
SelfSetSigma (double value)
 
SelfSetSigma (std::vector< double > Sigma)
 
SelfSetSize (std::vector< unsigned int > Size)
 
SelfSetSpacing (std::vector< double > Spacing)
 
std::string ToString () const
 
virtual ~GridImageSource ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)()
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal ()
 

Private Attributes

std::vector< double > m_Direction {std::vector<double>()}
 
std::vector< double > m_GridOffset {std::vector<double>(3, 0.0)}
 
std::vector< double > m_GridSpacing {std::vector<double>(3, 4.0)}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_Origin {std::vector<double>(3, 0.0)}
 
PixelIDValueEnum m_OutputPixelType {itk::simple::sitkFloat32}
 
double m_Scale {255.0}
 
std::vector< double > m_Sigma {std::vector<double>(3, 0.5)}
 
std::vector< unsigned int > m_Size {std::vector<unsigned int>(3, 64)}
 
std::vector< double > m_Spacing {std::vector<double>(3, 1.0)}
 

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 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- 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) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *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 49 of file sitkGridImageSource.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 166 of file sitkGridImageSource.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkGridImageSource.h.

◆ Self

Definition at line 51 of file sitkGridImageSource.h.

Constructor & Destructor Documentation

◆ ~GridImageSource()

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

Destructor

◆ GridImageSource()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::GridImageSource::ExecuteInternal ( )
private

◆ GetDirection()

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

Definition at line 148 of file sitkGridImageSource.h.

◆ GetGridOffset()

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

Set/Get the grid offset.

Definition at line 114 of file sitkGridImageSource.h.

◆ GetGridSpacing()

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.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 151 of file sitkGridImageSource.h.

◆ GetOrigin()

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

Definition at line 132 of file sitkGridImageSource.h.

◆ GetOutputPixelType()

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

Definition at line 73 of file sitkGridImageSource.h.

◆ GetScale()

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.

◆ GetSigma()

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.

◆ GetSize()

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

Definition at line 81 of file sitkGridImageSource.h.

◆ GetSpacing()

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

Definition at line 140 of file sitkGridImageSource.h.

◆ SetDirection()

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

Definition at line 144 of file sitkGridImageSource.h.

◆ SetGridOffset()

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

Set/Get the grid offset.

Definition at line 109 of file sitkGridImageSource.h.

◆ SetGridSpacing()

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

Set/Get the grid spacing of the peaks.

Definition at line 99 of file sitkGridImageSource.h.

◆ SetOrigin()

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

Definition at line 128 of file sitkGridImageSource.h.

◆ SetOutputPixelType()

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

Definition at line 69 of file sitkGridImageSource.h.

◆ SetScale()

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.

◆ SetSigma() [1/2]

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

Set the values of the Sigma vector all to value

Definition at line 89 of file sitkGridImageSource.h.

◆ SetSigma() [2/2]

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

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

Definition at line 86 of file sitkGridImageSource.h.

◆ SetSize()

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

Definition at line 77 of file sitkGridImageSource.h.

◆ SetSpacing()

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

Definition at line 136 of file sitkGridImageSource.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 170 of file sitkGridImageSource.h.

Member Data Documentation

◆ m_Direction

std::vector<double> itk::simple::GridImageSource::m_Direction {std::vector<double>()}
private

Definition at line 192 of file sitkGridImageSource.h.

◆ m_GridOffset

std::vector<double> itk::simple::GridImageSource::m_GridOffset {std::vector<double>(3, 0.0)}
private

Definition at line 183 of file sitkGridImageSource.h.

◆ m_GridSpacing

std::vector<double> itk::simple::GridImageSource::m_GridSpacing {std::vector<double>(3, 4.0)}
private

Definition at line 181 of file sitkGridImageSource.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GridImageSource::m_MemberFactory
private

Definition at line 172 of file sitkGridImageSource.h.

◆ m_Origin

std::vector<double> itk::simple::GridImageSource::m_Origin {std::vector<double>(3, 0.0)}
private

Definition at line 187 of file sitkGridImageSource.h.

◆ m_OutputPixelType

PixelIDValueEnum itk::simple::GridImageSource::m_OutputPixelType {itk::simple::sitkFloat32}
private

Definition at line 175 of file sitkGridImageSource.h.

◆ m_Scale

double itk::simple::GridImageSource::m_Scale {255.0}
private

Definition at line 185 of file sitkGridImageSource.h.

◆ m_Sigma

std::vector<double> itk::simple::GridImageSource::m_Sigma {std::vector<double>(3, 0.5)}
private

Definition at line 179 of file sitkGridImageSource.h.

◆ m_Size

std::vector<unsigned int> itk::simple::GridImageSource::m_Size {std::vector<unsigned int>(3, 64)}
private

Definition at line 177 of file sitkGridImageSource.h.

◆ m_Spacing

std::vector<double> itk::simple::GridImageSource::m_Spacing {std::vector<double>(3, 1.0)}
private

Definition at line 189 of file sitkGridImageSource.h.


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