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

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 48 of file itkSpatialNeighborSubsampler.h.

Public Types

typedef Superclass::Baseclass Baseclass
 
typedef SmartPointer< const SelfConstPointer
 
typedef ImageHelper
< itkGetStaticConstMacro(ImageDimension),
itkGetStaticConstMacro(ImageDimension)> 
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 RegionType::SizeType RadiusType
 
typedef Superclass::RegionType RegionType
 
typedef
Superclass::SampleConstPointer 
SampleConstPointer
 
typedef Superclass::SampleType SampleType
 
typedef
SpatialNeighborSubsampler
< TSample, TRegion > 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
Superclass::SubsampleConstIterator 
SubsampleConstIterator
 
typedef
Superclass::SubsamplePointer 
SubsamplePointer
 
typedef Superclass::SubsampleType SubsampleType
 
typedef
RegionConstrainedSubsampler
< TSample, TRegion > 
Superclass
 
- Public Types inherited from itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >
typedef Superclass::Baseclass Baseclass
 
typedef SmartPointer< const SelfConstPointer
 
typedef RegionType::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TSample::InstanceIdentifier InstanceIdentifier
 
typedef
SubsampleType::InstanceIdentifierHolder 
InstanceIdentifierHolder
 
typedef
TSample::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef TRegion RegionType
 
typedef SampleType::ConstPointer SampleConstPointer
 
typedef TSample SampleType
 
typedef
RegionConstrainedSubsampler
< TSample, TRegion > 
Self
 
typedef RegionType::SizeType SizeType
 
typedef
SubsampleType::ConstIterator 
SubsampleConstIterator
 
typedef SubsampleType::Pointer SubsamplePointer
 
typedef Subsample< TSample > SubsampleType
 
typedef SubsamplerBase< TSample > Superclass
 
- Public Types inherited from itk::Statistics::SubsamplerBase< TSample >
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 ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual const RadiusTypeGetRadius () const
 
virtual const bool & GetRadiusInitialized () const
 
virtual void Search (const InstanceIdentifier &query, SubsamplePointer &results)
 
void SetRadius (const RadiusType &radius)
 
void SetRadius (unsigned int radius)
 
- 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
 
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
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = RegionType::ImageDimension
 

Protected Member Functions

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

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
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

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

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<typename TSample , typename TRegion >
typedef Superclass::Baseclass itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::Baseclass

Definition at line 54 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef SmartPointer<const Self> itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::ConstPointer

Definition at line 56 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef ImageHelper<itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension)> itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::ImageHelperType

other helpful typedefs

Definition at line 85 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 77 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 78 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 68 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 73 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 67 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef SmartPointer<Self> itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::Pointer

Definition at line 55 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef RegionType::SizeType itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::RadiusType

Definition at line 80 of file itkSpatialNeighborSubsampler.h.

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

typedefs related to region

Definition at line 76 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 66 of file itkSpatialNeighborSubsampler.h.

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

typedef alias for the source data container

Definition at line 62 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef SpatialNeighborSubsampler<TSample, TRegion> itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::Self

Standard class typedefs

Definition at line 52 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 79 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 72 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 71 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 70 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
typedef RegionConstrainedSubsampler<TSample, TRegion> itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::Superclass

Definition at line 53 of file itkSpatialNeighborSubsampler.h.

Constructor & Destructor Documentation

template<typename TSample , typename TRegion >
itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SpatialNeighborSubsampler ( )
protected
template<typename TSample , typename TRegion >
virtual itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::~SpatialNeighborSubsampler ( )
inlineprotectedvirtual

Definition at line 115 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SpatialNeighborSubsampler ( const Self )
private

Member Function Documentation

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

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

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

Method to get the radius

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

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

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

template<typename TSample , typename TRegion >
static Pointer itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::New ( )
static

Method for creation through the object factory.

template<typename TSample , typename TRegion >
void itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::operator= ( const Self )
private
template<typename TSample , typename TRegion >
virtual void itk::Statistics::SpatialNeighborSubsampler< 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::RegionConstrainedSubsampler< TSample, TRegion >.

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

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

Implements itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >.

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

template<typename TSample , typename TRegion >
void itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SetRadius ( const RadiusType radius)

Method to set the radius

template<typename TSample , typename TRegion >
void itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::SetRadius ( unsigned int  radius)

Method to set the radius

Member Data Documentation

template<typename TSample , typename TRegion >
const unsigned int itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::ImageDimension = RegionType::ImageDimension
static

Definition at line 82 of file itkSpatialNeighborSubsampler.h.

template<typename TSample , typename TRegion >
RadiusType itk::Statistics::SpatialNeighborSubsampler< TSample, TRegion >::m_Radius
protected

Definition at line 119 of file itkSpatialNeighborSubsampler.h.

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

Definition at line 120 of file itkSpatialNeighborSubsampler.h.


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