#include <itkImageGridSampler.h>

Detailed Description

template<class TInputImage>
class itk::ImageGridSampler< TInputImage >

Samples image voxels on a regular grid.

This ImageSampler samples voxels that lie on a regular grid. The grid can be specified by an integer downsampling factor for each dimension.

Parameters:: SampleGridSpacing: This parameter controls the spacing of the uniform grid in all dimensions. This should be given in index coordinates.
example: (SampleGridSpacing 4 4 4)
Default is 2 in each dimension.

Definition at line 44 of file itkImageGridSampler.h.

Inheritance diagram for itk::ImageGridSampler< TInputImage >:

[legend]

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer

using	ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >

using	ImageSampleType = ImageSample< InputImageType >

using	InputImageIndexType = typename InputImageType::IndexType

using	InputImagePointType = typename InputImageType::PointType

using	InputImageSizeType = typename InputImageType::SizeType

using	MaskType = SpatialObject< Self::InputImageDimension >

using	Pointer = SmartPointer< Self >

using	SampleGridIndexType = InputImageIndexType

using	SampleGridSizeType = typename InputImageType::SizeType

using	SampleGridSpacingType = typename InputImageType::OffsetType

using	SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType

using	Self = ImageGridSampler

using	Superclass = ImageSamplerBase< TInputImage >

Public Types inherited from itk::ImageSamplerBase< TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer

using	ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >

using	ImageSampleType = ImageSample< InputImageType >

using	ImageSampleValueType = typename ImageSampleType::RealType

using	InputImageIndexType = typename InputImageType::IndexType

using	InputImagePointType = typename InputImageType::PointType

using	InputImagePointValueType = typename InputImagePointType::ValueType

using	InputImageRegionVectorType = std::vector< InputImageRegionType >

using	InputImageSizeType = typename InputImageType::SizeType

using	MaskConstPointer = typename MaskType::ConstPointer

using	MaskPointer = typename MaskType::Pointer

using	MaskType = SpatialObject< Self::InputImageDimension >

using	MaskVectorType = std::vector< MaskConstPointer >

using	Pointer = SmartPointer< Self >

using	Self = ImageSamplerBase

using	Superclass = ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >

Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer

using	OutputVectorContainerType = VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > >

using	Pointer = SmartPointer< Self >

using	Self = ImageToVectorContainerFilter

using	Superclass = VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >

Public Types inherited from itk::VectorContainerSource< TOutputVectorContainer >
using	ConstPointer = SmartPointer< const Self >

using	OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer

using	OutputVectorContainerType = TOutputVectorContainer

using	Pointer = SmartPointer< Self >

using	Self = VectorContainerSource

using	Superclass = ProcessObject

Public Member Functions
virtual const char *	GetClassName () const

virtual const SampleGridSpacingType &	GetSampleGridSpacing ()

	ITK_DISALLOW_COPY_AND_MOVE (ImageGridSampler)

	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)

bool	SelectingNewSamplesOnUpdateSupported () const override

bool	SelectNewSamplesOnUpdate () override

void	SetNumberOfSamples (unsigned long nrofsamples) override

void	SetSampleGridSpacing (const SampleGridSpacingType &arg)

Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
virtual const char *	GetClassName () const

virtual const InputImageRegionType &	GetCroppedInputImageRegion ()

virtual const InputImageRegionType &	GetInputImageRegion () const

virtual const InputImageRegionType &	GetInputImageRegion (unsigned int pos) const

virtual const MaskType *	GetMask () const

virtual const MaskType *	GetMask (unsigned int pos) const

virtual unsigned int	GetNumberOfInputImageRegions () const

virtual unsigned int	GetNumberOfMasks () const

virtual unsigned long	GetNumberOfSamples () const

	ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase)

	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)

virtual bool	SelectingNewSamplesOnUpdateSupported () const

virtual bool	SelectNewSamplesOnUpdate ()

virtual void	SetInputImageRegion (const InputImageRegionType _arg)

virtual void	SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos)

virtual void	SetMask (const MaskType *_arg)

virtual void	SetMask (const MaskType *_arg, unsigned int pos)

virtual void	SetNumberOfInputImageRegions (const unsigned int _arg)

virtual void	SetNumberOfMasks (const unsigned int _arg)

virtual void	SetNumberOfSamples (unsigned long _arg)

virtual void	SetUseMultiThread (bool _arg)

Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	GenerateData () override

virtual const char *	GetClassName () const

