#include <itkMultiInputImageRandomCoordinateSampler.h>

Detailed Description

template<typename TInputImage>
class itk::MultiInputImageRandomCoordinateSampler< TInputImage >

Samples an image by randomly composing a set of physical coordinates.

This image sampler generates not only samples that correspond with pixel locations, but selects points in physical space.

Definition at line 40 of file itkMultiInputImageRandomCoordinateSampler.h.

Inheritance diagram for itk::MultiInputImageRandomCoordinateSampler< TInputImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>
using	CoordinateType = double
using	DefaultInterpolatorType = BSplineInterpolateImageFunction<InputImageType, CoordinateType, double>
using	ImageSampleContainerType
using	ImageSampleType
using	InputImageConstPointer
using	InputImagePixelType
using	InputImagePointer
using	InputImageRegionType
using	InputImageSpacingType = typename InputImageType::SpacingType
using	InputImageType
using	InterpolatorPointer = typename InterpolatorType::Pointer
using	InterpolatorType = InterpolateImageFunction<InputImageType, CoordinateType>
using	MaskType
using	Pointer = SmartPointer<Self>
using	RandomGeneratorPointer = typename RandomGeneratorType::Pointer
using	RandomGeneratorType = itk::Statistics::MersenneTwisterRandomVariateGenerator
using	Self = MultiInputImageRandomCoordinateSampler
using	Superclass = ImageRandomSamplerBase<TInputImage>
Public Types inherited from itk::ImageRandomSamplerBase< TInputImage >
using	ConstPointer = SmartPointer<const Self>
using	ImageSampleContainerPointer
using	ImageSampleContainerType
using	ImageSampleType
using	InputImageConstPointer
using	InputImagePixelType
using	InputImagePointer
using	InputImageRegionType
using	InputImageType
using	MaskType
using	Pointer = SmartPointer<Self>
using	SeedIntegerType = Statistics::MersenneTwisterRandomVariateGenerator::IntegerType
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<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 Member Functions
virtual const InputImageSpacingType &	GetSampleRegionSize ()
virtual bool	GetUseRandomSampleRegion () const
	ITK_DISALLOW_COPY_AND_MOVE (MultiInputImageRandomCoordinateSampler)
	itkGetModifiableObjectMacro (Interpolator, InterpolatorType)
	itkOverrideGetNameOfClassMacro (MultiInputImageRandomCoordinateSampler)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual void	SetSampleRegionSize (InputImageSpacingType _arg)
virtual void	SetUseRandomSampleRegion (bool _arg)
Public Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
std::optional< SeedIntegerType >	GetOptionalSeed () const
	ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSamplerBase)
	itkOverrideGetNameOfClassMacro (ImageRandomSamplerBase)
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
void	SetOptionalSeed (const std::optional< SeedIntegerType > arg)
void	SetRandomVariateGenerator (Statistics::MersenneTwisterRandomVariateGenerator &randomVariateGenerator)
void	SetSeed (const SeedIntegerType arg)
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
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< 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

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

Protected Types
using	InputImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType

Protected Member Functions
void	GenerateData () override
virtual void	GenerateRandomCoordinate (const InputImageContinuousIndexType &smallestContIndex, const InputImageContinuousIndexType &largestContIndex, InputImageContinuousIndexType &randomContIndex)
virtual void	GenerateSampleRegion (InputImageContinuousIndexType &smallestContIndex, InputImageContinuousIndexType &largestContIndex)
	MultiInputImageRandomCoordinateSampler ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~MultiInputImageRandomCoordinateSampler () override=default
Protected Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
void	GenerateRandomNumberList ()
Statistics::MersenneTwisterRandomVariateGenerator &	GetRandomVariateGenerator ()
	ImageRandomSamplerBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageRandomSamplerBase () 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 Attributes
InterpolatorPointer	m_Interpolator
InputImageSpacingType	m_SampleRegionSize { itk::MakeFilled<InputImageSpacingType>(1.0) }
Protected Attributes inherited from itk::ImageRandomSamplerBase< TInputImage >
std::vector< double >	m_RandomNumberList {}
Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long	m_NumberOfSamples { 0 }
bool	m_UseMultiThread { true }

