ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::Statistics::SubsamplerBase< TSample > Class Template Reference
Module ITKStatistics

#include <itkSubsamplerBase.h>

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

List of all members.

Public Types

typedef Self Baseclass
typedef SmartPointer< const Self > ConstPointer
typedef TSample::InstanceIdentifier InstanceIdentifier
typedef
SubsampleType::InstanceIdentifierHolder 		InstanceIdentifierHolder
typedef
TSample::MeasurementVectorType 		MeasurementVectorType
typedef SmartPointer< Self > Pointer
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
- Public Types inherited from itk::LightObject

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 SampleType * GetSample ()
virtual void SetCanSelectQuery (bool _arg)
virtual const bool & GetCanSelectQuery ()
virtual void CanSelectQueryOn ()
virtual void CanSelectQueryOff ()
virtual void SetSeed (SeedType _arg)
virtual const SeedType & GetSeed ()
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
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long 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
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
void Print (std::ostream &os, Indent indent=0) const

Protected Member Functions

virtual LightObject::Pointer InternalClone () const
virtual void PrintSelf (std::ostream &os, Indent indent) const
 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

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

Detailed Description

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

Member Typedef Documentation

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

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

Definition at line 52 of file itkSubsamplerBase.h.

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

Reimplemented from itk::Object.

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

Definition at line 54 of file itkSubsamplerBase.h.

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

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

Definition at line 66 of file itkSubsamplerBase.h.

template<class TSample >
typedef SubsampleType::InstanceIdentifierHolder itk::Statistics::SubsamplerBase< TSample >::InstanceIdentifierHolder

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

Definition at line 71 of file itkSubsamplerBase.h.

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

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

Definition at line 65 of file itkSubsamplerBase.h.

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

Reimplemented from itk::Object.

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

Definition at line 53 of file itkSubsamplerBase.h.

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

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

Definition at line 64 of file itkSubsamplerBase.h.

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

typedef alias for the source data container

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

Definition at line 63 of file itkSubsamplerBase.h.

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

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

Definition at line 72 of file itkSubsamplerBase.h.

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

Standard class typedefs

Reimplemented from itk::Object.

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

Definition at line 50 of file itkSubsamplerBase.h.

template<class TSample >
typedef SubsampleType::ConstIterator itk::Statistics::SubsamplerBase< TSample >::SubsampleConstIterator

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

Definition at line 70 of file itkSubsamplerBase.h.

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

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

Definition at line 69 of file itkSubsamplerBase.h.

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

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

Definition at line 68 of file itkSubsamplerBase.h.

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

Reimplemented from itk::Object.

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

Definition at line 51 of file itkSubsamplerBase.h.

Constructor & Destructor Documentation

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

Definition at line 124 of file itkSubsamplerBase.h.

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

Member Function Documentation

template<class 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<class 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<class TSample >
virtual const bool& itk::Statistics::SubsamplerBase< TSample >::GetCanSelectQuery ( )
virtual

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

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

Run-time type information (and related methods)

Reimplemented from itk::Object.

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

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

Plug in the actual sample data

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

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

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

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

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

implement type-specific clone method

Reimplemented from itk::LightObject.

template<class TSample >
void itk::Statistics::SubsamplerBase< TSample >::operator= ( const Self &  )
private

Mutex lock to protect modification to the reference count

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

template<class 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<class 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<class TSample >
virtual void itk::Statistics::SubsamplerBase< TSample >::SetSample ( const SampleType *  _arg)
virtual

Plug in the actual sample data

template<class 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

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

Definition at line 130 of file itkSubsamplerBase.h.

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

Definition at line 129 of file itkSubsamplerBase.h.

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

Definition at line 128 of file itkSubsamplerBase.h.

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

Definition at line 131 of file itkSubsamplerBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:34:14 for ITK by doxygen 1.8.1