const InputImageType *	GetInput ()

const InputImageType *	GetInput (unsigned int idx)

OutputVectorContainerType *	GetOutput ()

	ITK_DISALLOW_COPY_AND_MOVE (ImageToVectorContainerFilter)

DataObject::Pointer	MakeOutput (unsigned int idx) override

void	SetInput (const InputImageType *input)

void	SetInput (unsigned int idx, const InputImageType *input)

virtual unsigned int	SplitRequestedRegion (const ThreadIdType &threadId, const ThreadIdType &numberOfSplits, InputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)

Public Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
virtual const char *	GetClassName () const

OutputVectorContainerType *	GetOutput ()

OutputVectorContainerType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

	ITK_DISALLOW_COPY_AND_MOVE (VectorContainerSource)

virtual DataObjectPointer	MakeOutput (unsigned int idx)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
static Pointer	New ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Public Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
static Pointer	New ()

Protected Member Functions
void	GenerateData () override

	ImageGridSampler ()=default

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageGridSampler () override=default

Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

virtual bool	CheckInputImageRegions ()

void	CropInputImageRegion ()

void	GenerateInputRequestedRegion () override

	ImageSamplerBase ()=default

virtual bool	IsInsideAllMasks (const InputImagePointType &point) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	UpdateAllMasks ()

	~ImageSamplerBase () override=default

Protected Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
	ImageToVectorContainerFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageToVectorContainerFilter () override=default

Protected Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
void	PrintSelf (std::ostream &os, Indent indent) const override

	VectorContainerSource ()

	~VectorContainerSource () override=default

Protected Attributes
unsigned long	m_RequestedNumberOfSamples { 0 }

SampleGridSpacingType	m_SampleGridSpacing { itk::MakeFilled<SampleGridSpacingType>(1) }

Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long	m_NumberOfSamples { 0 }

std::vector< ImageSampleContainerPointer >	m_ThreaderSampleContainer

bool	m_UseMultiThread { false }

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkImageGridSampler.h.

◆ ImageSampleContainerPointer

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer

Definition at line 77 of file itkImageSamplerBase.h.

◆ ImageSampleContainerType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerType = VectorDataContainer<std::vcl_size_t, ImageSampleType>

Definition at line 76 of file itkImageSamplerBase.h.

◆ ImageSampleType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::ImageSampleType = ImageSample<InputImageType>

Other typdefs.

Definition at line 75 of file itkImageSamplerBase.h.

◆ InputImageIndexType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::InputImageIndexType = typename InputImageType::IndexType

Definition at line 79 of file itkImageSamplerBase.h.

◆ InputImagePointType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::InputImagePointType = typename InputImageType::PointType

Definition at line 80 of file itkImageSamplerBase.h.

◆ InputImageSizeType

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::InputImageSizeType = typename InputImageType::SizeType

Definition at line 88 of file itkImageGridSampler.h.

◆ MaskType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::MaskType = SpatialObject<Self::InputImageDimension>

Definition at line 83 of file itkImageSamplerBase.h.

◆ Pointer

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkImageGridSampler.h.

◆ SampleGridIndexType

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::SampleGridIndexType = InputImageIndexType

Definition at line 87 of file itkImageGridSampler.h.

◆ SampleGridSizeType

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::SampleGridSizeType = typename InputImageType::SizeType

Definition at line 86 of file itkImageGridSampler.h.

◆ SampleGridSpacingType

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::SampleGridSpacingType = typename InputImageType::OffsetType

Typedefs for support of user defined grid spacing for the spatial samples.

Definition at line 84 of file itkImageGridSampler.h.

◆ SampleGridSpacingValueType

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType

Definition at line 85 of file itkImageGridSampler.h.

◆ Self

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::Self = ImageGridSampler

Standard ITK-stuff.

Definition at line 50 of file itkImageGridSampler.h.

◆ Superclass

template<class TInputImage >

using itk::ImageGridSampler< TInputImage >::Superclass = ImageSamplerBase<TInputImage>

Definition at line 51 of file itkImageGridSampler.h.

Constructor & Destructor Documentation

◆ ImageGridSampler()

template<class TInputImage >

itk::ImageGridSampler< TInputImage >::ImageGridSampler ( )

protecteddefault

The constructor.

◆ ~ImageGridSampler()

template<class TInputImage >

itk::ImageGridSampler< TInputImage >::~ImageGridSampler ( )

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ GenerateData()

template<class TInputImage >