Private Attributes
bool	m_UseRandomSampleRegion { false }

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)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage>

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

Definition at line 49 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ CoordinateType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::CoordinateType = double

This image sampler samples the image on physical coordinates and thus needs an interpolator.

Definition at line 82 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ DefaultInterpolatorType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::DefaultInterpolatorType = BSplineInterpolateImageFunction<InputImageType, CoordinateType, double>

Definition at line 85 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ ImageSampleContainerType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerType

Definition at line 66 of file itkImageSamplerBase.h.

◆ ImageSampleType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::ImageSampleType

Other typdefs.

Definition at line 65 of file itkImageSamplerBase.h.

◆ InputImageConstPointer

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::InputImageConstPointer

Definition at line 62 of file itkImageSamplerBase.h.

◆ InputImageContinuousIndexType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::InputImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType

protected

Definition at line 107 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ InputImagePixelType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::InputImagePixelType

Definition at line 64 of file itkImageSamplerBase.h.

◆ InputImagePointer

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::InputImagePointer

Definition at line 61 of file itkImageSamplerBase.h.

◆ InputImageRegionType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::InputImageRegionType

Definition at line 63 of file itkImageSamplerBase.h.

◆ InputImageSpacingType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::InputImageSpacingType = typename InputImageType::SpacingType

Definition at line 70 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ InputImageType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::InputImageType

Some Image related typedefs.

Definition at line 60 of file itkImageSamplerBase.h.

◆ InterpolatorPointer

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 84 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ InterpolatorType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::InterpolatorType = InterpolateImageFunction<InputImageType, CoordinateType>

Definition at line 83 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ MaskType

template<typename TInputImage>

using itk::ImageSamplerBase< TInputImage >::MaskType

Definition at line 68 of file itkImageSamplerBase.h.

◆ Pointer

template<typename TInputImage>

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

Definition at line 48 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ RandomGeneratorPointer

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::RandomGeneratorPointer = typename RandomGeneratorType::Pointer

Definition at line 89 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ RandomGeneratorType

template<typename TInputImage>

using itk::MultiInputImageRandomCoordinateSampler< TInputImage >::RandomGeneratorType = itk::Statistics::MersenneTwisterRandomVariateGenerator

The random number generator used to generate random coordinates.

Definition at line 88 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ Self

template<typename TInputImage>

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

Standard ITK-stuff.

Definition at line 46 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ Superclass

template<typename TInputImage>

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

Definition at line 47 of file itkMultiInputImageRandomCoordinateSampler.h.

Constructor & Destructor Documentation

◆ MultiInputImageRandomCoordinateSampler()

template<typename TInputImage>

itk::MultiInputImageRandomCoordinateSampler< TInputImage >::MultiInputImageRandomCoordinateSampler ( )

protecteddefault

The constructor.

◆ ~MultiInputImageRandomCoordinateSampler()

template<typename TInputImage>

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

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ GenerateData()

template<typename TInputImage>

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

overrideprotected

Function that does the work.

◆ GenerateRandomCoordinate()

template<typename TInputImage>

virtual void itk::MultiInputImageRandomCoordinateSampler< TInputImage >::GenerateRandomCoordinate	(	const InputImageContinuousIndexType &	smallestContIndex,
		const InputImageContinuousIndexType &	largestContIndex,
		InputImageContinuousIndexType &	randomContIndex )

protectedvirtual

Generate a point randomly in a bounding box. This method can be overwritten in subclasses if a different distribution is desired.

◆ GenerateSampleRegion()

template<typename TInputImage>

virtual void itk::MultiInputImageRandomCoordinateSampler< TInputImage >::GenerateSampleRegion	(	InputImageContinuousIndexType &	smallestContIndex,
		InputImageContinuousIndexType &	largestContIndex )

protectedvirtual

Generate the two corners of a sampling region.

◆ GetSampleRegionSize()

template<typename TInputImage>

virtual const InputImageSpacingType & itk::MultiInputImageRandomCoordinateSampler< TInputImage >::GetSampleRegionSize ( )

