Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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 >:

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

Collaboration graph
[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 * GetClassName () const
 itkStaticConstMacro (MeasurementVectorSize, unsigned int, Superclass::MeasurementVectorSize)
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

Pointer New ()

Protected Member Functions

 ListSample ()
virtual ~ListSample ()
void PrintSelf (std::ostream &os, Indent indent) const

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 SmartPointer<const Self> itk::Statistics::ListSample< TMeasurementVector >::ConstPointer
 

Reimplemented from itk::Statistics::Sample< TMeasurementVector >.

Definition at line 49 of file itkListSample.h.

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

frequency value typedef

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

Definition at line 63 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 64 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
 

typedef for each element in a measurement vector

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

Definition at line 62 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 61 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 Superclass::SearchResultVectorType itk::Statistics::ListSample< TMeasurementVector >::SearchResultVectorType
 

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

Definition at line 65 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.

Referenced by itk::Statistics::ListSample< TMeasurementVector >::~ListSample().

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.

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

Definition at line 67 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 285 of file itkListSample.h.

References itk::Statistics::ListSample< TMeasurementVector >::Self.


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 268 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 252 of file itkListSample.h.

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

Removes all the elements

Definition at line 84 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 276 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 260 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>
const MeasurementVectorType& itk::Statistics::ListSample< TMeasurementVector >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [virtual]
 

returns the measurement vector that is specified by the instance identifier argument.

Implements itk::Statistics::Sample< TMeasurementVector >.

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

returns the size of this container

Implements itk::Statistics::Sample< TMeasurementVector >.

Definition at line 114 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 88 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 80 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 (  void   )  const [inline, virtual]
 

returns the number of measurement vectors in this container

Implements itk::Statistics::Sample< TMeasurementVector >.

Definition at line 92 of file itkListSample.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 30 01:38:45 2005 for ITK by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2000