ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private 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 >:

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 46 of file itkSubsamplerBase.h.

Public Types

typedef Self Baseclass
 
typedef SmartPointer< const SelfConstPointer
 
typedef TSample::InstanceIdentifier InstanceIdentifier
 
typedef
SubsampleType::InstanceIdentifierHolder 
InstanceIdentifierHolder
 
typedef
TSample::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef SampleType::ConstPointer SampleConstPointer
 
typedef TSample SampleType
 
typedef unsigned int SeedType
 
typedef SubsamplerBase Self
 
typedef
SubsampleType::ConstIterator 
SubsampleConstIterator
 
typedef SubsampleType::Pointer SubsamplePointer
 
typedef Subsample< TSample > SubsampleType
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
 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 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
 
virtual LightObject::Pointer CreateAnother () const ITK_OVERRIDE
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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
 

Protected Member Functions

virtual LightObject::Pointer InternalClone () const ITK_OVERRIDE
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 SubsamplerBase ()
 
virtual ~SubsamplerBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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

bool m_CanSelectQuery
 
bool m_RequestMaximumNumberOfResults
 
SampleConstPointer m_Sample
 
SeedType m_Seed
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

void operator= (const Self &)
 
 SubsamplerBase (const Self &)
 

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 Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<typename TSample >
typedef Self itk::Statistics::SubsamplerBase< TSample >::Baseclass

Definition at line 52 of file itkSubsamplerBase.h.

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

Definition at line 54 of file itkSubsamplerBase.h.

template<typename TSample >
typedef TSample::InstanceIdentifier itk::Statistics::SubsamplerBase< TSample >::InstanceIdentifier

Definition at line 66 of file itkSubsamplerBase.h.

Definition at line 71 of file itkSubsamplerBase.h.

template<typename TSample >
typedef TSample::MeasurementVectorType itk::Statistics::SubsamplerBase< TSample >::MeasurementVectorType

Definition at line 65 of file itkSubsamplerBase.h.

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

Definition at line 53 of file itkSubsamplerBase.h.

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

Definition at line 64 of file itkSubsamplerBase.h.

template<typename TSample >
typedef TSample itk::Statistics::SubsamplerBase< TSample >::SampleType

typedef alias for the source data container

Definition at line 63 of file itkSubsamplerBase.h.

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

Definition at line 72 of file itkSubsamplerBase.h.

template<typename TSample >
typedef SubsamplerBase itk::Statistics::SubsamplerBase< TSample >::Self

Standard class typedefs

Definition at line 50 of file itkSubsamplerBase.h.

Definition at line 70 of file itkSubsamplerBase.h.

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

Definition at line 69 of file itkSubsamplerBase.h.

template<typename TSample >
typedef Subsample<TSample> itk::Statistics::SubsamplerBase< TSample >::SubsampleType

Definition at line 68 of file itkSubsamplerBase.h.

template<typename TSample >
typedef Object itk::Statistics::SubsamplerBase< TSample >::Superclass

Definition at line 51 of file itkSubsamplerBase.h.

Constructor & Destructor Documentation

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

Definition at line 124 of file itkSubsamplerBase.h.

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

Member Function Documentation

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

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

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

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

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

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

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

Plug in the actual sample data

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

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

template<typename TSample >
virtual LightObject::Pointer itk::Statistics::SubsamplerBase< TSample >::InternalClone ( ) const
protectedvirtual
template<typename TSample >
itk::Statistics::SubsamplerBase< TSample >::itkCloneMacro ( Self  )

implement type-specific clone method

template<typename TSample >
void itk::Statistics::SubsamplerBase< TSample >::operator= ( const Self )
private
template<typename TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::Object.

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

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

Specify whether the subsampler should return all possible matches.

Definition at line 97 of file itkSubsamplerBase.h.

References itk::Statistics::SubsamplerBase< TSample >::m_RequestMaximumNumberOfResults, and itk::Object::Modified().

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

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

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

Plug in the actual sample data

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

Referenced by itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetSeed().

Member Data Documentation

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

Definition at line 130 of file itkSubsamplerBase.h.

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

Definition at line 128 of file itkSubsamplerBase.h.

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

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