#include <elxGridSampler.h>

Detailed Description

template<typename TElastix>
class elastix::GridSampler< TElastix >

An interpolator based on the itk::ImageGridSampler.

This image sampler samples voxels on a uniform grid. This sampler is in most cases not recommended.

This sampler does not react on the NewSamplesEveryIteration parameter.

The parameters used in this class are:

ImageSampler: Select this image sampler as follows:
(ImageSampler "Grid")

SampleGridSpacing: Defines the sampling grid in case of a Grid ImageSampler.
An integer downsampling factor must be specified for each dimension, for each resolution.
example: (SampleGridSpacing 4 4 2 2)
Default is 2 for each dimension for each resolution.

Definition at line 49 of file elxGridSampler.h.

Inheritance diagram for elastix::GridSampler< TElastix >:

[legend]

Public Types
using	ConstPointer = itk::SmartPointer<const Self>
using	GridSpacingType = typename Superclass1::SampleGridSpacingType
using	ITKBaseType = typename Superclass2::ITKBaseType
using	Pointer = itk::SmartPointer<Self>
using	Self = GridSampler
using	Superclass1 = itk::ImageGridSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>
using	Superclass2 = elx::ImageSamplerBase<TElastix>
Public Types inherited from itk::ImageGridSampler< TInputImage >
using	ConstPointer = SmartPointer<const Self>
using	ImageSampleContainerPointer
using	ImageSampleContainerType
using	ImageSampleType
using	InputImageConstPointer
using	InputImageIndexType
using	InputImagePixelType
using	InputImagePointer
using	InputImagePointType
using	InputImageRegionType
using	InputImageSizeType = typename InputImageType::SizeType
using	InputImageType
using	MaskType = typename Superclass::MaskType
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<ImageSampleType>
using	ImageSampleType = ImageSample<InputImageType>
using	ImageSampleValueType = typename ImageSampleType::RealType
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImageIndexType = typename InputImageType::IndexType
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImagePointer = typename InputImageType::Pointer
using	InputImagePointType = typename InputImageType::PointType
using	InputImagePointValueType = typename InputImagePointType::ValueType
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageRegionVectorType = std::vector<InputImageRegionType>
using	InputImageSizeType = typename InputImageType::SizeType
using	InputImageType = TInputImage
using	MaskConstPointer = typename MaskType::ConstPointer
using	MaskPointer = typename MaskType::Pointer
using	MaskType = ImageMaskSpatialObject<Self::InputImageDimension>
using	MaskVectorType = std::vector<MaskConstPointer>
using	OutputVectorContainerPointer
using	OutputVectorContainerType
using	Pointer = SmartPointer<Self>
using	Self = ImageSamplerBase
using	Superclass = VectorContainerSource<VectorDataContainer<ImageSample<TInputImage>>>
Public Types inherited from itk::VectorContainerSource< VectorDataContainer< ImageSample< TInputImage > > >
using	ConstPointer
using	OutputVectorContainerPointer
using	OutputVectorContainerType
using	Pointer
using	Self
using	Superclass
Public Types inherited from itk::ImageSamplerBase< TElastix >
using	ConstPointer
using	ImageSampleContainerPointer
using	ImageSampleContainerType
using	ImageSampleType
using	ImageSampleValueType
using	InputImageConstPointer
using	InputImageIndexType
using	InputImagePixelType
using	InputImagePointer
using	InputImagePointType
using	InputImagePointValueType
using	InputImageRegionType
using	InputImageRegionVectorType
using	InputImageSizeType
using	InputImageType
using	MaskConstPointer
using	MaskPointer
using	MaskType
using	MaskVectorType
typedef typename OutputVectorContainerType::Pointer	OutputVectorContainerPointer
typedef VectorDataContainer< ImageSample< TElastix > >	OutputVectorContainerType
using	Pointer
using	Self
using	Superclass
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
void	BeforeEachResolution () override
	elxClassNameMacro ("Grid")
	ITK_DISALLOW_COPY_AND_MOVE (GridSampler)
	itkOverrideGetNameOfClassMacro (GridSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass1::InputImageDimension)
Public Member Functions inherited from itk::ImageGridSampler< TInputImage >
virtual const SampleGridSpacingType &	GetSampleGridSpacing ()
	ITK_DISALLOW_COPY_AND_MOVE (ImageGridSampler)
	itkOverrideGetNameOfClassMacro (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 InputImageRegionType &	GetCroppedInputImageRegion ()
const InputImageType *	GetInput ()
const InputImageType *	GetInput (unsigned int idx)
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
OutputVectorContainerType *	GetOutput ()
	ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase)
	itkOverrideGetNameOfClassMacro (ImageSamplerBase)
	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
DataObject::Pointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
void	SetInput (const InputImageType *input)
void	SetInput (unsigned int idx, const InputImageType *input)
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	SetUseMultiThread (bool _arg)
Public Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< ImageSample< TInputImage > > >
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)
	itkOverrideGetNameOfClassMacro (VectorContainerSource)
DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
virtual const InputImageRegionType &	GetCroppedInputImageRegion ()
const InputImageType *	GetInput ()
const InputImageType *	GetInput (unsigned int idx)
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
OutputVectorContainerType *	GetOutput ()
	ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase)
	itkOverrideGetNameOfClassMacro (ImageSamplerBase)
	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