void itk::ImageGridSampler< TInputImage >::GenerateData ( )

overrideprotected

Function that does the work.

◆ GetClassName()

template<class TInputImage >

virtual const char * itk::ImageGridSampler< TInputImage >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

◆ GetSampleGridSpacing()

template<class TInputImage >

virtual const SampleGridSpacingType & itk::ImageGridSampler< TInputImage >::GetSampleGridSpacing ( )

virtual

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TInputImage >

itk::ImageGridSampler< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE ( ImageGridSampler< TInputImage > )

◆ itkStaticConstMacro()

template<class TInputImage >

itk::ImageGridSampler< TInputImage >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned int	,
		Superclass::InputImageDimension
	)

The input image dimension.

◆ New()

template<class TInputImage >

static Pointer itk::ImageGridSampler< TInputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<class TInputImage >

void itk::ImageGridSampler< TInputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotected

PrintSelf.

◆ SelectingNewSamplesOnUpdateSupported()

template<class TInputImage >

bool itk::ImageGridSampler< TInputImage >::SelectingNewSamplesOnUpdateSupported ( ) const

inlineoverridevirtual

Returns whether the sampler supports SelectNewSamplesOnUpdate()

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 131 of file itkImageGridSampler.h.

◆ SelectNewSamplesOnUpdate()

template<class TInputImage >

bool itk::ImageGridSampler< TInputImage >::SelectNewSamplesOnUpdate ( )

inlineoverridevirtual

Selecting new samples makes no sense if nothing changed. The same samples would be selected anyway.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 123 of file itkImageGridSampler.h.

◆ SetNumberOfSamples()

template<class TInputImage >

void itk::ImageGridSampler< TInputImage >::SetNumberOfSamples ( unsigned long nrofsamples )

overridevirtual

Define an isotropic SampleGridSpacing such that the desired number of samples is approximately realized. The following formula is used:

spacing = max[ 1, round( (availablevoxels / nrofsamples)^(1/dimension) ) ], with availablevoxels = nr of voxels in bounding box of the mask.

The InputImageRegion needs to be specified beforehand. However, the sample grid spacing is recomputed in the update phase, when the bounding box of the mask is known. Supplying nrofsamples=0 turns off the (re)computation of the SampleGridSpacing. Once nrofsamples=0 has been given, the last computed SampleGridSpacing is simply considered as a user parameter, which is not modified automatically anymore.

This function overrules any previous calls to SetSampleGridSpacing.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

◆ SetSampleGridSpacing()

template<class TInputImage >

void itk::ImageGridSampler< TInputImage >::SetSampleGridSpacing ( const SampleGridSpacingType & arg )

Set/Get the sample grid spacing for each dimension (only integer factors) This function overrules previous calls to SetNumberOfSamples. Moreover, it calls SetNumberOfSamples(0) (see below), to make sure that the user-set sample grid spacing is never overruled.

Field Documentation

◆ m_RequestedNumberOfSamples

template<class TInputImage >

unsigned long itk::ImageGridSampler< TInputImage >::m_RequestedNumberOfSamples { 0 }

protected

The number of samples entered in the SetNumberOfSamples method

Definition at line 156 of file itkImageGridSampler.h.

◆ m_SampleGridSpacing

template<class TInputImage >

SampleGridSpacingType itk::ImageGridSampler< TInputImage >::m_SampleGridSpacing { itk::MakeFilled<SampleGridSpacingType>(1) }

protected

An array of integer spacing factors

Definition at line 153 of file itkImageGridSampler.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ ImageSampleContainerPointer

◆ ImageSampleContainerType

◆ ImageSampleType

◆ InputImageIndexType

◆ InputImagePointType

◆ InputImageSizeType

◆ MaskType

◆ Pointer

◆ SampleGridIndexType

◆ SampleGridSizeType

◆ SampleGridSpacingType

◆ SampleGridSpacingValueType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageGridSampler()

◆ ~ImageGridSampler()

Member Function Documentation

◆ GenerateData()

◆ GetClassName()

◆ GetSampleGridSpacing()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkStaticConstMacro()

◆ New()

◆ PrintSelf()

◆ SelectingNewSamplesOnUpdateSupported()

◆ SelectNewSamplesOnUpdate()

◆ SetNumberOfSamples()

◆ SetSampleGridSpacing()

Field Documentation

◆ m_RequestedNumberOfSamples

◆ m_SampleGridSpacing