#include <elxGridSampler.h>

Detailed Description

template<class 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 >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >

using	GridSpacingType = typename Superclass1::SampleGridSpacingType

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

using	ImageSampleType = ImageSample< InputImageType >

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	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	ITKBaseType = typename Superclass2::ITKBaseType

using	MaskType = typename Superclass::MaskType

using	Pointer = itk::SmartPointer< Self >

using	SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType

using	Self = GridSampler

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

using	Superclass2 = elx::ImageSamplerBase< TElastix >

Public Types inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
using	ConstPointer = SmartPointer< const Self >

using	ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer

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

using	ImageSampleType = ImageSample< InputImageType >

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	InputImageRegionType = typename InputImageType::RegionType

using	InputImageSizeType = typename InputImageType::SizeType

using	InputImageType = elx::ImageSamplerBase< TElastix >::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< elx::ImageSamplerBase< TElastix >::InputImageType >

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	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	Pointer = SmartPointer< Self >

using	Self = ImageSamplerBase

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

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

using	OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer

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

using	Pointer = SmartPointer< Self >

using	Self = VectorContainerSource

using	Superclass = ProcessObject

Public Types inherited from itk::ImageSamplerBase< TElastix >
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	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 = TElastix

using	MaskConstPointer = typename MaskType::ConstPointer

using	MaskPointer = typename MaskType::Pointer

using	MaskType = ImageMaskSpatialObject< Self::InputImageDimension >

using	MaskVectorType = std::vector< MaskConstPointer >

using	Pointer = SmartPointer< Self >

using	Self = ImageSamplerBase

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

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")

virtual const char *	GetClassName () const

	ITK_DISALLOW_COPY_AND_MOVE (GridSampler)

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

Public Member Functions inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
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 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)

	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< std::vcl_size_t, 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)

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)

	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)

DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
static Pointer	New ()

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

Static Public Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, 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< elx::ImageSamplerBase< TElastix >::InputImageType >
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< std::vcl_size_t, 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<class TElastix >

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

Definition at line 61 of file elxGridSampler.h.

◆ GridSpacingType

template<class TElastix >

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

Definition at line 89 of file elxGridSampler.h.

◆ ImageSampleContainerType

template<class TElastix >

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

Definition at line 72 of file itkImageSamplerBase.h.

◆ ImageSampleType

template<class TElastix >

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

Other typdefs.

Definition at line 71 of file itkImageSamplerBase.h.

◆ InputImageConstPointer

template<class TElastix >

using itk::ImageSamplerBase< TInputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 68 of file itkImageSamplerBase.h.

◆ InputImageIndexType

template<class TElastix >

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

Definition at line 83 of file itkImageSamplerBase.h.

◆ InputImagePixelType

template<class TElastix >

using itk::ImageSamplerBase< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 70 of file itkImageSamplerBase.h.

◆ InputImagePointer

template<class TElastix >

using itk::ImageSamplerBase< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 67 of file itkImageSamplerBase.h.

◆ InputImagePointType

template<class TElastix >

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

Definition at line 85 of file itkImageSamplerBase.h.

◆ InputImageRegionType

template<class TElastix >

using itk::ImageSamplerBase< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 69 of file itkImageSamplerBase.h.

◆ InputImageType

template<class TElastix >

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

Some Image related typedefs.

Definition at line 66 of file itkImageSamplerBase.h.

◆ ITKBaseType

template<class TElastix >

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

Definition at line 98 of file elxGridSampler.h.

◆ MaskType

template<class TElastix >

using itk::ImageGridSampler< TInputImage >::MaskType = typename Superclass::MaskType

Definition at line 77 of file itkImageGridSampler.h.

◆ Pointer

template<class TElastix >

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

Definition at line 60 of file elxGridSampler.h.

◆ SampleGridSpacingValueType

template<class TElastix >

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

Definition at line 89 of file itkImageGridSampler.h.

◆ Self

template<class TElastix >

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

Standard ITK-stuff.

Definition at line 57 of file elxGridSampler.h.

◆ Superclass1

template<class TElastix >

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

Definition at line 58 of file elxGridSampler.h.

◆ Superclass2

template<class TElastix >

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

Definition at line 59 of file elxGridSampler.h.

Constructor & Destructor Documentation

◆ GridSampler()

template<class TElastix >

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

protecteddefault

The constructor.

◆ ~GridSampler()

template<class TElastix >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ BeforeEachResolution()

template<class TElastix >

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

override

Execute stuff before each resolution:

Set the sampling grid size.

◆ elxClassNameMacro()

template<class 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")

◆ GetClassName()

template<class TElastix >

virtual const char * elastix::GridSampler< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >

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

◆ itkStaticConstMacro()

template<class TElastix >

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

The input image dimension.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

Field Documentation

◆ elxOverrideGetSelfMacro

template<class 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

◆ ImageSampleContainerType

◆ ImageSampleType

◆ InputImageConstPointer

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImagePointType

◆ InputImageRegionType

◆ InputImageType

◆ ITKBaseType

◆ MaskType

◆ Pointer

◆ SampleGridSpacingValueType

◆ Self

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ GridSampler()

◆ ~GridSampler()

Member Function Documentation

◆ BeforeEachResolution()

◆ elxClassNameMacro()

◆ GetClassName()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkStaticConstMacro()

◆ New()

Field Documentation

◆ elxOverrideGetSelfMacro