DataObject::Pointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual bool	SelectingNewSamplesOnUpdateSupported () const
virtual bool	SelectNewSamplesOnUpdate ()
void	SetInput (const InputImageType *input)
void	SetInput (unsigned int idx, const InputImageType *input)
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::VectorContainerSource< TOutputVectorContainer >
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)
	itkOverrideGetNameOfClassMacro (VectorContainerSource)
DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageGridSampler< TInputImage >
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
static Pointer	New ()
Static Public Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< ImageSample< TInputImage > > >
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
static Pointer	New ()
Static Public Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
static Pointer	New ()

Protected Member Functions
	GridSampler ()=default
	~GridSampler () override=default
Protected Member Functions inherited from itk::ImageGridSampler< TInputImage >
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 >
virtual bool	CheckInputImageRegions ()
void	CropInputImageRegion ()
void	GenerateInputRequestedRegion () override
	ImageSamplerBase ()
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::VectorContainerSource< VectorDataContainer< ImageSample< TInputImage > > >
void	PrintSelf (std::ostream &os, Indent indent) const override
	VectorContainerSource ()
	~VectorContainerSource () override=default
Protected Member Functions inherited from itk::ImageSamplerBase< TElastix >
virtual bool	CheckInputImageRegions ()
void	CropInputImageRegion ()
void	GenerateInputRequestedRegion () override
	ImageSamplerBase ()
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::VectorContainerSource< TOutputVectorContainer >
void	PrintSelf (std::ostream &os, Indent indent) const override
	VectorContainerSource ()
	~VectorContainerSource () override=default

Private Attributes
	elxOverrideGetSelfMacro

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
static std::vector< InputImageRegionType >	SplitRegion (const InputImageRegionType &inputRegion, const vcl_size_t requestedNumberOfSubregions)
Static Protected Member Functions inherited from itk::ImageSamplerBase< TElastix >
static std::vector< InputImageRegionType >	SplitRegion (const InputImageRegionType &inputRegion, const vcl_size_t requestedNumberOfSubregions)
Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long	m_NumberOfSamples { 0 }
bool	m_UseMultiThread { true }
Protected Attributes inherited from itk::ImageSamplerBase< TElastix >
unsigned long	m_NumberOfSamples
bool	m_UseMultiThread

Member Typedef Documentation

◆ ConstPointer

template<typename TElastix>

using elastix::GridSampler< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 61 of file elxGridSampler.h.

◆ GridSpacingType

template<typename TElastix>

using elastix::GridSampler< TElastix >::GridSpacingType = typename Superclass1::SampleGridSpacingType

Definition at line 89 of file elxGridSampler.h.

◆ ITKBaseType

template<typename TElastix>

using elastix::GridSampler< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType

Definition at line 98 of file elxGridSampler.h.

◆ Pointer

template<typename TElastix>

using elastix::GridSampler< TElastix >::Pointer = itk::SmartPointer<Self>

Definition at line 60 of file elxGridSampler.h.

◆ Self

template<typename TElastix>

using elastix::GridSampler< TElastix >::Self = GridSampler

Standard ITK-stuff.

Definition at line 57 of file elxGridSampler.h.

◆ Superclass1

template<typename TElastix>

using elastix::GridSampler< TElastix >::Superclass1 = itk::ImageGridSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>

Definition at line 58 of file elxGridSampler.h.

◆ Superclass2

template<typename TElastix>

using elastix::GridSampler< TElastix >::Superclass2 = elx::ImageSamplerBase<TElastix>

Definition at line 59 of file elxGridSampler.h.

Constructor & Destructor Documentation

◆ GridSampler()

template<typename TElastix>

elastix::GridSampler< TElastix >::GridSampler ( )

protecteddefault

The constructor.

◆ ~GridSampler()

template<typename TElastix>

elastix::GridSampler< TElastix >::~GridSampler ( )

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ BeforeEachResolution()

template<typename TElastix>

void elastix::GridSampler< TElastix >::BeforeEachResolution ( )

override

Execute stuff before each resolution:

Set the sampling grid size.

◆ elxClassNameMacro()

template<typename TElastix>

elastix::GridSampler< TElastix >::elxClassNameMacro ( "Grid" )

Name of this class. Use this name in the parameter file to select this specific interpolator.
example: (ImageSampler "Grid")

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TElastix>

elastix::GridSampler< TElastix >::ITK_DISALLOW_COPY_AND_MOVE ( GridSampler< TElastix > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TElastix>

elastix::GridSampler< TElastix >::itkOverrideGetNameOfClassMacro ( GridSampler< TElastix > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TElastix>

elastix::GridSampler< TElastix >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned int	,
		Superclass1::InputImageDimension	)

The input image dimension.

◆ New()

template<typename TElastix>

Pointer elastix::GridSampler< TElastix >::New ( )

static

Method for creation through the object factory.

Member Data Documentation

◆ elxOverrideGetSelfMacro

template<typename TElastix>

elastix::GridSampler< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 113 of file elxGridSampler.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ GridSpacingType

◆ ITKBaseType

◆ Pointer

◆ Self

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ GridSampler()

◆ ~GridSampler()

Member Function Documentation

◆ BeforeEachResolution()

◆ elxClassNameMacro()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkOverrideGetNameOfClassMacro()

◆ itkStaticConstMacro()

◆ New()

Member Data Documentation

◆ elxOverrideGetSelfMacro