itk::ImageRandomSamplerBase< TInputImage > Class Template Reference

#include <itkImageRandomSamplerBase.h>

Detailed Description

template<class TInputImage>
class itk::ImageRandomSamplerBase< TInputImage >

This class is a base class for any image sampler that randomly picks samples.

It adds the Set/GetNumberOfSamples function.

Definition at line 36 of file itkImageRandomSamplerBase.h.

Inheritance diagram for itk::ImageRandomSamplerBase< TInputImage >:

Public Types
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< 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 Member Functions
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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
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)

Static Public Member Functions
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	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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
void	PrintSelf (std::ostream &os, Indent indent) const override
	VectorContainerSource ()
	~VectorContainerSource () override=default

Protected Attributes
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::ImageRandomSamplerBase< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkImageRandomSamplerBase.h.

ImageSampleContainerPointer

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer

Definition at line 77 of file itkImageSamplerBase.h.

ImageSampleContainerType

template<class TInputImage >

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

Definition at line 76 of file itkImageSamplerBase.h.

ImageSampleType

template<class TInputImage >

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

Other typdefs.

Definition at line 75 of file itkImageSamplerBase.h.

MaskType

template<class TInputImage >

using itk::ImageSamplerBase< TInputImage >::MaskType = SpatialObject<Self::InputImageDimension>

Definition at line 83 of file itkImageSamplerBase.h.

Pointer

template<class TInputImage >

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

Definition at line 44 of file itkImageRandomSamplerBase.h.

Self

template<class TInputImage >

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

Standard ITK-stuff.

Definition at line 42 of file itkImageRandomSamplerBase.h.

Superclass

template<class TInputImage >

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

Definition at line 43 of file itkImageRandomSamplerBase.h.

Constructor & Destructor Documentation

ImageRandomSamplerBase()

template<class TInputImage >

itk::ImageRandomSamplerBase< TInputImage >::ImageRandomSamplerBase ( )

protected

The constructor.

~ImageRandomSamplerBase()

template<class TInputImage >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

BeforeThreadedGenerateData()

template<class TInputImage >

void itk::ImageRandomSamplerBase< TInputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Multi-threaded function that does the work.

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

Reimplemented in itk::ImageRandomSamplerSparseMask< TInputImage >, and itk::ImageRandomSamplerSparseMask< elx::ImageSamplerBase< TElastix >::InputImageType >.

GetClassName()

template<class TInputImage >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in itk::ImageRandomCoordinateSampler< TInputImage >, itk::ImageRandomCoordinateSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomSampler< TInputImage >, itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomSamplerSparseMask< TInputImage >, itk::ImageRandomSamplerSparseMask< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::MultiInputImageRandomCoordinateSampler< TInputImage >, itk::MultiInputImageRandomCoordinateSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, elastix::MultiInputRandomCoordinateSampler< TElastix >, elastix::RandomSampler< TElastix >, elastix::RandomCoordinateSampler< TElastix >, and elastix::RandomSamplerSparseMask< TElastix >.

ITK_DISALLOW_COPY_AND_MOVE()

template<class TInputImage >

itk::ImageRandomSamplerBase< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE

(

ImageRandomSamplerBase< TInputImage >

)

itkStaticConstMacro()

template<class TInputImage >

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

The input image dimension.

New()

template<class TInputImage >

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

static

Method for creation through the object factory.

PrintSelf()

template<class TInputImage >

void itk::ImageRandomSamplerBase< TInputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

PrintSelf.

Field Documentation

m_RandomNumberList

template<class TInputImage >

std::vector<double> itk::ImageRandomSamplerBase< TInputImage >::m_RandomNumberList

protected

Member variable used when threading.

Definition at line 86 of file itkImageRandomSamplerBase.h.