go home Home | Main Page | Topics | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itk::ImageRandomSampler< TInputImage > Class Template Reference

#include <itkImageRandomSampler.h>

Detailed Description

template<typename 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 >:

Classes

struct  UserData

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

 ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSampler)
 itkOverrideGetNameOfClassMacro (ImageRandomSampler)
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
Public Member Functions inherited from itk::ImageRandomSamplerBase< TInputImage >
std::optional< SeedIntegerTypeGetOptionalSeed () 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 InputImageRegionTypeGetCroppedInputImageRegion ()
const InputImageTypeGetInput ()
const InputImageTypeGetInput (unsigned int idx)
virtual const InputImageRegionTypeGetInputImageRegion () const
virtual const InputImageRegionTypeGetInputImageRegion (unsigned int pos) const
virtual const MaskTypeGetMask () const
virtual const MaskTypeGetMask (unsigned int pos) const
virtual unsigned int GetNumberOfInputImageRegions () const
virtual unsigned int GetNumberOfMasks () const
virtual unsigned long GetNumberOfSamples () const
OutputVectorContainerTypeGetOutput ()
 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 > > >
OutputVectorContainerTypeGetOutput ()
OutputVectorContainerTypeGetOutput (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 Member Functions

void GenerateData () override
 ImageRandomSampler ()=default
 ~ImageRandomSampler () 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

Static Private Member Functions

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)

Additional Inherited Members

Static Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
static std::vector< InputImageRegionTypeSplitRegion (const InputImageRegionType &inputRegion, const vcl_size_t requestedNumberOfSubregions)
Protected Attributes inherited from itk::ImageRandomSamplerBase< TInputImage >
std::vector< doublem_RandomNumberList {}
Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long m_NumberOfSamples { 0 }
bool m_UseMultiThread { true }

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 48 of file itkImageRandomSampler.h.

◆ InputImageIndexType

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

Other typedefs.

Definition at line 76 of file itkImageRandomSampler.h.

◆ InputImagePointType

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

Definition at line 77 of file itkImageRandomSampler.h.

◆ Pointer

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

Definition at line 47 of file itkImageRandomSampler.h.

◆ Self

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

Standard ITK-stuff.

Definition at line 45 of file itkImageRandomSampler.h.

◆ Superclass

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

Definition at line 46 of file itkImageRandomSampler.h.

Constructor & Destructor Documentation

◆ ImageRandomSampler()

template<typename TInputImage>
itk::ImageRandomSampler< TInputImage >::ImageRandomSampler ( )
protecteddefault

The constructor.

◆ ~ImageRandomSampler()

template<typename TInputImage>
itk::ImageRandomSampler< TInputImage >::~ImageRandomSampler ( )
overrideprotecteddefault

The destructor.

Member Function Documentation

◆ GenerateData()

template<typename TInputImage>
void itk::ImageRandomSampler< TInputImage >::GenerateData ( )
overrideprotected

Functions that do the work.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TInputImage>
itk::ImageRandomSampler< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE ( ImageRandomSampler< TInputImage > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage>
itk::ImageRandomSampler< TInputImage >::itkOverrideGetNameOfClassMacro ( ImageRandomSampler< TInputImage > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

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

The input image dimension.

◆ New()

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

Method for creation through the object factory.

◆ ThreaderCallback()

template<typename TInputImage>
ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::ImageRandomSampler< TInputImage >::ThreaderCallback ( void * arg)
staticprivate


Generated on 26-02-2026 for elastix by doxygen 1.16.1 (669aeeefca743c148e2d935b3d3c69535c7491e6) elastix logo