Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::RandomImageSampler Class Reference

Randomly samples voxels from a label image using configurable strategies. More...

#include <mitkRandomImageSampler.h>

Inheritance diagram for mitk::RandomImageSampler:
Collaboration diagram for mitk::RandomImageSampler:

Public Member Functions

 mitkClassMacro (RandomImageSampler, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetSamplingMode (RandomImageSamplerMode _arg)
 
virtual RandomImageSamplerMode GetSamplingMode () const
 
virtual void SetAcceptanceRate (double _arg)
 
virtual double GetAcceptanceRate () const
 
void SetAcceptanceRateVector (std::vector< double > arg)
 Set per-class acceptance rates for CLASS_DEPENDEND_ACCEPTANCE_RATE mode. More...
 
virtual std::vector< double > GetAcceptanceRateVector () const
 
virtual void SetNumberOfSamples (unsigned int _arg)
 
virtual unsigned int GetNumberOfSamples () const
 
void SetNumberOfSamplesVector (std::vector< unsigned int > arg)
 Set per-class sample counts for CLASS_DEPENDEND_NUMBER_OF_ACCEPTANCE mode. More...
 
virtual std::vector< unsigned int > GetNumberOfSamplesVector () const
 
- Public Member Functions inherited from mitk::ImageToImageFilter
 mitkClassMacro (ImageToImageFilter, ImageSource)
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 Set the image input of this process object. More...
 
virtual void SetInput (unsigned int idx, const InputImageType *image)
 Set the image input at the specified index. More...
 
InputImageType * GetInput (void)
 Get the input image (non-const). More...
 
InputImageType * GetInput (unsigned int idx)
 Get the input image at the specified index (non-const). More...
 
const InputImageType * GetInput (void) const
 Get the input image (const). More...
 
const InputImageType * GetInput (unsigned int idx) const
 Get the input image at the specified index (const). More...
 
- Public Member Functions inherited from mitk::ImageSource
 mitkClassMacro (ImageSource, BaseDataSource)
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Get the output data of this image source object. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 Get the output as VTK image data (non-const version). More...
 
virtual const vtkImageData * GetVtkImageData () const
 Get the output as VTK image data (const version). More...
 
- Public Member Functions inherited from mitk::BaseDataSource
 mitkClassMacroItkParent (BaseDataSource, itk::ProcessObject)
 
OutputType * GetOutput ()
 
const OutputType * GetOutput () const
 
OutputType * GetOutput (DataObjectPointerArraySizeType idx)
 
const OutputType * GetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 Graft the specified base data object onto a named output. More...
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Check whether the pipeline is currently executing. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::ImageSource
static Pointer New ()
 Method for creation through the object factory. More...
 

Additional Inherited Members

- Public Types inherited from mitk::ImageToImageFilter
typedef Superclass::OutputImageRegionType OutputImageRegionType
 Superclass typedefs. More...
 
typedef mitk::Image InputImageType
 Some convenient typedefs. More...
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseData OutputType
 Output data type. More...
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 Identifier type for named data objects. More...
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Print self information to the given stream. More...
 
void GenerateInputRequestedRegion () override
 Determine the input requested region to produce the output requested region. More...
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 Constructor. More...
 
 ~BaseDataSource () override
 Destructor. More...
 
- Static Protected Member Functions inherited from mitk::ImageSource
static itk::ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Randomly samples voxels from a label image using configurable strategies.

This filter produces a sub-sampled version of a label image. It supports four sampling modes: single acceptance rate, class-dependent acceptance rate, fixed number of samples, and class-dependent fixed number of samples.

Definition at line 40 of file mitkRandomImageSampler.h.

Member Function Documentation

◆ Clone()

Pointer mitk::RandomImageSampler::Clone ( ) const

◆ GetAcceptanceRate()

virtual double mitk::RandomImageSampler::GetAcceptanceRate ( ) const
virtual

◆ GetAcceptanceRateVector()

virtual std::vector<double> mitk::RandomImageSampler::GetAcceptanceRateVector ( ) const
virtual

◆ GetNumberOfSamples()

virtual unsigned int mitk::RandomImageSampler::GetNumberOfSamples ( ) const
virtual

◆ GetNumberOfSamplesVector()

virtual std::vector<unsigned int> mitk::RandomImageSampler::GetNumberOfSamplesVector ( ) const
virtual

◆ GetSamplingMode()

virtual RandomImageSamplerMode mitk::RandomImageSampler::GetSamplingMode ( ) const
virtual

◆ mitkClassMacro()

mitk::RandomImageSampler::mitkClassMacro ( RandomImageSampler  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::RandomImageSampler::New ( )
static

◆ SetAcceptanceRate()

virtual void mitk::RandomImageSampler::SetAcceptanceRate ( double  _arg)
virtual

◆ SetAcceptanceRateVector()

void mitk::RandomImageSampler::SetAcceptanceRateVector ( std::vector< double >  arg)
inline

Set per-class acceptance rates for CLASS_DEPENDEND_ACCEPTANCE_RATE mode.

Parameters
argVector of acceptance rates, one per class label.

Definition at line 57 of file mitkRandomImageSampler.h.

◆ SetNumberOfSamples()

virtual void mitk::RandomImageSampler::SetNumberOfSamples ( unsigned int  _arg)
virtual

◆ SetNumberOfSamplesVector()

void mitk::RandomImageSampler::SetNumberOfSamplesVector ( std::vector< unsigned int >  arg)
inline

Set per-class sample counts for CLASS_DEPENDEND_NUMBER_OF_ACCEPTANCE mode.

Parameters
argVector of sample counts, one per class label.

Definition at line 71 of file mitkRandomImageSampler.h.

◆ SetSamplingMode()

virtual void mitk::RandomImageSampler::SetSamplingMode ( RandomImageSamplerMode  _arg)
virtual

The documentation for this class was generated from the following file: