Class GridImageSource
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.GridImageSource
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.
Tustison N., Avants B., Gee J. University of Pennsylvania
 This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/ze1ssz
See:
 itk::simple::GridSource for the procedural interface
 itk::GridImageSource for the Doxygen on the original ITK class.
C++ includes: sitkGridImageSource.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::GridImageSource::GridImageSource() Default Constructor that takes no arguments and initializes default parametersprotectedGridImageSource(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::GridImageSource::~GridImageSource() Destructorexecute()Image itk::simple::GridImageSource::Execute() Execute the filter on the input imageprotected voidfinalize()protected static longgetCPtr(GridImageSource obj) std::vector<double> itk::simple::GridImageSource::GetDirection() conststd::vector<double> itk::simple::GridImageSource::GetGridOffset() const Set/Get the grid offset.std::vector<double> itk::simple::GridImageSource::GetGridSpacing() const Set/Get the grid spacing of the peaks.getName()std::string itk::simple::GridImageSource::GetName() const Name of this classstd::vector<double> itk::simple::GridImageSource::GetOrigin() constPixelIDValueEnum itk::simple::GridImageSource::GetOutputPixelType() constdoublegetScale()double itk::simple::GridImageSource::GetScale() const Set/Get the scale factor to multiply the true value of the grid.getSigma()std::vector<double> itk::simple::GridImageSource::GetSigma() const Set/Get the standard deviation of the Gaussians or width of the box functions.getSize()std::vector<unsigned int> itk::simple::GridImageSource::GetSize() conststd::vector<double> itk::simple::GridImageSource::GetSpacing() conststd::vector<bool> itk::simple::GridImageSource::GetWhichDimensions() const Set/Get the dimensions which are gridded.voidsetDirection(VectorDouble Direction) Self& itk::simple::GridImageSource::SetDirection(std::vector< double > Direction)voidsetGridOffset(VectorDouble GridOffset) Self& itk::simple::GridImageSource::SetGridOffset(std::vector< double > GridOffset) Set/Get the grid offset.voidsetGridSpacing(VectorDouble GridSpacing) Self& itk::simple::GridImageSource::SetGridSpacing(std::vector< double > GridSpacing) Set/Get the grid spacing of the peaks.voidsetOrigin(VectorDouble Origin) Self& itk::simple::GridImageSource::SetOrigin(std::vector< double > Origin)voidsetOutputPixelType(PixelIDValueEnum OutputPixelType) Self& itk::simple::GridImageSource::SetOutputPixelType(PixelIDValueEnum OutputPixelType)voidsetScale(double Scale) Self& itk::simple::GridImageSource::SetScale(double Scale) Set/Get the scale factor to multiply the true value of the grid.voidsetSigma(double value) Self& itk::simple::GridImageSource::SetSigma(std::vector< double > Sigma) Set/Get the standard deviation of the Gaussians or width of the box functions.voidsetSigma(VectorDouble Sigma) Self& itk::simple::GridImageSource::SetSigma(std::vector< double > Sigma) Set/Get the standard deviation of the Gaussians or width of the box functions.voidsetSize(VectorUInt32 Size) Self& itk::simple::GridImageSource::SetSize(std::vector< unsigned int > Size)voidsetSpacing(VectorDouble Spacing) Self& itk::simple::GridImageSource::SetSpacing(std::vector< double > Spacing)voidsetWhichDimensions(VectorBool WhichDimensions) Self& itk::simple::GridImageSource::SetWhichDimensions(std::vector< bool > WhichDimensions) Set/Get the dimensions which are gridded.protected static longtoString()std::string itk::simple::GridImageSource::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
- 
Constructor Details- 
GridImageSourceprotected GridImageSource(long cPtr, boolean cMemoryOwn) 
- 
GridImageSourcepublic GridImageSource()itk::simple::GridImageSource::GridImageSource() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::GridImageSource::~GridImageSource() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setOutputPixelTypeSelf& itk::simple::GridImageSource::SetOutputPixelType(PixelIDValueEnum OutputPixelType)
- 
getOutputPixelTypePixelIDValueEnum itk::simple::GridImageSource::GetOutputPixelType() const
- 
setSizeSelf& itk::simple::GridImageSource::SetSize(std::vector< unsigned int > Size)
- 
getSizestd::vector<unsigned int> itk::simple::GridImageSource::GetSize() const
- 
setSigmaSelf& itk::simple::GridImageSource::SetSigma(std::vector< double > Sigma) Set/Get the standard deviation of the Gaussians or width of the box functions.
- 
setSigmapublic void setSigma(double value) Self& itk::simple::GridImageSource::SetSigma(std::vector< double > Sigma) Set/Get the standard deviation of the Gaussians or width of the box functions.
- 
getSigmastd::vector<double> itk::simple::GridImageSource::GetSigma() const Set/Get the standard deviation of the Gaussians or width of the box functions.
- 
setGridSpacingSelf& itk::simple::GridImageSource::SetGridSpacing(std::vector< double > GridSpacing) Set/Get the grid spacing of the peaks.
- 
getGridSpacingstd::vector<double> itk::simple::GridImageSource::GetGridSpacing() const Set/Get the grid spacing of the peaks.
- 
setGridOffsetSelf& itk::simple::GridImageSource::SetGridOffset(std::vector< double > GridOffset) Set/Get the grid offset.
- 
getGridOffsetstd::vector<double> itk::simple::GridImageSource::GetGridOffset() const Set/Get the grid offset.
- 
setScalepublic void setScale(double Scale) Self& itk::simple::GridImageSource::SetScale(double Scale) Set/Get the scale factor to multiply the true value of the grid.
- 
getScalepublic double getScale()double itk::simple::GridImageSource::GetScale() const Set/Get the scale factor to multiply the true value of the grid.
- 
setOriginSelf& itk::simple::GridImageSource::SetOrigin(std::vector< double > Origin)
- 
getOriginstd::vector<double> itk::simple::GridImageSource::GetOrigin() const
- 
setSpacingSelf& itk::simple::GridImageSource::SetSpacing(std::vector< double > Spacing)
- 
getSpacingstd::vector<double> itk::simple::GridImageSource::GetSpacing() const
- 
setDirectionSelf& itk::simple::GridImageSource::SetDirection(std::vector< double > Direction)
- 
getDirectionstd::vector<double> itk::simple::GridImageSource::GetDirection() const
- 
setWhichDimensionsSelf& itk::simple::GridImageSource::SetWhichDimensions(std::vector< bool > WhichDimensions) Set/Get the dimensions which are gridded.
- 
getWhichDimensionsstd::vector<bool> itk::simple::GridImageSource::GetWhichDimensions() const Set/Get the dimensions which are gridded.
- 
getNamestd::string itk::simple::GridImageSource::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::GridImageSource::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
executeImage itk::simple::GridImageSource::Execute() Execute the filter on the input image
 
-