ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | 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 >:

Public Types

using Baseclass = typename Superclass::Baseclass
 
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename RegionType::IndexType
 
using IndexValueType = typename IndexType::IndexValueType
 
using InstanceIdentifier = typename TSample::InstanceIdentifier
 
using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder
 
using MeasurementVectorType = typename TSample::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using RegionType = TRegion
 
using SampleConstPointer = typename SampleType::ConstPointer
 
using SampleType = TSample
 
using Self = RegionConstrainedSubsampler< TSample, TRegion >
 
using SizeType = typename RegionType::SizeType
 
using SubsampleConstIterator = typename SubsampleType::ConstIterator
 
using SubsamplePointer = typename SubsampleType::Pointer
 
using SubsampleType = Subsample< TSample >
 
using Superclass = SubsamplerBase< TSample >
 
- Public Types inherited from itk::Statistics::SubsamplerBase< TSample >
using Baseclass = Self
 
using ConstPointer = SmartPointer< const Self >
 
using InstanceIdentifier = typename TSample::InstanceIdentifier
 
using InstanceIdentifierHolder = typename SubsampleType::InstanceIdentifierHolder
 
using MeasurementVectorType = typename TSample::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using SampleConstPointer = typename SampleType::ConstPointer
 
using SampleType = TSample
 
using SeedType = unsigned int
 
using Self = SubsamplerBase
 
using SubsampleConstIterator = typename SubsampleType::ConstIterator
 
using SubsamplePointer = typename SubsampleType::Pointer
 
using SubsampleType = Subsample< TSample >
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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
 
void Search (const InstanceIdentifier &query, SubsamplePointer &results) override=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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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

LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegionConstrainedSubsampler ()
 
 ~RegionConstrainedSubsampler () override=default
 
- Protected Member Functions inherited from itk::Statistics::SubsamplerBase< TSample >
LightObject::Pointer InternalClone () const override
 
 SubsamplerBase ()
 
 ~SubsamplerBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 >
SampleConstPointer m_Sample
 
bool m_RequestMaximumNumberOfResults
 
bool m_CanSelectQuery
 
SeedType m_Seed
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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

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 54 of file itkRegionConstrainedSubsampler.h.

Member Typedef Documentation

◆ Baseclass

template<typename TSample , typename TRegion >
using itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::Baseclass = typename Superclass::Baseclass

Definition at line 62 of file itkRegionConstrainedSubsampler.h.

◆ ConstPointer

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

Definition at line 64 of file itkRegionConstrainedSubsampler.h.

◆ IndexType

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

Definition at line 82 of file itkRegionConstrainedSubsampler.h.

◆ IndexValueType

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

Definition at line 83 of file itkRegionConstrainedSubsampler.h.

◆ InstanceIdentifier

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

Definition at line 73 of file itkRegionConstrainedSubsampler.h.

◆ InstanceIdentifierHolder

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

Definition at line 78 of file itkRegionConstrainedSubsampler.h.

◆ MeasurementVectorType

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

Definition at line 72 of file itkRegionConstrainedSubsampler.h.

◆ Pointer

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

Definition at line 63 of file itkRegionConstrainedSubsampler.h.

◆ RegionType

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

type alias related to image region

Definition at line 81 of file itkRegionConstrainedSubsampler.h.

◆ SampleConstPointer

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

Definition at line 71 of file itkRegionConstrainedSubsampler.h.

◆ SampleType

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

type alias alias for the source data container

Definition at line 70 of file itkRegionConstrainedSubsampler.h.

◆ Self

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

Standard class type aliases

Definition at line 60 of file itkRegionConstrainedSubsampler.h.

◆ SizeType

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

Definition at line 84 of file itkRegionConstrainedSubsampler.h.

◆ SubsampleConstIterator

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

Definition at line 77 of file itkRegionConstrainedSubsampler.h.

◆ SubsamplePointer

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

Definition at line 76 of file itkRegionConstrainedSubsampler.h.

◆ SubsampleType

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

Definition at line 75 of file itkRegionConstrainedSubsampler.h.

◆ Superclass

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

Definition at line 61 of file itkRegionConstrainedSubsampler.h.

Constructor & Destructor Documentation

◆ RegionConstrainedSubsampler()

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

◆ ~RegionConstrainedSubsampler()

template<typename TSample , typename TRegion >
itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::~RegionConstrainedSubsampler ( )
overrideprotecteddefault

Member Function Documentation

◆ GetNameOfClass()

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

◆ GetRegionConstraint()

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

Method to get the region constraint.

◆ GetRegionConstraintInitialized()

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

◆ GetSampleRegion()

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

Method to get the sample domain.

◆ GetSampleRegionInitialized()

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

◆ InternalClone()

template<typename TSample , typename TRegion >
LightObject::Pointer itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::InternalClone ( ) const
overrideprotectedvirtual

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

◆ PrintSelf()

template<typename TSample , typename TRegion >
void itk::Statistics::RegionConstrainedSubsampler< TSample, TRegion >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

◆ Search()

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

◆ SetRegionConstraint()

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.

◆ SetSampleRegion()

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

◆ m_RegionConstraint

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

Definition at line 131 of file itkRegionConstrainedSubsampler.h.

◆ m_RegionConstraintInitialized

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

Definition at line 132 of file itkRegionConstrainedSubsampler.h.

◆ m_SampleRegion

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

Definition at line 133 of file itkRegionConstrainedSubsampler.h.

◆ m_SampleRegionInitialized

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

Definition at line 134 of file itkRegionConstrainedSubsampler.h.


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