ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion > Class Template Reference

#include <itkUniformRandomSpatialNeighborSubsampler.h>

Detailed Description

template<typename TSample, typename TRegion>
class itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >

A subsampler that uniformly randomly selects points within the specified radius of the query point.

This class derives from SpatialNeighborSubsampler and randomly selects points according to a uniform distribution within the Radius given by SetRadius(radius) as long as that point is also within the RegionConstraint.

This class assumes that the instance identifiers in the input sample correspond to the result of ComputeOffset() of the index of the corresponding point in the image region.

See also
SubsamplerBase, RegionConstrainedSubsampler
SpatialNeighborSubsampler
GaussianRandomSpatialNeighborSubsampler

Definition at line 49 of file itkUniformRandomSpatialNeighborSubsampler.h.

+ Inheritance diagram for itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >:
+ Collaboration diagram for itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >:

Public Types

using Baseclass = typename Superclass::Baseclass
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RandomGeneratorType = Statistics::MersenneTwisterRandomVariateGenerator
 
using RandomIntType = unsigned int
 
using SearchSizeType = unsigned long
 
using SeedType = typename Baseclass::SeedType
 
using Self = UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
 
using Superclass = SpatialNeighborSubsampler< TSample, TRegion >
 
- Public Types inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
using Baseclass = typename Superclass::Baseclass
 
using ConstPointer = SmartPointer< const Self >
 
using ImageHelperType = ImageHelper< Self::ImageDimension, Self::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename RegionType::SizeType
 
using Self = SpatialNeighborSubsampler< TSample, TRegion >
 
using Superclass = RegionConstrainedSubsampler< TSample, TRegion >
 
- Public Types inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
using Baseclass = typename Superclass::Baseclass
 
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename RegionType::IndexType
 
using IndexValueType = typename IndexType::IndexValueType
 
using InstanceIdentifier = typename TSample::InstanceIdentifier
 
using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder
 
using MeasurementVectorType = typename TSample::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using RegionType = TRegion
 
using SampleConstPointer = typename SampleType::ConstPointer
 
using SampleType = TSample
 
using Self = RegionConstrainedSubsampler< TSample, TRegion >
 
using SizeType = typename RegionType::SizeType
 
using SubsampleConstIterator = typename SubsampleType::ConstIterator
 
using SubsamplePointer = typename SubsampleType::Pointer
 
using SubsampleType = Subsample< TSample >
 
using Superclass = SubsamplerBase< TSample >
 
- Public Types inherited from itk::Statistics::SubsamplerBase< TSample >
using Baseclass = Self
 
using ConstPointer = SmartPointer< const Self >
 
using InstanceIdentifier = typename TSample::InstanceIdentifier
 
using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder
 
using MeasurementVectorType = typename TSample::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using SampleConstPointer = typename SampleType::ConstPointer
 
using SampleType = TSample
 
using SeedType = unsigned int
 
using Self = SubsamplerBase
 
using SubsampleConstIterator = typename SubsampleType::ConstIterator
 
using SubsamplePointer = typename SubsampleType::Pointer
 
using SubsampleType = Subsample< TSample >
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual SearchSizeType GetNumberOfResultsRequested () const
 
virtual bool GetUseClockForSeed () const
 
void Search (const InstanceIdentifier &query, SubsamplePointer &results) override
 
virtual void SetNumberOfResultsRequested (const SearchSizeType &numberRequested)
 
void SetSeed (const SeedType seed) override
 
virtual void SetUseClockForSeed (const bool &useClock)
 
virtual void UseClockForSeedOn ()
 
- Public Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
const char * GetNameOfClass () const override
 
virtual const RadiusTypeGetRadius () const
 
virtual const bool & GetRadiusInitialized () const
 
void Search (const InstanceIdentifier &query, SubsamplePointer &results) override
 
void SetRadius (const RadiusType &radius)
 
void SetRadius (unsigned int radius)
 
- Public Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
const char * GetNameOfClass () const override
 
virtual const RegionTypeGetRegionConstraint () const
 
virtual const bool & GetRegionConstraintInitialized () const
 
virtual const RegionTypeGetSampleRegion () const
 
virtual const bool & GetSampleRegionInitialized () const
 
void Search (const InstanceIdentifier &query, SubsamplePointer &results) override=0
 
void SetRegionConstraint (const RegionType &region)
 
void SetSampleRegion (const RegionType &region)
 
- Public Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
const char * GetNameOfClass () const override
 
 itkCloneMacro (Self)
 
virtual void Search (const InstanceIdentifier &query, SubsamplePointer &results)=0
 
virtual void SetSample (const SampleType *_arg)
 
virtual const SampleTypeGetSample () const
 
virtual void SetCanSelectQuery (bool _arg)
 
virtual const bool & GetCanSelectQuery () const
 
virtual void CanSelectQueryOn ()
 
virtual const SeedTypeGetSeed () const
 
virtual void RequestMaximumNumberOfResults ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual RandomIntType GetIntegerVariate (RandomIntType lowerBound, RandomIntType upperBound, RandomIntType)
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 UniformRandomSpatialNeighborSubsampler ()
 
 ~UniformRandomSpatialNeighborSubsampler () override=default
 
- Protected Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialNeighborSubsampler ()
 
 ~SpatialNeighborSubsampler () override=default
 
