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::RegionConstrainedSubsampler< TSample, TRegion > Class Template Referenceabstract

#include <itkRegionConstrainedSubsampler.h>

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

Detailed Description

template<typename TSample, typename 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.

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 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
 
virtual const RegionTypeGetRegionConstraint () const
 
virtual const bool & GetRegionConstraintInitialized () const
 
virtual const RegionTypeGetSampleRegion () const
 
virtual const bool & GetSampleRegionInitialized () const
 
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 () 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
 
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
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

void operator= (const Self &)
 
 RegionConstrainedSubsampler (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 , typename TRegion >
typedef Superclass::Baseclass itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Baseclass

Definition at line 57 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 59 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef RegionType::IndexType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::IndexType

Definition at line 77 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef IndexType::IndexValueType itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::IndexValueType

Definition at line 78 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 68 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef SubsampleType::InstanceIdentifierHolder itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::InstanceIdentifierHolder

Definition at line 73 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 67 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 58 of file itkRegionConstrainedSubsampler.h.

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

typedefs related to image region

Definition at line 76 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef SampleType::ConstPointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SampleConstPointer

Definition at line 66 of file itkRegionConstrainedSubsampler.h.

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

typedef alias for the source data container

Definition at line 62 of file itkRegionConstrainedSubsampler.h.

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

Standard class typedefs

Definition at line 55 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 79 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef SubsampleType::ConstIterator itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsampleConstIterator

Definition at line 72 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef SubsampleType::Pointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsamplePointer

Definition at line 71 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename TRegion >
typedef Subsample<TSample> itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::SubsampleType

Definition at line 70 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 56 of file itkRegionConstrainedSubsampler.h.

Constructor & Destructor Documentation

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

Definition at line 118 of file itkRegionConstrainedSubsampler.h.

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

Member Function Documentation

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

Method to get the region constraint.

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

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

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

Method to get the sample domain.

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

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

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

Definition at line 122 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 123 of file itkRegionConstrainedSubsampler.h.

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

Definition at line 124 of file itkRegionConstrainedSubsampler.h.

template<typename TSample , typename 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: