elastix::FullSampler< TElastix > Class Template Reference

#include <elxFullSampler.h>

Detailed Description

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

An interpolator based on the itk::ImageFullSampler.

This image sampler samples all voxels in the InputImageRegion.

This sampler does not react to the NewSamplesEveryIteration parameter.

The parameters used in this class are:

Parameters

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

Definition at line 44 of file elxFullSampler.h.

Inheritance diagram for elastix::FullSampler< TElastix >:

Public Types
using	ConstPointer = itk::SmartPointer<const Self>
using	ITKBaseType = typename Superclass2::ITKBaseType
using	Pointer = itk::SmartPointer<Self>
using	Self = FullSampler
using	Superclass1 = itk::ImageFullSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>
using	Superclass2 = elx::ImageSamplerBase<TElastix>
Public Types inherited from itk::ImageFullSampler< 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	Self = ImageFullSampler
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
	elxClassNameMacro ("Full")
	ITK_DISALLOW_COPY_AND_MOVE (FullSampler)
	itkOverrideGetNameOfClassMacro (FullSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass1::InputImageDimension)
Public Member Functions inherited from itk::ImageFullSampler< TInputImage >
	ITK_DISALLOW_COPY_AND_MOVE (ImageFullSampler)
	itkOverrideGetNameOfClassMacro (ImageFullSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
bool	SelectingNewSamplesOnUpdateSupported () const override
bool	SelectNewSamplesOnUpdate () override
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	SetNumberOfSamples (unsigned long _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::ImageFullSampler< 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
	FullSampler ()=default
	~FullSampler () override=default
Protected Member Functions inherited from itk::ImageFullSampler< TInputImage >
void	GenerateData () override
	ImageFullSampler ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageFullSampler () 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::FullSampler< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 56 of file elxFullSampler.h.

ITKBaseType

template<typename TElastix>

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

Definition at line 91 of file elxFullSampler.h.

Pointer

template<typename TElastix>

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

Definition at line 55 of file elxFullSampler.h.

Self

template<typename TElastix>

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

Standard ITK-stuff.

Definition at line 52 of file elxFullSampler.h.

Superclass1

template<typename TElastix>

using elastix::FullSampler< TElastix >::Superclass1 = itk::ImageFullSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>

Definition at line 53 of file elxFullSampler.h.

Superclass2

template<typename TElastix>

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

Definition at line 54 of file elxFullSampler.h.

Constructor & Destructor Documentation

FullSampler()

template<typename TElastix>

elastix::FullSampler< TElastix >::FullSampler ( )

protecteddefault

The constructor.

~FullSampler()

template<typename TElastix>

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

overrideprotecteddefault

The destructor.

Member Function Documentation

elxClassNameMacro()

template<typename TElastix>

elastix::FullSampler< TElastix >::elxClassNameMacro

(

"Full"

)

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

ITK_DISALLOW_COPY_AND_MOVE()

template<typename TElastix>

elastix::FullSampler< TElastix >::ITK_DISALLOW_COPY_AND_MOVE

(

FullSampler< TElastix >

)

itkOverrideGetNameOfClassMacro()

template<typename TElastix>

elastix::FullSampler< TElastix >::itkOverrideGetNameOfClassMacro

(

FullSampler< TElastix >

)

Run-time type information (and related methods).

itkStaticConstMacro()

template<typename TElastix>

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

The input image dimension.

New()

template<typename TElastix>

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

static

Method for creation through the object factory.

Member Data Documentation

elxOverrideGetSelfMacro

template<typename TElastix>

elastix::FullSampler< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 100 of file elxFullSampler.h.