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

#include <itkRegionConstrainedSubsampler.h>

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

List of all members.

Public Types

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 unsigned int SeedType
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual const char * GetNameOfClass () const
virtual const RegionTypeGetRegionConstraint ()
virtual const bool & GetRegionConstraintInitialized ()
virtual const RegionTypeGetSampleRegion ()
virtual const bool & GetSampleRegionInitialized ()
virtual void Search (const InstanceIdentifier &query, SubsamplePointer &results)=0
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 void SetSeed (SeedType _arg)
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 LightObject::Pointer CreateAnother () 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

Protected Member Functions

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

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 &)
 RegionConstrainedSubsampler (const Self &)

Detailed Description

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

This an abstract subsampler that constrains subsamples to be contained within a given image region.

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.

This class is templatized over both the Sample and the Region with an assumed consistency between the Region and the way the Sample is generated.

Use SetRegionConstraint(region) to provide the region constraint. All returned subsamples will be contained within this region. This assumes that the instance identifiers in the sample correspond to an offset computed with the provided region.

See also:
SubsamplerBase, SpatialNeighborSubsampler
GaussianRandomSpatialNeighborSubsampler
UniformRandomSpatialNeighborSubsampler

Definition at line 51 of file itkRegionConstrainedSubsampler.h.


Member Typedef Documentation

template<class TSample , class TRegion >
typedef Superclass::Baseclass itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Baseclass
template<class TSample , class TRegion >
typedef SmartPointer<const Self> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::ConstPointer
template<class TSample , class TRegion >
typedef RegionType::IndexType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::IndexType
template<class TSample , class TRegion >
typedef IndexType::IndexValueType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::IndexValueType
template<class TSample , class TRegion >
typedef TSample::InstanceIdentifier itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::InstanceIdentifier
template<class TSample , class TRegion >
typedef SubsampleType::InstanceIdentifierHolder itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::InstanceIdentifierHolder
template<class TSample , class TRegion >
typedef TSample::MeasurementVectorType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::MeasurementVectorType
template<class TSample , class TRegion >
typedef SmartPointer<Self> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Pointer
template<class TSample , class TRegion >
typedef TRegion itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::RegionType
template<class TSample , class TRegion >
typedef SampleType::ConstPointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SampleConstPointer
template<class TSample , class TRegion >
typedef TSample itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SampleType
template<class TSample , class TRegion >
typedef RegionConstrainedSubsampler<TSample, TRegion> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Self
template<class TSample , class TRegion >
typedef RegionType::SizeType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SizeType
template<class TSample , class TRegion >
typedef SubsampleType::ConstIterator itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsampleConstIterator
template<class TSample , class TRegion >
typedef SubsampleType::Pointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsamplePointer
template<class TSample , class TRegion >
typedef Subsample<TSample> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsampleType
template<class TSample , class TRegion >
typedef SubsamplerBase<TSample> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Superclass

Constructor & Destructor Documentation

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

Definition at line 118 of file itkRegionConstrainedSubsampler.h.

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

Member Function Documentation

template<class TSample , class TRegion >
virtual const char* itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::GetNameOfClass ( ) const
virtual
template<class TSample , class TRegion >
virtual const RegionType& itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::GetRegionConstraint ( )
virtual

Method to get the region constraint.

template<class TSample , class TRegion >
virtual const bool& itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::GetRegionConstraintInitialized ( )
virtual

Method to get the flag indicating that the region constraint has been initialized

template<class TSample , class TRegion >
virtual const RegionType& itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::GetSampleRegion ( )
virtual

Method to get the sample domain.

template<class TSample , class TRegion >
virtual const bool& itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::GetSampleRegionInitialized ( )
virtual

Method to get the flag indicating that the sample region has been initialized

template<class TSample , class TRegion >
virtual LightObject::Pointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::InternalClone ( ) const
protectedvirtual
template<class TSample , class TRegion >
void itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::operator= ( const Self )
private
template<class TSample , class TRegion >
virtual void itk::Statistics::RegionConstrainedSubsampler< 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::SubsamplerBase< TSample >.

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

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

Implements itk::Statistics::SubsamplerBase< TSample >.

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

template<class TSample , class TRegion >
void itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SetRegionConstraint ( const RegionType region)

Method to set the region constraint. Any subsamples selected must ALSO be inside this region.

template<class TSample , class TRegion >
void itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SetSampleRegion ( const RegionType region)

Method to set the sample domain. This should correspond to the entire region of the input sample.


Member Data Documentation

template<class TSample , class TRegion >
RegionType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::m_RegionConstraint
protected

Definition at line 122 of file itkRegionConstrainedSubsampler.h.

template<class TSample , class TRegion >
bool itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::m_RegionConstraintInitialized
protected

Definition at line 123 of file itkRegionConstrainedSubsampler.h.

template<class TSample , class TRegion >
RegionType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::m_SampleRegion
protected

Definition at line 124 of file itkRegionConstrainedSubsampler.h.

template<class TSample , class TRegion >
bool itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::m_SampleRegionInitialized
protected

Definition at line 125 of file itkRegionConstrainedSubsampler.h.


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