virtual

◆ GetUseRandomSampleRegion()

template<typename TInputImage>

virtual bool itk::MultiInputImageRandomCoordinateSampler< TInputImage >::GetUseRandomSampleRegion ( ) const

virtual

Set/Get whether to use randomly selected sample regions, or just the whole image Default: false.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TInputImage>

itk::MultiInputImageRandomCoordinateSampler< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE ( MultiInputImageRandomCoordinateSampler< TInputImage > )

◆ itkGetModifiableObjectMacro()

template<typename TInputImage>

itk::MultiInputImageRandomCoordinateSampler< TInputImage >::itkGetModifiableObjectMacro	(	Interpolator	,
		InterpolatorType	)

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage>

itk::MultiInputImageRandomCoordinateSampler< TInputImage >::itkOverrideGetNameOfClassMacro ( MultiInputImageRandomCoordinateSampler< TInputImage > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TInputImage>

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

The input image dimension.

◆ New()

template<typename TInputImage>

Pointer itk::MultiInputImageRandomCoordinateSampler< TInputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage>

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

overrideprotected

PrintSelf.

◆ SetInterpolator()

template<typename TInputImage>

virtual void itk::MultiInputImageRandomCoordinateSampler< TInputImage >::SetInterpolator ( InterpolatorType * _arg )

virtual

Set/Get the interpolator. A 3rd order B-spline interpolator is used by default.

◆ SetSampleRegionSize()

template<typename TInputImage>

virtual void itk::MultiInputImageRandomCoordinateSampler< TInputImage >::SetSampleRegionSize ( InputImageSpacingType _arg )

virtual

Set/Get the sample region size (in mm). Only needed when UseRandomSampleRegion==true; default: filled with ones.

◆ SetUseRandomSampleRegion()

template<typename TInputImage>

virtual void itk::MultiInputImageRandomCoordinateSampler< TInputImage >::SetUseRandomSampleRegion ( bool _arg )

virtual

Member Data Documentation

◆ m_Interpolator

template<typename TInputImage>

InterpolatorPointer itk::MultiInputImageRandomCoordinateSampler< TInputImage >::m_Interpolator

protected

Initial value:

= [] {
    const auto interpolator = DefaultInterpolatorType::New();
    interpolator->SetSplineOrder(3);
    return interpolator;
  }()

Definition at line 130 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ m_SampleRegionSize

template<typename TInputImage>

InputImageSpacingType itk::MultiInputImageRandomCoordinateSampler< TInputImage >::m_SampleRegionSize { itk::MakeFilled<InputImageSpacingType>(1.0) }

protected

Definition at line 136 of file itkMultiInputImageRandomCoordinateSampler.h.

◆ m_UseRandomSampleRegion

template<typename TInputImage>

bool itk::MultiInputImageRandomCoordinateSampler< TInputImage >::m_UseRandomSampleRegion { false }

private

Definition at line 144 of file itkMultiInputImageRandomCoordinateSampler.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordinateType

◆ DefaultInterpolatorType

◆ ImageSampleContainerType

◆ ImageSampleType

◆ InputImageConstPointer

◆ InputImageContinuousIndexType

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageSpacingType

◆ InputImageType

◆ InterpolatorPointer

◆ InterpolatorType

◆ MaskType

◆ Pointer

◆ RandomGeneratorPointer

◆ RandomGeneratorType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MultiInputImageRandomCoordinateSampler()

◆ ~MultiInputImageRandomCoordinateSampler()

Member Function Documentation

◆ GenerateData()

◆ GenerateRandomCoordinate()

◆ GenerateSampleRegion()

◆ GetSampleRegionSize()

◆ GetUseRandomSampleRegion()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkGetModifiableObjectMacro()

◆ itkOverrideGetNameOfClassMacro()

◆ itkStaticConstMacro()

◆ New()

◆ PrintSelf()

◆ SetInterpolator()

◆ SetSampleRegionSize()

◆ SetUseRandomSampleRegion()

Member Data Documentation

◆ m_Interpolator

◆ m_SampleRegionSize

◆ m_UseRandomSampleRegion