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

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

#include <itkSubsample.h>

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

[legend]Collaboration diagram for itk::Statistics::Subsample< TSample >:

[legend]List of all members.

Public Types
typedef Subsample	Self
typedef Sample< typename TSample::MeasurementVectorType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::Pointer	SamplePointer
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef TSample::MeasurementType	MeasurementType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef TSample::FrequencyType	FrequencyType
typedef TSample::TotalFrequencyType	TotalFrequencyType
typedef MeasurementVectorType	ValueType
typedef std::vector< InstanceIdentifier >	InstanceIdentifierHolder
Public Member Functions
virtual const char *	GetNameOfClass () const
const TSample *	GetSample () const
void	InitializeWithAllInstances ()
void	AddInstance (InstanceIdentifier id)
unsigned int	Size () const
void	Clear ()
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
TotalFrequencyType	GetTotalFrequency () const
void	Swap (int index1, int index2)
MeasurementVectorType	GetMeasurementVectorByIndex (int index) const
FrequencyType	GetFrequencyByIndex (int index) const
InstanceIdentifier	GetInstanceIdentifier (int index) const
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
void	SetSample (const TSample *sample)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	Subsample ()
virtual	~Subsample ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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

---

Member Typedef Documentation

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 46 of file itkSubsample.h.

template<class TSample> typedef TSample::FrequencyType itk::Statistics::Subsample< TSample >::FrequencyType

Frequency value type Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 62 of file itkSubsample.h. Referenced by itk::Statistics::Subsample< TSample >::~Subsample().

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

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 61 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 70 of file itkSubsample.h. Referenced by itk::Statistics::Subsample< TSample >::~Subsample().

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

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 60 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 Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 59 of file itkSubsample.h.

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 45 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 Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 43 of file itkSubsample.h. Referenced by itk::Statistics::Subsample< TSample >::ConstIterator::ConstIterator(), itk::Statistics::Subsample< TSample >::Iterator::Iterator(), and itk::Statistics::Subsample< TSample >::~Subsample().

template<class TSample> typedef Sample< typename TSample::MeasurementVectorType > itk::Statistics::Subsample< TSample >::Superclass

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 44 of file itkSubsample.h.

template<class TSample> typedef TSample::TotalFrequencyType itk::Statistics::Subsample< TSample >::TotalFrequencyType

Total frequency type Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 63 of file itkSubsample.h.

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

Definition at line 64 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 (   )  [inline, protected, virtual]

Definition at line 295 of file itkSubsample.h. References itk::Statistics::Subsample< TSample >::FrequencyType, itk::Statistics::Subsample< TSample >::InstanceIdentifierHolder, and itk::Statistics::Subsample< TSample >::Self.

---

Member Function Documentation

template<class TSample> void itk::Statistics::Subsample< TSample >::AddInstance (  InstanceIdentifier  id  )  [inline]

Definition at line 99 of file itkSubsample.h.

template<class TSample> ConstIterator itk::Statistics::Subsample< TSample >::Begin (  void   )  const [inline]

Definition at line 281 of file itkSubsample.h.

template<class TSample> Iterator itk::Statistics::Subsample< TSample >::Begin (  void   )  [inline]

Definition at line 269 of file itkSubsample.h.

template<class TSample> void itk::Statistics::Subsample< TSample >::Clear (  void   )  [inline]

Definition at line 112 of file itkSubsample.h.

template<class TSample> ConstIterator itk::Statistics::Subsample< TSample >::End (  void   )  const [inline]

Definition at line 287 of file itkSubsample.h.

template<class TSample> Iterator itk::Statistics::Subsample< TSample >::End (  void   )  [inline]

Definition at line 275 of file itkSubsample.h.

template<class TSample> FrequencyType itk::Statistics::Subsample< TSample >::GetFrequency (  const InstanceIdentifier &  id  )  const [inline, virtual]

returns the frequency of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 124 of file itkSubsample.h.

template<class TSample> FrequencyType itk::Statistics::Subsample< TSample >::GetFrequencyByIndex (  int  index  )  const

template<class TSample> InstanceIdentifier itk::Statistics::Subsample< TSample >::GetInstanceIdentifier (  int  index  )  const

template<class TSample> const MeasurementVectorType& itk::Statistics::Subsample< TSample >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [inline, virtual]

retunrs the measurement of the instance which is identified by the 'id' Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 120 of file itkSubsample.h.

template<class TSample> MeasurementVectorType itk::Statistics::Subsample< TSample >::GetMeasurementVectorByIndex (  int  index  )  const

template<class TSample> virtual const char* itk::Statistics::Subsample< TSample >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

template<class TSample> const TSample* itk::Statistics::Subsample< TSample >::GetSample (   )  const [inline]

Definition at line 80 of file itkSubsample.h.

template<class TSample> TotalFrequencyType itk::Statistics::Subsample< TSample >::GetTotalFrequency (   )  const [inline, virtual]

returns the total frequency for the 'd' dimension Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 128 of file itkSubsample.h.

template<class TSample> void itk::Statistics::Subsample< TSample >::InitializeWithAllInstances (   )  [inline]

Definition at line 84 of file itkSubsample.h.

template<class TSample> Pointer itk::Statistics::Subsample< TSample >::New (   )  [static]

standard New() method support Reimplemented from itk::Object.

template<class TSample> void itk::Statistics::Subsample< TSample >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::Sample< TMeasurementVector >.

template<class TSample> void itk::Statistics::Subsample< TSample >::SetSample (  const TSample *  sample  )  [inline]

Plug in the actual sample data Definition at line 73 of file itkSubsample.h.

template<class TSample> unsigned int itk::Statistics::Subsample< TSample >::Size (  void   )  const [inline, virtual]

returns SizeType object whose each element is the number of elements in each dimension Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 107 of file itkSubsample.h.

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

---

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

• itkSubsample.h

---