itk::ImageRandomSampler< TInputImage > Class Template Reference

#include <itkImageRandomSampler.h>

Detailed Description

template<class TInputImage>
class itk::ImageRandomSampler< TInputImage >

Samples randomly some voxels of an image.

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 ImageRandomSamplerSparseMask.

Definition at line 39 of file itkImageRandomSampler.h.

Inheritance diagram for itk::ImageRandomSampler< TInputImage >:

Public Types
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< TInputImage >
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 Member Functions
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 >
	ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSamplerBase)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
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 > > >
void	GenerateData () override
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)
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)

Static Public Member Functions
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 ()

Protected Member Functions
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

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 }

Member Typedef Documentation

ConstPointer

template<class TInputImage >

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

Definition at line 48 of file itkImageRandomSampler.h.

InputImageIndexType

template<class TInputImage >

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

Other typedefs.

Definition at line 76 of file itkImageRandomSampler.h.

InputImagePointType

template<class TInputImage >

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

Definition at line 77 of file itkImageRandomSampler.h.

Pointer

template<class TInputImage >

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

Definition at line 47 of file itkImageRandomSampler.h.

Self

template<class TInputImage >

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

Standard ITK-stuff.

Definition at line 45 of file itkImageRandomSampler.h.

Superclass

template<class TInputImage >

using itk::ImageRandomSampler< TInputImage >::Superclass = ImageRandomSamplerBase<TInputImage>

Definition at line 46 of file itkImageRandomSampler.h.

Constructor & Destructor Documentation

ImageRandomSampler()

template<class TInputImage >

itk::ImageRandomSampler< TInputImage >::ImageRandomSampler ( )

protecteddefault

The constructor.

~ImageRandomSampler()

template<class TInputImage >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

GenerateData()

template<class TInputImage >

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

overrideprotected

Functions that do the work.

GetClassName()

template<class TInputImage >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRandomSamplerBase< TInputImage >.

Reimplemented in elastix::RandomSampler< TElastix >.

ITK_DISALLOW_COPY_AND_MOVE()

template<class TInputImage >

itk::ImageRandomSampler< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE

(

ImageRandomSampler< TInputImage >

)

itkStaticConstMacro()

template<class TInputImage >

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

The input image dimension.

New()

template<class TInputImage >

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

static

Method for creation through the object factory.

ThreadedGenerateData()

template<class TInputImage >

void itk::ImageRandomSampler< TInputImage >::ThreadedGenerateData ( const InputImageRegionType &  inputRegionForThread, ThreadIdType  threadId  )

overrideprotectedvirtual

Reimplemented from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >.