#include <itkSpatialNeighborSubsampler.h>

Detailed Description

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

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

This class derives from RegionConstrainedSubsampler and returns all points within the Radius given by SetRadius(radius) as long as that point is also within the RegionConstraint. In order for this to work, a region corresponding to the Sample must be provided using SetSampleRegion(region)

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; GaussianRandomSpatialNeighborSubsampler; UniformRandomSpatialNeighborSubsampler

Definition at line 51 of file itkSpatialNeighborSubsampler.h.

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

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

Public Types
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 const RadiusType &	GetRadius () 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 RegionType &	GetRegionConstraint () const

virtual const bool &	GetRegionConstraintInitialized () const

virtual const RegionType &	GetSampleRegion () 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 SampleType *	GetSample () const

virtual void	SetCanSelectQuery (bool _arg)

virtual const bool &	GetCanSelectQuery () const

virtual void	CanSelectQueryOn ()

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

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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 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::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 unsigned int	ImageDimension = RegionType::ImageDimension

Protected Member Functions
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
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::SpatialNeighborSubsampler< TSample, TRegion >::Baseclass = typename Superclass::Baseclass

Definition at line 59 of file itkSpatialNeighborSubsampler.h.

◆ ConstPointer

template<typename TSample , typename TRegion >

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

Definition at line 61 of file itkSpatialNeighborSubsampler.h.

◆ ImageHelperType

template<typename TSample , typename TRegion >

using itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::ImageHelperType = ImageHelper<Self::ImageDimension, Self::ImageDimension>

other helpful type alias

Definition at line 89 of file itkSpatialNeighborSubsampler.h.

◆ Pointer

template<typename TSample , typename TRegion >

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

Definition at line 60 of file itkSpatialNeighborSubsampler.h.

◆ RadiusType

template<typename TSample , typename TRegion >

using itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::RadiusType = typename RegionType::SizeType

Definition at line 85 of file itkSpatialNeighborSubsampler.h.

◆ Self

template<typename TSample , typename TRegion >

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

Standard class type aliases

Definition at line 57 of file itkSpatialNeighborSubsampler.h.

◆ Superclass

template<typename TSample , typename TRegion >

using itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::Superclass = RegionConstrainedSubsampler<TSample, TRegion>

Definition at line 58 of file itkSpatialNeighborSubsampler.h.

Constructor & Destructor Documentation

◆ SpatialNeighborSubsampler()

template<typename TSample , typename TRegion >

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

protected

◆ ~SpatialNeighborSubsampler()

template<typename TSample , typename TRegion >

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

overrideprotecteddefault

Member Function Documentation

◆ GetNameOfClass()

template<typename TSample , typename TRegion >

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

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

◆ GetRadius()

template<typename TSample , typename TRegion >

virtual const RadiusType & itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::GetRadius ( ) const

virtual

Method to get the radius

◆ GetRadiusInitialized()

template<typename TSample , typename TRegion >

virtual const bool & itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::GetRadiusInitialized ( ) const

virtual

Method to get the flag indicating that radius has been initialized

◆ InternalClone()

template<typename TSample , typename TRegion >

LightObject::Pointer itk::Statistics::SpatialNeighborSubsampler< 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::RegionConstrainedSubsampler< TSample, TRegion >.

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

◆ New()

template<typename TSample , typename TRegion >

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TSample , typename TRegion >

void itk::Statistics::SpatialNeighborSubsampler< 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::RegionConstrainedSubsampler< TSample, TRegion >.

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

◆ Search()

template<typename TSample , typename TRegion >

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

Implements itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >.

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

◆ SetRadius() [1/2]

template<typename TSample , typename TRegion >

void itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SetRadius ( const RadiusType & radius )

Method to set the radius

◆ SetRadius() [2/2]

template<typename TSample , typename TRegion >

void itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SetRadius ( unsigned int radius )

Method to set the radius

Member Data Documentation

◆ ImageDimension

template<typename TSample , typename TRegion >

constexpr unsigned int itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::ImageDimension = RegionType::ImageDimension

staticconstexpr

Definition at line 87 of file itkSpatialNeighborSubsampler.h.

◆ m_Radius

template<typename TSample , typename TRegion >

RadiusType itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::m_Radius {}

protected

Definition at line 127 of file itkSpatialNeighborSubsampler.h.

◆ m_RadiusInitialized

template<typename TSample , typename TRegion >

bool itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::m_RadiusInitialized {}

protected

Definition at line 128 of file itkSpatialNeighborSubsampler.h.

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

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

◆ ImageHelperType

◆ Pointer

◆ RadiusType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SpatialNeighborSubsampler()

◆ ~SpatialNeighborSubsampler()

Member Function Documentation

◆ GetNameOfClass()

◆ GetRadius()

◆ GetRadiusInitialized()

◆ InternalClone()

◆ New()

◆ PrintSelf()

◆ Search()

◆ SetRadius() [1/2]

◆ SetRadius() [2/2]

Member Data Documentation

◆ ImageDimension

◆ m_Radius

◆ m_RadiusInitialized