itk::Statistics::ListSample< TMeasurementVector > Class Template Reference

This class is the native implementation of the ListSampleBase. More...

#include <itkListSample.h>

Inheritance diagram for itk::Statistics::ListSample< TMeasurementVector >:

[legend]Collaboration diagram for itk::Statistics::ListSample< TMeasurementVector >:

[legend]List of all members.

Public Types
typedef ListSample	Self
typedef ListSampleBase< TMeasurementVector >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::FrequencyType	FrequencyType
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef Superclass::SearchResultVectorType	SearchResultVectorType
typedef MeasurementVectorType	ValueType
typedef std::vector< MeasurementVectorType >	InternalDataContainerType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	Resize (unsigned int n)
void	Clear ()
void	PushBack (MeasurementVectorType mv)
unsigned int	Size () const
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
void	SetMeasurement (const InstanceIdentifier &id, const unsigned int &dim, const MeasurementType &value)
void	SetMeasurementVector (const InstanceIdentifier &id, const MeasurementVectorType &mv)
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
FrequencyType	GetTotalFrequency () const
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	ListSample ()
virtual	~ListSample ()
void	PrintSelf (std::ostream &os, Indent indent) const
Classes
class	ConstIterator
class	Iterator

---

Detailed Description

template<class TMeasurementVector>
class itk::Statistics::ListSample< TMeasurementVector >

This class is the native implementation of the ListSampleBase.

ListSampleBase stores measurements in a list type structure (as opposed to a Histogram, etc.). ListSampleBase allows duplicate measurements. ListSampleBase is not sorted.

ListSampleBase does not allow the user to specify the frequency of a measurement directly. The GetFrequency() methods returns 1 if the measurement exists in the list, 0 otherwise.

See also:

ListSampleBase, Histogram

Definition at line 46 of file itkListSample.h.

---

Member Typedef Documentation

template<class TMeasurementVector> typedef SmartPointer<const Self> itk::Statistics::ListSample< TMeasurementVector >::ConstPointer

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

template<class TMeasurementVector> typedef Superclass::FrequencyType itk::Statistics::ListSample< TMeasurementVector >::FrequencyType

Frequency value type Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 64 of file itkListSample.h.

template<class TMeasurementVector> typedef Superclass::InstanceIdentifier itk::Statistics::ListSample< TMeasurementVector >::InstanceIdentifier

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 65 of file itkListSample.h.

template<class TMeasurementVector> typedef std::vector< MeasurementVectorType > itk::Statistics::ListSample< TMeasurementVector >::InternalDataContainerType

internal data container type Definition at line 74 of file itkListSample.h.

template<class TMeasurementVector> typedef Superclass::MeasurementType itk::Statistics::ListSample< TMeasurementVector >::MeasurementType

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 63 of file itkListSample.h.

template<class TMeasurementVector> typedef Superclass::MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::MeasurementVectorType

Typedefs inherited from the superclass Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 59 of file itkListSample.h.

template<class TMeasurementVector> typedef SmartPointer< Self > itk::Statistics::ListSample< TMeasurementVector >::Pointer

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

template<class TMeasurementVector> typedef Superclass::SearchResultVectorType itk::Statistics::ListSample< TMeasurementVector >::SearchResultVectorType

Vector of InstanceIdentifiers used for returning search results. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 66 of file itkListSample.h.

template<class TMeasurementVector> typedef ListSample itk::Statistics::ListSample< TMeasurementVector >::Self

Standard class typedef. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 50 of file itkListSample.h.

template<class TMeasurementVector> typedef ListSampleBase< TMeasurementVector > itk::Statistics::ListSample< TMeasurementVector >::Superclass

Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 51 of file itkListSample.h.

template<class TMeasurementVector> typedef MeasurementVectorType itk::Statistics::ListSample< TMeasurementVector >::ValueType

Value type of a measurement (component of the measurement vector) Definition at line 70 of file itkListSample.h.

---

Constructor & Destructor Documentation

template<class TMeasurementVector> itk::Statistics::ListSample< TMeasurementVector >::ListSample (   )  [protected]

template<class TMeasurementVector> virtual itk::Statistics::ListSample< TMeasurementVector >::~ListSample (   )  [inline, protected, virtual]

Definition at line 286 of file itkListSample.h.

---

Member Function Documentation

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

returns an iterator that points to the beginning of the container Definition at line 269 of file itkListSample.h.

template<class TMeasurementVector> Iterator itk::Statistics::ListSample< TMeasurementVector >::Begin (  void   )  [inline]

returns an iterator that points to the beginning of the container Definition at line 253 of file itkListSample.h.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::Clear (  void   )  [inline]

Removes all the elements in the Sample Definition at line 85 of file itkListSample.h.

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

returns an iterator that points to the end of the container Definition at line 277 of file itkListSample.h.

template<class TMeasurementVector> Iterator itk::Statistics::ListSample< TMeasurementVector >::End (  void   )  [inline]

returns an iterator that points to the end of the container Definition at line 261 of file itkListSample.h.

template<class TMeasurementVector> FrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetFrequency (  const InstanceIdentifier &  id  )  const [virtual]

Get the frequency of a measurement. Returns 1 if the measurement exist. Implements itk::Statistics::Sample< TMeasurementVector >.

template<class TMeasurementVector> const MeasurementVectorType& itk::Statistics::ListSample< TMeasurementVector >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [virtual]

Get the measurement associated with the specified InstanceIdentifier Implements itk::Statistics::Sample< TMeasurementVector >.

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

Standard macros Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >.

template<class TMeasurementVector> FrequencyType itk::Statistics::ListSample< TMeasurementVector >::GetTotalFrequency (   )  const [inline, virtual]

Get the total frequency of the sample. This is equivalent to the size of the sample. Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 115 of file itkListSample.h.

template<class TMeasurementVector> static Pointer itk::Statistics::ListSample< TMeasurementVector >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::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::ListSampleBase< TMeasurementVector >.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::PushBack (  MeasurementVectorType  mv  )  [inline]

Inserts a measurement at the end of the list Definition at line 89 of file itkListSample.h.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::Resize (  unsigned int  n  )  [inline]

Resize the container. If this sample is connected to a Subsample or MembershipSample, then this function won't change the size of this container, instead, it will throw exception. Therefore, resize the container before using the sample in a Subsample or MembershipSample. Definition at line 81 of file itkListSample.h.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurement (  const InstanceIdentifier &  id, const unsigned int &  dim, const MeasurementType &  value )

Set a component a measurement to a particular value.

template<class TMeasurementVector> void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurementVector (  const InstanceIdentifier &  id, const MeasurementVectorType &  mv )

Replace a measurement with a different measurement

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

Get the number of measurement vectors in the sample Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 93 of file itkListSample.h.

---

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

• itkListSample.h

---