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
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef Superclass::ImageSampleContainerPointer	ImageSampleContainerPointer
typedef Superclass::ImageSampleContainerType	ImageSampleContainerType
typedef Superclass::ImageSampleType	ImageSampleType
typedef Superclass::ImageSampleValueType	ImageSampleValueType
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef InputImageType::IndexType	InputImageIndexType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef InputImageType::PointType	InputImagePointType
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageSizeType	InputImageSizeType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::MaskType	MaskType
typedef Superclass::OutputVectorContainerPointer	OutputVectorContainerPointer
typedef Superclass::OutputVectorContainerType	OutputVectorContainerType
typedef SmartPointer< Self >	Pointer
typedef ImageRandomSampler	Self
typedef ImageRandomSamplerBase< TInputImage >	Superclass
Public Types inherited from itk::ImageRandomSamplerBase< TInputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef Superclass::ImageSampleContainerPointer	ImageSampleContainerPointer
typedef Superclass::ImageSampleContainerType	ImageSampleContainerType
typedef Superclass::ImageSampleType	ImageSampleType
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::MaskType	MaskType
typedef Superclass::OutputVectorContainerPointer	OutputVectorContainerPointer
typedef Superclass::OutputVectorContainerType	OutputVectorContainerType
typedef SmartPointer< Self >	Pointer
typedef ImageRandomSamplerBase	Self
typedef ImageSamplerBase< TInputImage >	Superclass
Public Types inherited from itk::ImageSamplerBase< TInputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef ImageSampleContainerType::Pointer	ImageSampleContainerPointer
typedef VectorDataContainer< std::vcl_size_t, ImageSampleType >	ImageSampleContainerType
typedef ImageSample< InputImageType >	ImageSampleType
typedef ImageSampleType::RealType	ImageSampleValueType
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef InputImageType::IndexType	InputImageIndexType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef InputImageType::PointType	InputImagePointType
typedef InputImagePointType::ValueType	InputImagePointValueType
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef std::vector< InputImageRegionType >	InputImageRegionVectorType
typedef InputImageType::SizeType	InputImageSizeType
typedef Superclass::InputImageType	InputImageType
typedef MaskType::ConstPointer	MaskConstPointer
typedef MaskType::Pointer	MaskPointer
typedef SpatialObject< Self::InputImageDimension >	MaskType
typedef std::vector< MaskConstPointer >	MaskVectorType
typedef Superclass::OutputVectorContainerPointer	OutputVectorContainerPointer
typedef Superclass::OutputVectorContainerType	OutputVectorContainerType
typedef SmartPointer< Self >	Pointer
typedef ImageSamplerBase	Self
typedef ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >	Superclass
Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputVectorContainerPointer	OutputVectorContainerPointer
typedef Superclass::OutputVectorContainerType	OutputVectorContainerType
typedef SmartPointer< Self >	Pointer
typedef ImageToVectorContainerFilter	Self
typedef VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >	Superclass
Public Types inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef OutputVectorContainerType::Pointer	OutputVectorContainerPointer
typedef VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > >	OutputVectorContainerType
typedef SmartPointer< Self >	Pointer
typedef VectorContainerSource	Self
typedef ProcessObject	Superclass

Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
Public Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
virtual const char *	GetClassName () const
	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 (unsigned int pos) const
virtual const InputImageRegionType &	GetInputImageRegion (void) const
virtual const MaskType *	GetMask (unsigned int pos) const
virtual const MaskType *	GetMask (void) const
virtual unsigned int	GetNumberOfInputImageRegions () const
virtual unsigned int	GetNumberOfMasks () const
virtual unsigned long	GetNumberOfSamples () const
	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
virtual bool	SelectingNewSamplesOnUpdateSupported (void) const
virtual bool	SelectNewSamplesOnUpdate (void)
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 (void)
virtual void	BeforeThreadedGenerateData (void)
void	GenerateData (void) override
virtual const char *	GetClassName () const
const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
OutputVectorContainerType *	GetOutput (void)
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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
virtual const char *	GetClassName () const
OutputVectorContainerType *	GetOutput (unsigned int idx)
OutputVectorContainerType *	GetOutput (void)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual DataObjectPointer	MakeOutput (unsigned int idx)

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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
static Pointer	New ()

Protected Member Functions
void	GenerateData (void) override
	ImageRandomSampler ()
void	ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId) override
	~ImageRandomSampler () override
Protected Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
void	BeforeThreadedGenerateData (void) override
	ImageRandomSamplerBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageRandomSamplerBase () override
Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
void	AfterThreadedGenerateData (void) override
void	BeforeThreadedGenerateData (void) override
virtual bool	CheckInputImageRegions (void)
void	CropInputImageRegion (void)
void	GenerateInputRequestedRegion (void) override
	ImageSamplerBase ()
virtual bool	IsInsideAllMasks (const InputImagePointType &point) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	UpdateAllMasks (void)
	~ImageSamplerBase () override
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
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

Private Member Functions
	ImageRandomSampler (const Self &)
void	operator= (const Self &)

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
std::vector< ImageSampleContainerPointer >	m_ThreaderSampleContainer
bool	m_UseMultiThread

Member Typedef Documentation

ConstPointer

template<class TInputImage >

