ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::Statistics::SubsamplerBase< TSample > Class Template Referenceabstract

#include <itkSubsamplerBase.h>

+ Inheritance diagram for itk::Statistics::SubsamplerBase< TSample >:
+ Collaboration diagram for itk::Statistics::SubsamplerBase< TSample >:

Public Types

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 const char * GetNameOfClass () const
 
 itkCloneMacro (Self)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
SampleConstPointer m_Sample
 
bool m_RequestMaximumNumberOfResults
 
bool m_CanSelectQuery
 
SeedType m_Seed
 
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 ()
 
virtual void Search (const InstanceIdentifier &query, SubsamplePointer &results)=0
 
LightObject::Pointer InternalClone () const override
 
 SubsamplerBase ()
 
 ~SubsamplerBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TSample>
class itk::Statistics::SubsamplerBase< TSample >

This is the base subsampler class which defines the subsampler API.

This class will search a Sample provided by SetSample and return a Subsample that are related in some way to the queried value. Some examples of subsampling strategies include uniform random selection, selection based on KdTree, and selection based on spatial proximity.

This is an Abstract class that can not be instantiated. There are multiple subsamplers that derive from this class and provide specific implementations of subsampling strategies.

See also
RegionConstrainedSubsampler, SpatialNeighborSubsampler
GaussianRandomSpatialNeighborSubsampler
UniformRandomSpatialNeighborSubsampler

Definition at line 48 of file itkSubsamplerBase.h.

Member Typedef Documentation

◆ Baseclass

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::Baseclass = Self

Definition at line 56 of file itkSubsamplerBase.h.

◆ ConstPointer

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkSubsamplerBase.h.

◆ InstanceIdentifier

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::InstanceIdentifier = typename TSample::InstanceIdentifier

Definition at line 70 of file itkSubsamplerBase.h.

◆ InstanceIdentifierHolder

Definition at line 75 of file itkSubsamplerBase.h.

◆ MeasurementVectorType

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::MeasurementVectorType = typename TSample::MeasurementVectorType

Definition at line 69 of file itkSubsamplerBase.h.

◆ Pointer

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkSubsamplerBase.h.

◆ SampleConstPointer

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SampleConstPointer = typename SampleType::ConstPointer

Definition at line 68 of file itkSubsamplerBase.h.

◆ SampleType

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SampleType = TSample

type alias alias for the source data container

Definition at line 67 of file itkSubsamplerBase.h.

◆ SeedType

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SeedType = unsigned int

Definition at line 76 of file itkSubsamplerBase.h.

◆ Self

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::Self = SubsamplerBase

Standard class type aliases

Definition at line 54 of file itkSubsamplerBase.h.

◆ SubsampleConstIterator

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SubsampleConstIterator = typename SubsampleType::ConstIterator

Definition at line 74 of file itkSubsamplerBase.h.

◆ SubsamplePointer

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SubsamplePointer = typename SubsampleType::Pointer

Definition at line 73 of file itkSubsamplerBase.h.

◆ SubsampleType

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::SubsampleType = Subsample<TSample>

Definition at line 72 of file itkSubsamplerBase.h.

◆ Superclass

template<typename TSample >
using itk::Statistics::SubsamplerBase< TSample >::Superclass = Object

Definition at line 55 of file itkSubsamplerBase.h.

Constructor & Destructor Documentation

◆ SubsamplerBase()

template<typename TSample >
itk::Statistics::SubsamplerBase< TSample >::SubsamplerBase ( )
protected

Plug in the actual sample data

◆ ~SubsamplerBase()

template<typename TSample >
itk::Statistics::SubsamplerBase< TSample >::~SubsamplerBase ( )
overrideprotecteddefault

Plug in the actual sample data

Member Function Documentation

◆ CanSelectQueryOff()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::CanSelectQueryOff ( )
virtual

Plug in the actual sample data

◆ CanSelectQueryOn()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::CanSelectQueryOn ( )
virtual

Plug in the actual sample data

◆ GetCanSelectQuery()

template<typename TSample >
virtual const bool& itk::Statistics::SubsamplerBase< TSample >::GetCanSelectQuery ( ) const
virtual

Plug in the actual sample data

◆ GetNameOfClass()

template<typename TSample >
virtual const char* itk::Statistics::SubsamplerBase< TSample >::GetNameOfClass ( ) const
virtual

◆ GetSample()

template<typename TSample >
virtual const SampleType* itk::Statistics::SubsamplerBase< TSample >::GetSample ( ) const
virtual

Plug in the actual sample data

◆ GetSeed()

template<typename TSample >
virtual const SeedType& itk::Statistics::SubsamplerBase< TSample >::GetSeed ( ) const
virtual

Plug in the actual sample data

◆ InternalClone()

template<typename TSample >
LightObject::Pointer itk::Statistics::SubsamplerBase< TSample >::InternalClone ( ) const
overrideprotectedvirtual

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

Reimplemented from itk::LightObject.

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

◆ itkCloneMacro()

template<typename TSample >
itk::Statistics::SubsamplerBase< TSample >::itkCloneMacro ( Self  )

implement type-specific clone method

◆ PrintSelf()

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

Plug in the actual sample data

Reimplemented from itk::Object.

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

◆ RequestMaximumNumberOfResults()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::RequestMaximumNumberOfResults ( )
inlinevirtual

Specify whether the subsampler should return all possible matches.

Definition at line 102 of file itkSubsamplerBase.h.

◆ Search()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::Search ( const InstanceIdentifier query,
SubsamplePointer results 
)
pure virtual

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.

Implemented in itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >, itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >, and itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

◆ SetCanSelectQuery()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::SetCanSelectQuery ( bool  _arg)
virtual

Indicate whether the Search method can return the query point as one element of the Subsample

◆ SetSample()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::SetSample ( const SampleType _arg)
virtual

Plug in the actual sample data

◆ SetSeed()

template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::SetSeed ( SeedType  _arg)
virtual

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

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

Member Data Documentation

◆ m_CanSelectQuery

template<typename TSample >
bool itk::Statistics::SubsamplerBase< TSample >::m_CanSelectQuery
protected

Plug in the actual sample data

Definition at line 137 of file itkSubsamplerBase.h.

◆ m_RequestMaximumNumberOfResults

template<typename TSample >
bool itk::Statistics::SubsamplerBase< TSample >::m_RequestMaximumNumberOfResults
protected

Plug in the actual sample data

Definition at line 136 of file itkSubsamplerBase.h.

◆ m_Sample

template<typename TSample >
SampleConstPointer itk::Statistics::SubsamplerBase< TSample >::m_Sample
protected

Plug in the actual sample data

Definition at line 135 of file itkSubsamplerBase.h.

◆ m_Seed

template<typename TSample >
SeedType itk::Statistics::SubsamplerBase< TSample >::m_Seed
protected

Plug in the actual sample data

Definition at line 138 of file itkSubsamplerBase.h.


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