#include <itkGaussianRandomSpatialNeighborSubsampler.h>

Detailed Description

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

A subsampler that randomly selects points according to a gaussian distribution within the specified radius of the query point.

This class derives from UniformRandomNeighborSubsampler and overrides the GetIntegerVariate method to randomly select points according to a gaussian distribution within the Radius given by SetRadius(radius) as long as that point is also within the RegionConstraint. Use SetVariance(variance) to provide the variance of the gaussian distribution.

See also: SubsamplerBase, RegionConstrainedSubsampler; SpatialNeighborSubsampler; UniformRandomSpatialNeighborSubsampler

Definition at line 48 of file itkGaussianRandomSpatialNeighborSubsampler.h.

Inheritance diagram for itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >:

Collaboration diagram for itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >:

Public Types
using	Baseclass = typename Superclass::Baseclass

using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	RandomGeneratorType

using	RandomIntType

using	RealType = double

using	SearchSizeType

using	Self = GaussianRandomSpatialNeighborSubsampler<TSample, TRegion>

using	Superclass = UniformRandomSpatialNeighborSubsampler<TSample, TRegion>

Public Types inherited from itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
using	Baseclass = typename Superclass::Baseclass

using	ConstPointer = SmartPointer<const Self>

using	ImageHelperType

using	IndexType

using	IndexValueType

using	InstanceIdentifier

using	InstanceIdentifierHolder

using	MeasurementVectorType

using	Pointer = SmartPointer<Self>

using	RadiusType

using	RandomGeneratorType = Statistics::MersenneTwisterRandomVariateGenerator

using	RandomIntType = unsigned int

using	RegionType

using	SampleConstPointer

using	SampleType

using	SearchSizeType = unsigned long

using	SeedType = typename Baseclass::SeedType

using	Self = UniformRandomSpatialNeighborSubsampler<TSample, TRegion>

using	SizeType

using	SubsampleConstIterator

using	SubsamplePointer

using	SubsampleType

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	IndexType

using	IndexValueType

using	InstanceIdentifier

using	InstanceIdentifierHolder

using	MeasurementVectorType

using	Pointer = SmartPointer<Self>

using	RadiusType = typename RegionType::SizeType

using	RegionType

using	SampleConstPointer

using	SampleType

using	Self = SpatialNeighborSubsampler<TSample, TRegion>

using	SizeType

using	SubsampleConstIterator

using	SubsamplePointer

using	SubsampleType

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
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override

virtual RealType	GetVariance () const

virtual void	SetVariance (RealType _arg)

Public Member Functions inherited from itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
virtual::itk::LightObject::Pointer	CreateAnother () const

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	UseClockForSeedOff ()

virtual void	UseClockForSeedOn ()

Public Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
virtual const RadiusType &	GetRadius () const

virtual const bool &	GetRadiusInitialized () const

void	SetRadius (const RadiusType &radius)

void	SetRadius (unsigned int radius)

Public Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
virtual const RegionType &	GetRegionConstraint () const

virtual const bool &	GetRegionConstraintInitialized () const

virtual const RegionType &	GetSampleRegion () const

virtual const bool &	GetSampleRegionInitialized () const

void	SetRegionConstraint (const RegionType &region)

void	SetSampleRegion (const RegionType &region)

Public Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
	itkCloneMacro (Self)

virtual void	SetSample (const SampleType *_arg)

virtual const SampleType *	GetSample () const

virtual void	SetCanSelectQuery (bool _arg)

virtual const bool &	GetCanSelectQuery () const

virtual void	CanSelectQueryOn ()

virtual void	CanSelectQueryOff ()

virtual void	SetSeed (SeedType _arg)

virtual const SeedType &	GetSeed () 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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
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 ()

Static Public Attributes
static constexpr int	DefaultVariance = 900

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

Protected Member Functions
	GaussianRandomSpatialNeighborSubsampler ()

RandomIntType	GetIntegerVariate (RandomIntType lowerBound, RandomIntType upperBound, RandomIntType mean) override

LightObject::Pointer	InternalClone () const override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GaussianRandomSpatialNeighborSubsampler () override=default

Protected Member Functions inherited from itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
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 >
	SpatialNeighborSubsampler ()

	~SpatialNeighborSubsampler () override=default

