ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion > Class Template Reference

#include <itkUniformRandomSpatialNeighborSubsampler.h>

+ Inheritance diagram for itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >:
+ Collaboration diagram for itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >:

List of all members.

Public Types

typedef Superclass::Baseclass Baseclass
typedef SmartPointer< const SelfConstPointer
typedef Superclass::ImageHelperType ImageHelperType
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef
Superclass::InstanceIdentifier 
InstanceIdentifier
typedef
Superclass::InstanceIdentifierHolder 
InstanceIdentifierHolder
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef
itk::Statistics::MersenneTwisterRandomVariateGenerator 
RandomGeneratorType
typedef unsigned int RandomIntType
typedef Superclass::RegionType RegionType
typedef
Superclass::SampleConstPointer 
SampleConstPointer
typedef Superclass::SampleType SampleType
typedef unsigned long SearchSizeType
typedef Baseclass::SeedType SeedType
typedef
UniformRandomSpatialNeighborSubsampler
< TSample, TRegion > 
Self
typedef Superclass::SizeType SizeType
typedef
Superclass::SubsampleConstIterator 
SubsampleConstIterator
typedef
Superclass::SubsamplePointer 
SubsamplePointer
typedef Superclass::SubsampleType SubsampleType
typedef
SpatialNeighborSubsampler
< TSample, TRegion > 
Superclass
- Public Types inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
- Public Types inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
- Public Types inherited from itk::Statistics::SubsamplerBase< TSample >
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual SearchSizeType GetNumberOfResultsRequested () const
virtual bool GetUseClockForSeed () const
virtual void Search (const InstanceIdentifier &query, SubsamplePointer &results)
virtual void SetNumberOfResultsRequested (const SearchSizeType &numberRequested)
virtual void SetSeed (const SeedType seed)
virtual void SetUseClockForSeed (const bool &useClock)
virtual void UseClockForSeedOff ()
virtual void UseClockForSeedOn ()
- Public Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
virtual const RadiusTypeGetRadius ()
virtual const bool & GetRadiusInitialized ()
void SetRadius (const RadiusType &radius)
void SetRadius (unsigned int radius)
- Public Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
virtual const RegionTypeGetRegionConstraint ()
virtual const bool & GetRegionConstraintInitialized ()
virtual const RegionTypeGetSampleRegion ()
virtual const bool & GetSampleRegionInitialized ()
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 ()
virtual void SetCanSelectQuery (bool _arg)
virtual const bool & GetCanSelectQuery ()
virtual void CanSelectQueryOn ()
virtual void CanSelectQueryOff ()
virtual const SeedTypeGetSeed ()
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 void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
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

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual RandomIntType GetIntegerVariate (RandomIntType lowerBound, RandomIntType upperBound, RandomIntType)
virtual LightObject::Pointer InternalClone () const
virtual void PrintSelf (std::ostream &os, Indent indent) const
 UniformRandomSpatialNeighborSubsampler ()
virtual ~UniformRandomSpatialNeighborSubsampler ()
- Protected Member Functions inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
 SpatialNeighborSubsampler ()
virtual ~SpatialNeighborSubsampler ()
- Protected Member Functions inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
 RegionConstrainedSubsampler ()
virtual ~RegionConstrainedSubsampler ()
- Protected Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
 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

SearchSizeType m_NumberOfResultsRequested
RandomGeneratorType::Pointer m_RandomNumberGenerator
bool m_UseClockForSeed
- Protected Attributes inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
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

Private Member Functions

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

Additional Inherited Members

- Static Public Attributes inherited from itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >
static const unsigned int ImageDimension = RegionType::ImageDimension

Detailed Description

template<class TSample, class TRegion>
class itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >

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

This class derives from SpatialNeighborSubsampler and randomly selects points according to a uniform distribution within the Radius given by SetRadius(radius) as long as that point is also within the RegionConstraint.

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
SpatialNeighborSubsampler
GaussianRandomSpatialNeighborSubsampler

Definition at line 46 of file itkUniformRandomSpatialNeighborSubsampler.h.


Member Typedef Documentation