- Protected Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegionConstrainedSubsampler ()
 
 ~RegionConstrainedSubsampler () override=default
 
- Protected Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SubsamplerBase ()
 
 ~SubsamplerBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

SearchSizeType m_NumberOfResultsRequested {}
 
RandomGeneratorType::Pointer m_RandomNumberGenerator {}
 
bool m_UseClockForSeed {}
 
- Protected Attributes inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
RadiusType m_Radius {}
 
bool m_RadiusInitialized {}
 
- Protected Attributes inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
RegionType m_RegionConstraint {}
 
bool m_RegionConstraintInitialized {}
 
RegionType m_SampleRegion {}
 
bool m_SampleRegionInitialized {}
 
- Protected Attributes inherited from itk::Statistics::SubsamplerBase< TSample >
bool m_CanSelectQuery {}
 
bool m_RequestMaximumNumberOfResults {}
 
SampleConstPointer m_Sample {}
 
SeedType m_Seed {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
static constexpr unsigned int ImageDimension = RegionType::ImageDimension
 

Member Typedef Documentation

◆ Baseclass

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Baseclass = typename Superclass::Baseclass

Definition at line 57 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ ConstPointer

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ Pointer

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ RandomGeneratorType

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RandomGeneratorType = Statistics::MersenneTwisterRandomVariateGenerator

type alias related to random variate generator

Definition at line 92 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ RandomIntType

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RandomIntType = unsigned int

Definition at line 80 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ SearchSizeType

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SearchSizeType = unsigned long

Definition at line 79 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ SeedType

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SeedType = typename Baseclass::SeedType

Definition at line 77 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ Self

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Self = UniformRandomSpatialNeighborSubsampler<TSample, TRegion>

Standard class type aliases

Definition at line 55 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ Superclass

template<typename TSample , typename TRegion >
using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Superclass = SpatialNeighborSubsampler<TSample, TRegion>

Definition at line 56 of file itkUniformRandomSpatialNeighborSubsampler.h.

Constructor & Destructor Documentation

◆ UniformRandomSpatialNeighborSubsampler()

template<typename TSample , typename TRegion >
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UniformRandomSpatialNeighborSubsampler ( )
protected

◆ ~UniformRandomSpatialNeighborSubsampler()

template<typename TSample , typename TRegion >
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::~UniformRandomSpatialNeighborSubsampler ( )
overrideprotecteddefault

Member Function Documentation

◆ GetIntegerVariate()

template<typename TSample , typename TRegion >
virtual RandomIntType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetIntegerVariate ( RandomIntType  lowerBound,
RandomIntType  upperBound,
RandomIntType   
)
protectedvirtual

method to randomly generate an integer in the closed range [lowerBound, upperBound] using a uniform sampling selection method. override this method to do gaussian selection

Reimplemented in itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >.

◆ GetNameOfClass()

template<typename TSample , typename TRegion >
const char * itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetNameOfClass ( ) const
overridevirtual

◆ GetNumberOfResultsRequested()

template<typename TSample , typename TRegion >
virtual SearchSizeType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetNumberOfResultsRequested ( ) const
virtual

◆ GetUseClockForSeed()

template<typename TSample , typename TRegion >
virtual bool itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetUseClockForSeed ( ) const
virtual

◆ InternalClone()

template<typename TSample , typename TRegion >
LightObject::Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::InternalClone ( ) const
overrideprotectedvirtual

Clone the current subsampler. This does a complete copy of the subsampler state to the new subsampler

Reimplemented from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

◆ New()

template<typename TSample , typename TRegion >
static Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TSample , typename TRegion >
void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

◆ Search()

template<typename TSample , typename TRegion >
void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Search ( const InstanceIdentifier query,
SubsamplePointer results 
)
overridevirtual

Main Search method that MUST be implemented by each subclass The Search method will find all points similar to query and return them as a Subsample. The definition of similar will be subclass- specific. And could mean spatial similarity or feature similarity etc.

Reimplemented from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

◆ SetNumberOfResultsRequested()

template<typename TSample , typename TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetNumberOfResultsRequested ( const SearchSizeType numberRequested)
inlinevirtual

Definition at line 119 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ SetSeed()

template<typename TSample , typename TRegion >
void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetSeed ( const SeedType  _arg)
inlineoverridevirtual

Provide an interface to set the seed. The seed value will be used by subclasses where appropriate.

Reimplemented from itk::Statistics::SubsamplerBase< TSample >.

Definition at line 95 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ SetUseClockForSeed()

template<typename TSample , typename TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetUseClockForSeed ( const bool &  useClock)
inlinevirtual

Definition at line 102 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ UseClockForSeedOn()

template<typename TSample , typename TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UseClockForSeedOn ( )
virtual

Member Data Documentation

◆ m_NumberOfResultsRequested

template<typename TSample , typename TRegion >
SearchSizeType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_NumberOfResultsRequested {}
protected

Definition at line 161 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ m_RandomNumberGenerator

template<typename TSample , typename TRegion >
RandomGeneratorType::Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_RandomNumberGenerator {}
protected

Definition at line 162 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ m_UseClockForSeed

template<typename TSample , typename TRegion >
bool itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_UseClockForSeed {}
protected

Definition at line 163 of file itkUniformRandomSpatialNeighborSubsampler.h.


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