typedef SmartPointer< const Self > itk::ImageRandomSampler< TInputImage >::ConstPointer

Definition at line 48 of file itkImageRandomSampler.h.

DataObjectPointer

template<class TInputImage >

typedef Superclass::DataObjectPointer itk::ImageRandomSampler< TInputImage >::DataObjectPointer

Typedefs inherited from the superclass.

Definition at line 57 of file itkImageRandomSampler.h.

ImageSampleContainerPointer

template<class TInputImage >

typedef Superclass::ImageSampleContainerPointer itk::ImageRandomSampler< TInputImage >::ImageSampleContainerPointer

Definition at line 68 of file itkImageRandomSampler.h.

ImageSampleContainerType

template<class TInputImage >

typedef Superclass::ImageSampleContainerType itk::ImageRandomSampler< TInputImage >::ImageSampleContainerType

Definition at line 67 of file itkImageRandomSampler.h.

ImageSampleType

template<class TInputImage >

typedef Superclass::ImageSampleType itk::ImageRandomSampler< TInputImage >::ImageSampleType

Definition at line 65 of file itkImageRandomSampler.h.

ImageSampleValueType

template<class TInputImage >

typedef Superclass::ImageSampleValueType itk::ImageRandomSampler< TInputImage >::ImageSampleValueType

Definition at line 66 of file itkImageRandomSampler.h.

InputImageConstPointer

template<class TInputImage >

typedef Superclass::InputImageConstPointer itk::ImageRandomSampler< TInputImage >::InputImageConstPointer

Definition at line 62 of file itkImageRandomSampler.h.

InputImageIndexType

template<class TInputImage >

typedef InputImageType::IndexType itk::ImageRandomSampler< TInputImage >::InputImageIndexType

Other typedefs.

Definition at line 77 of file itkImageRandomSampler.h.

InputImagePixelType

template<class TInputImage >

typedef Superclass::InputImagePixelType itk::ImageRandomSampler< TInputImage >::InputImagePixelType

Definition at line 64 of file itkImageRandomSampler.h.

InputImagePointer

template<class TInputImage >

typedef Superclass::InputImagePointer itk::ImageRandomSampler< TInputImage >::InputImagePointer

Definition at line 61 of file itkImageRandomSampler.h.

InputImagePointType

template<class TInputImage >

typedef InputImageType::PointType itk::ImageRandomSampler< TInputImage >::InputImagePointType

Definition at line 78 of file itkImageRandomSampler.h.

InputImageRegionType

template<class TInputImage >

typedef Superclass::InputImageRegionType itk::ImageRandomSampler< TInputImage >::InputImageRegionType

Definition at line 63 of file itkImageRandomSampler.h.

InputImageSizeType

template<class TInputImage >

typedef Superclass::InputImageSizeType itk::ImageRandomSampler< TInputImage >::InputImageSizeType

Definition at line 70 of file itkImageRandomSampler.h.

InputImageType

template<class TInputImage >

typedef Superclass::InputImageType itk::ImageRandomSampler< TInputImage >::InputImageType

Definition at line 60 of file itkImageRandomSampler.h.

MaskType

template<class TInputImage >

typedef Superclass::MaskType itk::ImageRandomSampler< TInputImage >::MaskType

Definition at line 69 of file itkImageRandomSampler.h.

OutputVectorContainerPointer

template<class TInputImage >

typedef Superclass::OutputVectorContainerPointer itk::ImageRandomSampler< TInputImage >::OutputVectorContainerPointer

Definition at line 59 of file itkImageRandomSampler.h.

OutputVectorContainerType

template<class TInputImage >

typedef Superclass::OutputVectorContainerType itk::ImageRandomSampler< TInputImage >::OutputVectorContainerType

Definition at line 58 of file itkImageRandomSampler.h.

Pointer

template<class TInputImage >

typedef SmartPointer< Self > itk::ImageRandomSampler< TInputImage >::Pointer

Definition at line 47 of file itkImageRandomSampler.h.

Self

template<class TInputImage >

typedef ImageRandomSampler itk::ImageRandomSampler< TInputImage >::Self

Standard ITK-stuff.

Definition at line 45 of file itkImageRandomSampler.h.

Superclass

template<class TInputImage >

typedef ImageRandomSamplerBase< TInputImage > itk::ImageRandomSampler< TInputImage >::Superclass

Definition at line 46 of file itkImageRandomSampler.h.

Constructor & Destructor Documentation

ImageRandomSampler() [1/2]

template<class TInputImage >

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

inlineprotected

The constructor.

Definition at line 83 of file itkImageRandomSampler.h.

~ImageRandomSampler()

template<class TInputImage >

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

inlineoverrideprotected

The destructor.

Definition at line 85 of file itkImageRandomSampler.h.

ImageRandomSampler() [2/2]

template<class TInputImage >

itk::ImageRandomSampler< TInputImage >::ImageRandomSampler ( const Self &  )

private

The private constructor.

Member Function Documentation

GenerateData()

template<class TInputImage >

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

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

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.

operator=()

template<class TInputImage >

void itk::ImageRandomSampler< TInputImage >::operator= ( const Self &  )

private

The private copy constructor.

ThreadedGenerateData()

template<class TInputImage >

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

overrideprotected