ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::GridImageSource< TOutputImage > Class Template Reference

#include <itkGridImageSource.h>

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: https://doi.org/10.54294/ze1ssz

Definition at line 58 of file itkGridImageSource.h.

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

Public Types

using ArrayType = FixedArray< RealType, Self::ImageDimension >
 
using BoolArrayType = FixedArray< bool, Self::ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename TOutputImage::DirectionType
 
using ImageRegionType = typename TOutputImage::RegionType
 
using ImageType = TOutputImage
 
using KernelFunctionType = KernelFunctionBase< double >
 
using OriginType = typename TOutputImage::PointType
 
using PixelArrayContainerType = VectorContainer< PixelArrayType >
 
using PixelArrayType = vnl_vector< RealType >
 
using PixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealType = double
 
using Self = GridImageSource
 
using SizeType = typename TOutputImage::SizeType
 
using SpacingType = typename TOutputImage::SpacingType
 
using Superclass = GenerateImageSource< TOutputImage >
 
- Public Types inherited from itk::GenerateImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename OutputImageType::DirectionType
 
using IndexType = typename OutputImageType::IndexType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = TOutputImage
 
using PixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename OutputImageType::PointType
 
using ReferenceImageBaseType = ImageBase< TOutputImage::ImageDimension >
 
using RegionType = typename OutputImageType::RegionType
 
using Self = GenerateImageSource
 
using SizeType = typename TOutputImage::SizeType
 
using SizeValueType = typename TOutputImage::SizeValueType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual void SetKernelFunction (KernelFunctionType *_arg)
 
virtual const KernelFunctionType::PointerGetKernelFunction () const
 
virtual void SetSigma (ArrayType _arg)
 
virtual const ArrayTypeGetSigma () const
 
virtual void SetGridSpacing (ArrayType _arg)
 
virtual const ArrayTypeGetGridSpacing () const
 
virtual void SetGridOffset (ArrayType _arg)
 
virtual const ArrayTypeGetGridOffset () const
 
virtual void SetWhichDimensions (BoolArrayType _arg)
 
virtual const BoolArrayTypeGetWhichDimensions () const
 
virtual void SetScale (RealType _arg)
 
virtual const RealTypeGetScale () const
 
- Public Member Functions inherited from itk::GenerateImageSource< TOutputImage >
const char * GetNameOfClass () const override
 
virtual bool GetUseReferenceImage () const
 
 itkGetInputMacro (ReferenceImage, ReferenceImageBaseType)
 
 itkSetInputMacro (ReferenceImage, ReferenceImageBaseType)
 
void SetOutputParametersFromImage (const ReferenceImageBaseType *image)
 
virtual void SetUseReferenceImage (bool _arg)
 
virtual void UseReferenceImageOn ()
 
virtual void SetSize (SizeType _arg)
 
virtual const SizeTypeGetSize () const
 
virtual void SetSize (SizeValueType data[])
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingTypeGetSpacing () const
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (PointType _arg)
 
virtual const PointTypeGetOrigin () const
 
virtual void SetOrigin (const float data[])
 
virtual void SetDirection (DirectionType _arg)
 
virtual const DirectionTypeGetDirection () const
 
virtual void SetStartIndex (IndexType _arg)
 
virtual const IndexTypeGetStartIndex () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char * GetNameOfClass () const override
 
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::GenerateImageSource< TOutputImage >
static constexpr unsigned int NDimensions = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const ImageRegionType &outputRegionForThread) override
 
 GridImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GridImageSource () override=default
 
- Protected Member Functions inherited from itk::GenerateImageSource< TOutputImage >
 GenerateImageSource ()
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GenerateImageSource () override=default
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

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

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ArrayType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::ArrayType = FixedArray<RealType, Self::ImageDimension>

Other convenient types.

Definition at line 91 of file itkGridImageSource.h.

◆ BoolArrayType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::BoolArrayType = FixedArray<bool, Self::ImageDimension>

Definition at line 92 of file itkGridImageSource.h.

◆ ConstPointer

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

Definition at line 67 of file itkGridImageSource.h.

◆ DirectionType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::DirectionType = typename TOutputImage::DirectionType

Definition at line 86 of file itkGridImageSource.h.

◆ ImageRegionType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::ImageRegionType = typename TOutputImage::RegionType

Definition at line 82 of file itkGridImageSource.h.

◆ ImageType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::ImageType = TOutputImage

Typedef for the output image types.

Definition at line 81 of file itkGridImageSource.h.

◆ KernelFunctionType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::KernelFunctionType = KernelFunctionBase<double>

Definition at line 89 of file itkGridImageSource.h.

◆ OriginType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::OriginType = typename TOutputImage::PointType

Definition at line 85 of file itkGridImageSource.h.

◆ PixelArrayContainerType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::PixelArrayContainerType = VectorContainer<PixelArrayType>

Definition at line 94 of file itkGridImageSource.h.

◆ PixelArrayType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::PixelArrayType = vnl_vector<RealType>

Definition at line 93 of file itkGridImageSource.h.

◆ PixelType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::PixelType = typename TOutputImage::PixelType

Definition at line 83 of file itkGridImageSource.h.

◆ Pointer

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkGridImageSource.h.

◆ RealType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::RealType = double

Definition at line 75 of file itkGridImageSource.h.

