itk::Statistics::Subsample< TSample > Class Template Reference

#include <itkSubsample.h>

Inheritance diagram for itk::Statistics::Subsample< TSample >:

Collaboration diagram for itk::Statistics::Subsample< TSample >:

Detailed Description

template<typename TSample>
class itk::Statistics::Subsample< TSample >

This class stores a subset of instance identifiers from another sample object. You can create a subsample out of another sample object or another subsample object. The class is useful when storing or extracting a portion of a sample object. Note that when the elements of a subsample are sorted, the instance identifiers of the subsample are sorted without changing the original source sample. Most Statistics algorithms (that derive from StatisticsAlgorithmBase accept Subsample objects as inputs).

Examples:

Examples/Statistics/BayesianPluginClassifier.cxx, Examples/Statistics/SampleSorting.cxx, and Examples/Statistics/Subsample.cxx.

Definition at line 41 of file itkSubsample.h.

Classes
class	ConstIterator
class	Iterator

Public Types
using	AbsoluteFrequencyType = typename TSample::AbsoluteFrequencyType
using	ConstPointer = SmartPointer< const Self >
using	InstanceIdentifier = typename TSample::InstanceIdentifier
using	InstanceIdentifierHolder = std::vector< InstanceIdentifier >
using	MeasurementType = typename TSample::MeasurementType
using	MeasurementVectorType = typename TSample::MeasurementVectorType
using	Pointer = SmartPointer< Self >
using	SamplePointer = typename TSample::Pointer
using	Self = Subsample
using	Superclass = TSample
using	TotalAbsoluteFrequencyType = typename TSample::TotalAbsoluteFrequencyType
using	ValueType = MeasurementVectorType

Public Member Functions
void	AddInstance (InstanceIdentifier id)
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
Iterator	End ()
ConstIterator	End () const
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const override
AbsoluteFrequencyType	GetFrequencyByIndex (unsigned int index) const
const InstanceIdentifierHolder &	GetIdHolder () const
InstanceIdentifier	GetInstanceIdentifier (unsigned int index)
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const override
const MeasurementVectorType &	GetMeasurementVectorByIndex (unsigned int index) const
virtual const char *	GetNameOfClass () const
const TSample *	GetSample () const
TotalAbsoluteFrequencyType	GetTotalFrequency () const override
void	Graft (const DataObject *thatObject) override
void	InitializeWithAllInstances ()
void	SetSample (const TSample *sample)
InstanceIdentifier	Size () const override
void	Swap (unsigned int index1, unsigned int index2)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override
	Subsample ()
	~Subsample () override=default

Private Attributes
unsigned int	m_ActiveDimension
InstanceIdentifierHolder	m_IdHolder
const TSample *	m_Sample
TotalAbsoluteFrequencyType	m_TotalFrequency

Member Typedef Documentation

template<typename TSample >

using itk::Statistics::Subsample< TSample >::AbsoluteFrequencyType = typename TSample::AbsoluteFrequencyType

Definition at line 69 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::ConstPointer = SmartPointer< const Self >

Definition at line 51 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::InstanceIdentifier = typename TSample::InstanceIdentifier

Definition at line 66 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::InstanceIdentifierHolder = std::vector< InstanceIdentifier >

Type of the storage for instances that belong to the class represented by a Subsample object. A Subsample object stores only the InstanceIdentifiers. The actual data is still in the Sample object

Definition at line 76 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::MeasurementType = typename TSample::MeasurementType

Definition at line 65 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::MeasurementVectorType = typename TSample::MeasurementVectorType

Typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value from the template argument TSample

Definition at line 64 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::Pointer = SmartPointer< Self >

Definition at line 50 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::SamplePointer = typename TSample::Pointer

Smart pointer to the actual sample data holder

Definition at line 60 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::Self = Subsample

Standard class type aliases

Definition at line 48 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::Superclass = TSample

Definition at line 49 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::TotalAbsoluteFrequencyType = typename TSample::TotalAbsoluteFrequencyType

Definition at line 70 of file itkSubsample.h.

template<typename TSample >

using itk::Statistics::Subsample< TSample >::ValueType = MeasurementVectorType

Definition at line 67 of file itkSubsample.h.

Constructor & Destructor Documentation

template<typename TSample >

itk::Statistics::Subsample< TSample >::Subsample ( )

protected

template<typename TSample >

itk::Statistics::Subsample< TSample >::~Subsample ( )

overrideprotecteddefault

Member Function Documentation

template<typename TSample >

