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

#include <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 IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InstanceIdentifier = typename Superclass::InstanceIdentifier
 
using InstanceIdentifierHolder = typename Superclass::InstanceIdentifierHolder
 
using MeasurementVectorType = typename Superclass::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename RegionType::SizeType
 
using RegionType = typename Superclass::RegionType
 
using SampleConstPointer = typename Superclass::SampleConstPointer
 
using SampleType = typename Superclass::SampleType
 
using Self = SpatialNeighborSubsampler< TSample, TRegion >
 
using SizeType = typename Superclass::SizeType
 
using SubsampleConstIterator = typename Superclass::SubsampleConstIterator
 
using SubsamplePointer = typename Superclass::SubsamplePointer
 
using SubsampleType = typename Superclass::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
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
virtual const RegionTypeGetRegionConstraint () const
 
virtual const bool & GetRegionConstraintInitialized () const
 
virtual const RegionTypeGetSampleRegion () 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 SampleTypeGetSample () const
 
virtual void SetCanSelectQuery (bool _arg)
 
virtual const bool & GetCanSelectQuery () const
 
virtual void CanSelectQueryOn ()
 
virtual void CanSelectQueryOff ()
 
virtual void SetSeed (SeedType _arg)
 
virtual const SeedTypeGetSeed () const
 
virtual void RequestMaximumNumberOfResults ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
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)
 
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::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
 
RadiusType m_Radius
 
bool m_RadiusInitialized
 
void SetRadius (const RadiusType &radius)
 
void SetRadius (unsigned int radius)
 
virtual const RadiusTypeGetRadius () const
 
virtual const bool & GetRadiusInitialized () const
 
void Search (const InstanceIdentifier &query, SubsamplePointer &results) override
 
LightObject::Pointer InternalClone () const override
 
 SpatialNeighborSubsampler ()
 
 ~SpatialNeighborSubsampler () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
 RegionConstrainedSubsampler ()
 
 ~RegionConstrainedSubsampler () override=default
 
- Protected Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
LightObject::Pointer InternalClone () const override
 
 SubsamplerBase ()
 
 ~SubsamplerBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 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 >
SampleConstPointer m_Sample
 
bool m_RequestMaximumNumberOfResults
 
bool m_CanSelectQuery
 
SeedType m_Seed
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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.

◆ IndexType

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

Definition at line 82 of file itkSpatialNeighborSubsampler.h.

◆ IndexValueType

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

Definition at line 83 of file itkSpatialNeighborSubsampler.h.

◆ InstanceIdentifier

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

Definition at line 73 of file itkSpatialNeighborSubsampler.h.

◆ InstanceIdentifierHolder

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

Definition at line 78 of file itkSpatialNeighborSubsampler.h.

◆ MeasurementVectorType

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

Definition at line 72 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.

◆ RegionType

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

type alias related to region

Definition at line 81 of file itkSpatialNeighborSubsampler.h.

◆ SampleConstPointer

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

Definition at line 71 of file itkSpatialNeighborSubsampler.h.

◆ SampleType

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

type alias alias for the source data container

Definition at line 70 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.

◆ SizeType

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

Definition at line 84 of file itkSpatialNeighborSubsampler.h.

◆ SubsampleConstIterator

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

Definition at line 77 of file itkSpatialNeighborSubsampler.h.

◆ SubsamplePointer

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

Definition at line 76 of file itkSpatialNeighborSubsampler.h.

◆ SubsampleType

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

Definition at line 75 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

Method to set the radius

◆ ~SpatialNeighborSubsampler()

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

Method to set the radius

Member Function Documentation

◆ CreateAnother()

template<typename TSample , typename TRegion >
virtual::itk::LightObject::Pointer itk::Statistics::SpatialNeighborSubsampler< 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::Object.

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

◆ GetNameOfClass()

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

◆ 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

◆ 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

Method to set the radius

Definition at line 127 of file itkSpatialNeighborSubsampler.h.

◆ m_RadiusInitialized

template<typename TSample , typename TRegion >
bool itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::m_RadiusInitialized
protected

Method to set the radius

Definition at line 128 of file itkSpatialNeighborSubsampler.h.


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