◆ Self

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::Self = GridImageSource

Standard class type aliases.

Definition at line 64 of file itkGridImageSource.h.

◆ SizeType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::SizeType = typename TOutputImage::SizeType

Definition at line 87 of file itkGridImageSource.h.

◆ SpacingType

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::SpacingType = typename TOutputImage::SpacingType

Definition at line 84 of file itkGridImageSource.h.

◆ Superclass

template<typename TOutputImage >
using itk::GridImageSource< TOutputImage >::Superclass = GenerateImageSource<TOutputImage>

Definition at line 65 of file itkGridImageSource.h.

Constructor & Destructor Documentation

◆ GridImageSource()

template<typename TOutputImage >
itk::GridImageSource< TOutputImage >::GridImageSource ( )
protected

◆ ~GridImageSource()

template<typename TOutputImage >
itk::GridImageSource< TOutputImage >::~GridImageSource ( )
overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TOutputImage >
void itk::GridImageSource< TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

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 >.

◆ DynamicThreadedGenerateData()

template<typename TOutputImage >
void itk::GridImageSource< TOutputImage >::DynamicThreadedGenerateData ( const ImageRegionType outputRegionForThread)
overrideprotected

◆ GetGridOffset()

template<typename TOutputImage >
virtual const ArrayType & itk::GridImageSource< TOutputImage >::GetGridOffset ( ) const
virtual

Set/Get the grid offset.

◆ GetGridSpacing()

template<typename TOutputImage >
virtual const ArrayType & itk::GridImageSource< TOutputImage >::GetGridSpacing ( ) const
virtual

Set/Get the grid spacing of the peaks.

◆ GetKernelFunction()

template<typename TOutputImage >
virtual const KernelFunctionType::Pointer & itk::GridImageSource< TOutputImage >::GetKernelFunction ( ) const
virtual

Set/Get kernel function used to create the grid.

◆ GetNameOfClass()

template<typename TOutputImage >
const char * itk::GridImageSource< TOutputImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetScale()

template<typename TOutputImage >
virtual const RealType & itk::GridImageSource< TOutputImage >::GetScale ( ) const
virtual

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

◆ GetSigma()

template<typename TOutputImage >
virtual const ArrayType & itk::GridImageSource< TOutputImage >::GetSigma ( ) const
virtual

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

◆ GetWhichDimensions()

template<typename TOutputImage >
virtual const BoolArrayType & itk::GridImageSource< TOutputImage >::GetWhichDimensions ( ) const
virtual

Set/Get the dimensions which are gridded.

◆ New()

template<typename TOutputImage >
static Pointer itk::GridImageSource< TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputImage >
void itk::GridImageSource< TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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 >.

◆ SetGridOffset()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetGridOffset ( ArrayType  _arg)
virtual

Set/Get the grid offset.

◆ SetGridSpacing()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetGridSpacing ( ArrayType  _arg)
virtual

Set/Get the grid spacing of the peaks.

◆ SetKernelFunction()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetKernelFunction ( KernelFunctionType _arg)
virtual

Set/Get kernel function used to create the grid.

◆ SetScale()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetScale ( RealType  _arg)
virtual

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

◆ SetSigma()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetSigma ( ArrayType  _arg)
virtual

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

◆ SetWhichDimensions()

template<typename TOutputImage >
virtual void itk::GridImageSource< TOutputImage >::SetWhichDimensions ( BoolArrayType  _arg)
virtual

Set/Get the dimensions which are gridded.

Member Data Documentation

◆ ImageDimension

template<typename TOutputImage >
constexpr unsigned int itk::GridImageSource< TOutputImage >::ImageDimension = TOutputImage::ImageDimension
staticconstexpr

Dimensionality of the output image

Definition at line 78 of file itkGridImageSource.h.

◆ m_GridOffset

template<typename TOutputImage >
ArrayType itk::GridImageSource< TOutputImage >::m_GridOffset {}
private

Definition at line 150 of file itkGridImageSource.h.

◆ m_GridSpacing

template<typename TOutputImage >
ArrayType itk::GridImageSource< TOutputImage >::m_GridSpacing {}
private

Definition at line 148 of file itkGridImageSource.h.

◆ m_KernelFunction

template<typename TOutputImage >
KernelFunctionType::Pointer itk::GridImageSource< TOutputImage >::m_KernelFunction {}
private

Definition at line 144 of file itkGridImageSource.h.

◆ m_PixelArrays

template<typename TOutputImage >
PixelArrayContainerType::Pointer itk::GridImageSource< TOutputImage >::m_PixelArrays {}
private

Internal variable to speed up the calculation of pixel values.

Definition at line 142 of file itkGridImageSource.h.

◆ m_Scale

template<typename TOutputImage >
RealType itk::GridImageSource< TOutputImage >::m_Scale { 255.0 }
private

Definition at line 154 of file itkGridImageSource.h.

◆ m_Sigma

template<typename TOutputImage >
ArrayType itk::GridImageSource< TOutputImage >::m_Sigma {}
private

Definition at line 146 of file itkGridImageSource.h.

◆ m_WhichDimensions

template<typename TOutputImage >
BoolArrayType itk::GridImageSource< TOutputImage >::m_WhichDimensions {}
private

Definition at line 152 of file itkGridImageSource.h.


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