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:

[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 Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::FrequencyType	FrequencyType
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef std::vector< MeasurementVectorType >	InternalDataContainerType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, Superclass::MeasurementVectorSize)
void	Resize (unsigned int n)
void	PushBack (MeasurementVectorType &mv)
unsigned int	Size () const
unsigned int	Size (const unsigned int &) const
unsigned int	GetNumberOfInstances () const
MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id)
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 unsigned int &) const
Iterator	Begin ()
Iterator	End ()
Static Public Methods
Pointer	New ()
Protected Methods
	ListSample ()
virtual	~ListSample ()
void	PrintSelf (std::ostream &os, Indent indent) const
Friends
class	Iterator

---

Detailed Description

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

This class is the native implementation of the ListSampleBase.

ListSample allows duplicates of measurement vectors. It's not sorted. It doesn't allow users to set frequency. The GetFrequency(...) methods returns 1 if a measurement vector exists, else 0.

See also:

ListSampleBase, Histogram

Definition at line 42 of file itkListSample.h.

---

Member Typedef Documentation

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

frequency value typedef Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 62 of file itkListSample.h.

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

Instance Identifier typedef support this identifier will be unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 63 of file itkListSample.h.

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

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

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

typedef for each element in a measurement vector Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 61 of file itkListSample.h.

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

Superclass typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 60 of file itkListSample.h.

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Definition at line 48 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 46 of file itkListSample.h.

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

Reimplemented from itk::Statistics::ListSampleBase< TMeasurementVector >. Definition at line 47 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 199 of file itkListSample.h.

---

Member Function Documentation

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 125 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 133 of file itkListSample.h.

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

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

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

returns 1 as other subclasses of ListSampleBase does Implements itk::Statistics::Sample< TMeasurementVector >.

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

returns the measurement vector that is specified by the instance identifier argument. Implements itk::Statistics::Sample< TMeasurementVector >.

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

returns the number of measurement vectors int this container Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 95 of file itkListSample.h.

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

returns the size of this container Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 117 of file itkListSample.h.

template<class TMeasurementVector> itk::Statistics::ListSample< TMeasurementVector >::itkStaticConstMacro (  MeasurementVectorSize   , unsigned    int, Superclass::MeasurementVectorSize    )

VMeasurementVectorSize template argument alias

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

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

inserts a new element at the end Definition at line 80 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 Subsample or MembershipSample, then this function won't change the size of this container, instead, it will throw exception. Before, use this sample with Subsample or MembershipSample, set the size Definition at line 76 of file itkListSample.h.

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

sets the "dim" dimensional component value of the measurement vector that is specified by "id".

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

set the measurement vector value that is specified by the instance identifier argument.

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

returns the number of measurement vectors int this container. The size of each dimension in any subclass of ListSampleBase doen't vary. However, the dimension's size of histogram can be different from other dimensions Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 91 of file itkListSample.h.

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

returns the number of measurement vectors in this container Implements itk::Statistics::Sample< TMeasurementVector >. Definition at line 84 of file itkListSample.h.

---

Friends And Related Function Documentation

template<class TMeasurementVector> friend class Iterator [friend]

Definition at line 122 of file itkListSample.h.

---

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

• itkListSample.h

---