#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 Self >	ConstPointer

typedef RegionType::IndexType	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef TSample::InstanceIdentifier	InstanceIdentifier

typedef SubsampleType::InstanceIdentifierHolder	InstanceIdentifierHolder

typedef TSample::MeasurementVectorType	MeasurementVectorType

typedef SmartPointer< Self >	Pointer

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 Self >	ConstPointer

typedef TSample::InstanceIdentifier	InstanceIdentifier

typedef SubsampleType::InstanceIdentifierHolder	InstanceIdentifierHolder

typedef TSample::MeasurementVectorType	MeasurementVectorType

typedef SmartPointer< Self >	Pointer

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 Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const char *	GetNameOfClass () const

virtual const RegionType &	GetRegionConstraint () const

virtual const bool &	GetRegionConstraintInitialized () const

virtual const RegionType &	GetSampleRegion () 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 SampleType *	GetSample () const

virtual void	SetCanSelectQuery (bool _arg)

virtual const bool &	GetCanSelectQuery () const

virtual void	CanSelectQueryOn ()

virtual void	CanSelectQueryOff ()

virtual void	SetSeed (SeedType _arg)

virtual const SeedType &	GetSeed () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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