Protected Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
	RegionConstrainedSubsampler ()

	~RegionConstrainedSubsampler () override=default

Protected Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
	SubsamplerBase ()

	~SubsamplerBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
RealType	m_Variance {}

Protected Attributes inherited from itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >
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 {}

Member Typedef Documentation

◆ Baseclass

template<typename TSample, typename TRegion>

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

Definition at line 57 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ ConstPointer

template<typename TSample, typename TRegion>

using itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ Pointer

template<typename TSample, typename TRegion>

using itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ RandomGeneratorType

template<typename TSample, typename TRegion>

using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RandomGeneratorType

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

Definition at line 80 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ RealType

template<typename TSample, typename TRegion>

using itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::RealType = double

Definition at line 87 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ SearchSizeType

template<typename TSample, typename TRegion>

using itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SearchSizeType

Definition at line 79 of file itkUniformRandomSpatialNeighborSubsampler.h.

◆ Self

template<typename TSample, typename TRegion>

using itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::Self = GaussianRandomSpatialNeighborSubsampler<TSample, TRegion>

Standard class type aliases

Definition at line 55 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ Superclass

template<typename TSample, typename TRegion>

using itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::Superclass = UniformRandomSpatialNeighborSubsampler<TSample, TRegion>

Definition at line 56 of file itkGaussianRandomSpatialNeighborSubsampler.h.

Constructor & Destructor Documentation

◆ GaussianRandomSpatialNeighborSubsampler()

template<typename TSample, typename TRegion>

itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::GaussianRandomSpatialNeighborSubsampler ( )

protected

Referenced by GetNameOfClass().

◆ ~GaussianRandomSpatialNeighborSubsampler()

template<typename TSample, typename TRegion>

itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::~GaussianRandomSpatialNeighborSubsampler ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TSample, typename TRegion>

virtual::itk::LightObject::Pointer itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ GetIntegerVariate()

template<typename TSample, typename TRegion>

RandomIntType itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::GetIntegerVariate	(	RandomIntType	lowerBound,
		RandomIntType	upperBound,
		RandomIntType	mean )

overrideprotectedvirtual

method to randomly generate an integer in the closed range [0, upperBound] using a gaussian selection method.

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

◆ GetNameOfClass()

template<typename TSample, typename TRegion>

const char * itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References GaussianRandomSpatialNeighborSubsampler().

◆ GetVariance()

template<typename TSample, typename TRegion>

virtual RealType itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::GetVariance ( ) const

virtual

Get the variance

◆ InternalClone()

template<typename TSample, typename TRegion>

LightObject::Pointer itk::Statistics::GaussianRandomSpatialNeighborSubsampler< 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::LightObject.

◆ New()

template<typename TSample, typename TRegion>

static Pointer itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TSample, typename TRegion>

void itk::Statistics::GaussianRandomSpatialNeighborSubsampler< 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::LightObject.

◆ SetVariance()

template<typename TSample, typename TRegion>

virtual void itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::SetVariance ( RealType _arg )

virtual

Set the variance

Member Data Documentation

◆ DefaultVariance

template<typename TSample, typename TRegion>

int itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::DefaultVariance = 900

staticconstexpr

Default sampling variance

Definition at line 91 of file itkGaussianRandomSpatialNeighborSubsampler.h.

◆ m_Variance

template<typename TSample, typename TRegion>

RealType itk::Statistics::GaussianRandomSpatialNeighborSubsampler< TSample, TRegion >::m_Variance {}

protected

Definition at line 120 of file itkGaussianRandomSpatialNeighborSubsampler.h.

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

itkGaussianRandomSpatialNeighborSubsampler.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Baseclass

◆ ConstPointer

◆ Pointer

◆ RandomGeneratorType

◆ RandomIntType

◆ RealType

◆ SearchSizeType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GaussianRandomSpatialNeighborSubsampler()

◆ ~GaussianRandomSpatialNeighborSubsampler()

Member Function Documentation

◆ CreateAnother()

◆ GetIntegerVariate()

◆ GetNameOfClass()

◆ GetVariance()

◆ InternalClone()

◆ New()

◆ PrintSelf()

◆ SetVariance()

Member Data Documentation

◆ DefaultVariance

◆ m_Variance