elastix::RandomSampler< TElastix > Class Template Reference

#include <elxRandomSampler.h>

Detailed Description

template<class TElastix>
class elastix::RandomSampler< TElastix >

An interpolator based on the itk::ImageRandomSampler.

This image sampler randomly samples 'NumberOfSamples' voxels in the InputImageRegion. Voxels may be selected multiple times. If a mask is given, the sampler tries to find samples within the mask. If the mask is very sparse, this may take some time. In this case, consider using the RandomSparseMask image sampler.

This sampler is suitable to used in combination with the NewSamplesEveryIteration parameter (defined in the elx::OptimizerBase).

The parameters used in this class are:

Parameters:

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

NumberOfSpatialSamples: The number of image voxels used for computing the metric value and its derivative in each iteration. Must be given for each resolution.
example: (NumberOfSpatialSamples 2048 2048 4000)
The default is 5000.

Definition at line 52 of file elxRandomSampler.h.

Inheritance diagram for elastix::RandomSampler< TElastix >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >
using	InputImageIndexType = typename InputImageType::IndexType
using	InputImagePointType = typename InputImageType::PointType
using	ITKBaseType = typename Superclass2::ITKBaseType
using	Pointer = itk::SmartPointer< Self >
using	Self = RandomSampler
using	Superclass1 = itk::ImageRandomSampler< typename elx::ImageSamplerBase< TElastix >::InputImageType >
using	Superclass2 = elx::ImageSamplerBase< TElastix >
Public Types inherited from itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
using	ConstPointer = SmartPointer< const Self >
using	InputImageIndexType = typename InputImageType::IndexType
using	InputImagePointType = typename InputImageType::PointType
using	Pointer = SmartPointer< Self >
using	Self = ImageRandomSampler
using	Superclass = ImageRandomSamplerBase< elx::ImageSamplerBase< TElastix >::InputImageType >
Public Types inherited from itk::ImageRandomSamplerBase< TInputImage >
using	ConstPointer = SmartPointer< const Self >
using	ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer
using	ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >
using	ImageSampleType = ImageSample< InputImageType >
using	MaskType = SpatialObject< Self::InputImageDimension >
using	Pointer = SmartPointer< Self >
using	Self = ImageRandomSamplerBase
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 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	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< TElastix, VectorDataContainer< std::vcl_size_t, ImageSample< TElastix > > >
Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
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 = TOutputVectorContainer
using	Pointer = SmartPointer< Self >
using	Self = ImageToVectorContainerFilter
using	Superclass = VectorContainerSource< TOutputVectorContainer >

Public Member Functions
void	BeforeEachResolution () override
	elxClassNameMacro ("Random")
virtual const char *	GetClassName () const
	ITK_DISALLOW_COPY_AND_MOVE (RandomSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass1::InputImageDimension)
Public Member Functions inherited from itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
virtual const char *	GetClassName () const
	ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
Public Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
virtual const char *	GetClassName () const
	ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSamplerBase)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
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)
Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
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, TOutputVectorContainer >
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)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
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 ()
Static Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
static Pointer	New ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Protected Member Functions
	RandomSampler ()=default
	~RandomSampler () override=default
Protected Member Functions inherited from itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
void	GenerateData () override
	ImageRandomSampler ()=default
void	ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId) override
	~ImageRandomSampler () override=default
Protected Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
void	BeforeThreadedGenerateData () override
	ImageRandomSamplerBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageRandomSamplerBase () 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 Member Functions inherited from itk::ImageSamplerBase< TElastix >
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, TOutputVectorContainer >
	ImageToVectorContainerFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageToVectorContainerFilter () override=default

Private Attributes
	elxOverrideGetSelfMacro

Additional Inherited Members
Protected Attributes inherited from itk::ImageRandomSamplerBase< TInputImage >
std::vector< double >	m_RandomNumberList
Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long	m_NumberOfSamples { 0 }
std::vector< ImageSampleContainerPointer >	m_ThreaderSampleContainer
bool	m_UseMultiThread { false }
Protected Attributes inherited from itk::ImageSamplerBase< TElastix >
unsigned long	m_NumberOfSamples
std::vector< ImageSampleContainerPointer >	m_ThreaderSampleContainer
bool	m_UseMultiThread

Member Typedef Documentation

ConstPointer

template<class TElastix >

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

Definition at line 64 of file elxRandomSampler.h.

InputImageIndexType

template<class TElastix >

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

Other typedefs.

Definition at line 76 of file itkImageRandomSampler.h.

InputImagePointType

template<class TElastix >

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

Definition at line 77 of file itkImageRandomSampler.h.

ITKBaseType

template<class TElastix >

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

Definition at line 99 of file elxRandomSampler.h.

Pointer

template<class TElastix >

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

Definition at line 63 of file elxRandomSampler.h.

Self

template<class TElastix >

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

Standard ITK-stuff.

Definition at line 60 of file elxRandomSampler.h.

Superclass1

template<class TElastix >

using elastix::RandomSampler< TElastix >::Superclass1 = itk::ImageRandomSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>

Definition at line 61 of file elxRandomSampler.h.

Superclass2

template<class TElastix >

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

Definition at line 62 of file elxRandomSampler.h.

Constructor & Destructor Documentation

RandomSampler()

template<class TElastix >

elastix::RandomSampler< TElastix >::RandomSampler ( )

protecteddefault

The constructor.

~RandomSampler()

template<class TElastix >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

BeforeEachResolution()

template<class TElastix >

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

override

Execute stuff before each resolution:

• Set the number of samples.

elxClassNameMacro()

template<class TElastix >

elastix::RandomSampler< TElastix >::elxClassNameMacro

(

"Random"

)

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

GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

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

ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >

elastix::RandomSampler< TElastix >::ITK_DISALLOW_COPY_AND_MOVE

(

RandomSampler< TElastix >

)

itkStaticConstMacro()

template<class TElastix >

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

The input image dimension.

New()

template<class TElastix >

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

static

Method for creation through the object factory.

Field Documentation

elxOverrideGetSelfMacro

template<class TElastix >

elastix::RandomSampler< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 114 of file elxRandomSampler.h.