template<class TSample , class TRegion >
typedef Superclass::Baseclass itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Baseclass
template<class TSample , class TRegion >
typedef SmartPointer<const Self> itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::ConstPointer
template<class TSample , class TRegion >
typedef Superclass::ImageHelperType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::ImageHelperType
template<class TSample , class TRegion >
typedef Superclass::IndexType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::IndexType
template<class TSample , class TRegion >
typedef Superclass::IndexValueType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::IndexValueType
template<class TSample , class TRegion >
typedef Superclass::InstanceIdentifier itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::InstanceIdentifier
template<class TSample , class TRegion >
typedef Superclass::InstanceIdentifierHolder itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::InstanceIdentifierHolder
template<class TSample , class TRegion >
typedef Superclass::MeasurementVectorType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::MeasurementVectorType
template<class TSample , class TRegion >
typedef SmartPointer<Self> itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Pointer
template<class TSample , class TRegion >
typedef Superclass::RadiusType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RadiusType

typedefs related to random variate generator

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

Definition at line 87 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
typedef unsigned int itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RandomIntType
template<class TSample , class TRegion >
typedef Superclass::RegionType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::RegionType
template<class TSample , class TRegion >
typedef Superclass::SampleConstPointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SampleConstPointer
template<class TSample , class TRegion >
typedef Superclass::SampleType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SampleType
template<class TSample , class TRegion >
typedef unsigned long itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SearchSizeType
template<class TSample , class TRegion >
typedef Baseclass::SeedType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SeedType
template<class TSample , class TRegion >
typedef UniformRandomSpatialNeighborSubsampler<TSample, TRegion> itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Self
template<class TSample , class TRegion >
typedef Superclass::SizeType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SizeType
template<class TSample , class TRegion >
typedef Superclass::SubsampleConstIterator itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SubsampleConstIterator
template<class TSample , class TRegion >
typedef Superclass::SubsamplePointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SubsamplePointer
template<class TSample , class TRegion >
typedef Superclass::SubsampleType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SubsampleType
template<class TSample , class TRegion >
typedef SpatialNeighborSubsampler<TSample, TRegion> itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Superclass

Constructor & Destructor Documentation

template<class TSample , class TRegion >
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UniformRandomSpatialNeighborSubsampler ( )
protected
template<class TSample , class TRegion >
virtual itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::~UniformRandomSpatialNeighborSubsampler ( )
inlineprotectedvirtual

Definition at line 141 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UniformRandomSpatialNeighborSubsampler ( const Self )
private

Member Function Documentation

template<class TSample , class TRegion >
virtual::itk::LightObject::Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::CreateAnother ( void  ) 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::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

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

template<class TSample , class TRegion >
virtual RandomIntType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetIntegerVariate ( RandomIntType  lowerBound,
RandomIntType  upperBound,
RandomIntType   
)
protectedvirtual

method to randomly generate an integer in the closed range [lowerBound, upperBound] using a uniform sampling selection method. override this method to do gaussian selection

template<class TSample , class TRegion >
virtual const char* itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetNameOfClass ( ) const
virtual
template<class TSample , class TRegion >
virtual SearchSizeType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetNumberOfResultsRequested ( ) const
virtual
template<class TSample , class TRegion >
virtual bool itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::GetUseClockForSeed ( ) const
virtual
template<class TSample , class TRegion >
virtual LightObject::Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::InternalClone ( ) const
protectedvirtual

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

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

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

template<class TSample , class TRegion >
static Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::New ( )
static
template<class TSample , class TRegion >
void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::operator= ( const Self )
private

Mutex lock to protect modification to the reference count

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

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

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::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::Statistics::SpatialNeighborSubsampler< TSample, TRegion >.

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

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::Search ( const InstanceIdentifier query,
SubsamplePointer results 
)
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.

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

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetNumberOfResultsRequested ( const SearchSizeType numberRequested)
inlinevirtual

Definition at line 111 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetSeed ( const SeedType  _arg)
inlinevirtual

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

Reimplemented from itk::Statistics::SubsamplerBase< TSample >.

Definition at line 89 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetUseClockForSeed ( const bool &  useClock)
inlinevirtual

Definition at line 95 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UseClockForSeedOff ( )
virtual
template<class TSample , class TRegion >
virtual void itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::UseClockForSeedOn ( )
virtual

Member Data Documentation

template<class TSample , class TRegion >
SearchSizeType itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_NumberOfResultsRequested
protected

Definition at line 153 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
RandomGeneratorType::Pointer itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_RandomNumberGenerator
protected

Definition at line 154 of file itkUniformRandomSpatialNeighborSubsampler.h.

template<class TSample , class TRegion >
bool itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::m_UseClockForSeed
protected

Definition at line 155 of file itkUniformRandomSpatialNeighborSubsampler.h.


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