void itk::Statistics::Subsample< TSample >::AddInstance

(

InstanceIdentifier

id

)

Add instance to the subsample

template<typename TSample >

Iterator itk::Statistics::Subsample< TSample >::Begin ( )

inline

This method returns an iterator to the beginning of the measurement vectors

Definition at line 254 of file itkSubsample.h.

Referenced by itk::Statistics::Subsample< TSample >::ConstIterator::ConstIterator().

template<typename TSample >

ConstIterator itk::Statistics::Subsample< TSample >::Begin ( ) const

inline

Definition at line 270 of file itkSubsample.h.

template<typename TSample >

void itk::Statistics::Subsample< TSample >::Clear

(

)

Clear the subsample

Examples:

Examples/Statistics/SampleSorting.cxx.

template<typename TSample >

virtual::itk::LightObject::Pointer itk::Statistics::Subsample< TSample >::CreateAnother

(

)

const

template<typename TSample >

Iterator itk::Statistics::Subsample< TSample >::End ( )

inline

This method returns an iterator to the beginning of the measurement vectors

Definition at line 263 of file itkSubsample.h.

template<typename TSample >

ConstIterator itk::Statistics::Subsample< TSample >::End ( ) const

inline

Definition at line 277 of file itkSubsample.h.

template<typename TSample >

AbsoluteFrequencyType itk::Statistics::Subsample< TSample >::GetFrequency ( InstanceIdentifier  id ) const

override

returns the frequency of the instance which is identified by the 'id'

template<typename TSample >

AbsoluteFrequencyType itk::Statistics::Subsample< TSample >::GetFrequencyByIndex

(

unsigned int

index

)

const

template<typename TSample >

const InstanceIdentifierHolder& itk::Statistics::Subsample< TSample >::GetIdHolder ( ) const

inline

Get the Id Holder

Definition at line 88 of file itkSubsample.h.

template<typename TSample >

InstanceIdentifier itk::Statistics::Subsample< TSample >::GetInstanceIdentifier

(

unsigned int

index

)

template<typename TSample >

const MeasurementVectorType& itk::Statistics::Subsample< TSample >::GetMeasurementVector ( InstanceIdentifier  id ) const

override

returns the measurement of the instance which is identified by the 'id'

template<typename TSample >

const MeasurementVectorType& itk::Statistics::Subsample< TSample >::GetMeasurementVectorByIndex

(

unsigned int

index

)

const

template<typename TSample >

virtual const char* itk::Statistics::Subsample< TSample >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

template<typename TSample >

const TSample* itk::Statistics::Subsample< TSample >::GetSample

(

)

const

template<typename TSample >

TotalAbsoluteFrequencyType itk::Statistics::Subsample< TSample >::GetTotalFrequency ( ) const

override

returns the total frequency for the 'd' dimension

template<typename TSample >

void itk::Statistics::Subsample< TSample >::Graft ( const DataObject *  thatObject )

override

Method to graft another sample

template<typename TSample >

void itk::Statistics::Subsample< TSample >::InitializeWithAllInstances

(

)

Initialize the subsample with all instances of the sample

template<typename TSample >

static Pointer itk::Statistics::Subsample< TSample >::New ( )

static

standard New() method support

template<typename TSample >

void itk::Statistics::Subsample< TSample >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

template<typename TSample >

void itk::Statistics::Subsample< TSample >::SetSample

(

const TSample *

sample

)

Plug in the actual sample data

template<typename TSample >

InstanceIdentifier itk::Statistics::Subsample< TSample >::Size ( ) const

override

returns SizeType object whose each element is the number of elements in each dimension

template<typename TSample >

void itk::Statistics::Subsample< TSample >::Swap	(	unsigned int	index1,
		unsigned int	index2
	)

Member Data Documentation

template<typename TSample >

unsigned int itk::Statistics::Subsample< TSample >::m_ActiveDimension

private

Definition at line 292 of file itkSubsample.h.

template<typename TSample >

InstanceIdentifierHolder itk::Statistics::Subsample< TSample >::m_IdHolder

private

Definition at line 291 of file itkSubsample.h.

template<typename TSample >

const TSample* itk::Statistics::Subsample< TSample >::m_Sample

private

Definition at line 290 of file itkSubsample.h.

template<typename TSample >

TotalAbsoluteFrequencyType itk::Statistics::Subsample< TSample >::m_TotalFrequency

private

Definition at line 293 of file itkSubsample.h.

---

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

• itkSubsample.h