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<class 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).

Definition at line 41 of file itkSubsample.h.

Classes
class	ConstIterator
class	Iterator

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

Public Member Functions
void	AddInstance (InstanceIdentifier id)
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
Iterator	End ()
ConstIterator	End () const
AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const
AbsoluteFrequencyType	GetFrequencyByIndex (unsigned int index) const
virtual const InstanceIdentifierHolder &	GetIdHolder () const
InstanceIdentifier	GetInstanceIdentifier (unsigned int index)
const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const
const MeasurementVectorType &	GetMeasurementVectorByIndex (unsigned int index) const
virtual const char *	GetNameOfClass () const
const TSample *	GetSample () const
TotalAbsoluteFrequencyType	GetTotalFrequency () const
virtual void	Graft (const DataObject *thatObject)
void	InitializeWithAllInstances ()
void	SetSample (const TSample *sample)
InstanceIdentifier	Size () const
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
	Subsample ()
virtual	~Subsample ()

Private Member Functions
void	operator= (const Self &)
	Subsample (const Self &)

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

Member Typedef Documentation

template<class TSample >

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

Definition at line 67 of file itkSubsample.h.

template<class TSample >

typedef SmartPointer< const Self > itk::Statistics::Subsample< TSample >::ConstPointer

Definition at line 49 of file itkSubsample.h.

template<class TSample >

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

Definition at line 64 of file itkSubsample.h.

template<class TSample >

typedef std::vector< InstanceIdentifier > itk::Statistics::Subsample< TSample >::InstanceIdentifierHolder

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 74 of file itkSubsample.h.

template<class TSample >

typedef TSample::MeasurementType itk::Statistics::Subsample< TSample >::MeasurementType

Definition at line 63 of file itkSubsample.h.

template<class TSample >

typedef TSample::MeasurementVectorType itk::Statistics::Subsample< TSample >::MeasurementVectorType

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

Definition at line 62 of file itkSubsample.h.

template<class TSample >

typedef SmartPointer< Self > itk::Statistics::Subsample< TSample >::Pointer

Definition at line 48 of file itkSubsample.h.

template<class TSample >

typedef TSample::Pointer itk::Statistics::Subsample< TSample >::SamplePointer

Smart pointer to the actual sample data holder

Definition at line 55 of file itkSubsample.h.

template<class TSample >

typedef Subsample itk::Statistics::Subsample< TSample >::Self

Standard class typedefs

Definition at line 46 of file itkSubsample.h.

template<class TSample >

typedef TSample itk::Statistics::Subsample< TSample >::Superclass

Definition at line 47 of file itkSubsample.h.

template<class TSample >

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

Definition at line 68 of file itkSubsample.h.

template<class TSample >

typedef MeasurementVectorType itk::Statistics::Subsample< TSample >::ValueType

Definition at line 65 of file itkSubsample.h.

Constructor & Destructor Documentation

template<class TSample >

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

protected

template<class TSample >

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

inlineprotectedvirtual

Definition at line 269 of file itkSubsample.h.

template<class TSample >

itk::Statistics::Subsample< TSample >::Subsample ( const Self &  )

private

Member Function Documentation

template<class TSample >

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

(

InstanceIdentifier

id

)

Add instance to the subsample

template<class TSample >

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

inline

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

Definition at line 237 of file itkSubsample.h.

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

template<class TSample >

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

inline

Definition at line 253 of file itkSubsample.h.

template<class TSample >

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

(

)

Clear the subsample

template<class TSample >

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

(

void

)

const

template<class TSample >

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

inline

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

Definition at line 246 of file itkSubsample.h.

template<class TSample >

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

inline

Definition at line 260 of file itkSubsample.h.

template<class TSample >

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

(

InstanceIdentifier

id

)

const

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

template<class TSample >

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

(

unsigned int

index

)

const

template<class TSample >

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

inlinevirtual

Get the Id Holder

Definition at line 77 of file itkSubsample.h.

template<class TSample >

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

(

unsigned int

index

)

template<class TSample >

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

(

InstanceIdentifier

id

)

const

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

template<class TSample >

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

(

unsigned int

index

)

const

template<class TSample >

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

virtual

Run-time type information (and related methods).

template<class TSample >

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

(

)

const

template<class TSample >

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

(

)

const

returns the total frequency for the 'd' dimension

template<class TSample >

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

virtual

Method to graft another sample

template<class TSample >

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

(

)

Initialize the subsample with all instances of the sample

template<class TSample >

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

static

standard New() method support

template<class TSample >

void itk::Statistics::Subsample< TSample >::operator= ( const Self &  )

private

template<class TSample >

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

protected

template<class TSample >

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

(

const TSample *

sample

)

Plug in the actual sample data

template<class TSample >

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

(

)

const

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

template<class TSample >

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

Member Data Documentation

template<class TSample >

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

private

Definition at line 278 of file itkSubsample.h.

template<class TSample >

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

private

Definition at line 277 of file itkSubsample.h.

template<class TSample >

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

private

Definition at line 276 of file itkSubsample.h.

template<class TSample >

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

private

Definition at line 279 of file itkSubsample.h.

---

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

• itkSubsample.h