ITK  4.0.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::Statistics::ListSample< TMeasurementVector > Class Template Reference
Module ITKStatistics

This class is the native implementation of the a Sample with an STL container. More...

#include <itkListSample.h>

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

List of all members.

Classes

class  ConstIterator
 Const Iterator. More...
class  Iterator
 Iterator. More...

Public Types

typedef
Superclass::AbsoluteFrequencyType 		AbsoluteFrequencyType
typedef SmartPointer< const Self > ConstPointer
typedef
Superclass::InstanceIdentifier 		InstanceIdentifier
typedef std::vector
< MeasurementVectorType > 		InternalDataContainerType
typedef Superclass::MeasurementType MeasurementType
typedef
Superclass::MeasurementVectorSizeType 		MeasurementVectorSizeType
typedef
Superclass::MeasurementVectorType 		MeasurementVectorType
typedef SmartPointer< Self > Pointer
typedef ListSample Self
typedef Sample
< TMeasurementVector > 		Superclass
typedef
Superclass::TotalAbsoluteFrequencyType 		TotalAbsoluteFrequencyType
typedef MeasurementVectorType ValueType

Public Member Functions

Iterator Begin ()
ConstIterator Begin () const
void Clear ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
ConstIterator End () const
Iterator End ()
AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const
const MeasurementVectorType & GetMeasurementVector (InstanceIdentifier id) const
virtual const char * GetNameOfClass () const
TotalAbsoluteFrequencyType GetTotalFrequency () const
virtual void Graft (const DataObject *thatObject)
void PushBack (const MeasurementVectorType &mv)
void Resize (InstanceIdentifier newsize)
void SetMeasurement (InstanceIdentifier id, unsigned int dim, const MeasurementType &value)
void SetMeasurementVector (InstanceIdentifier id, const MeasurementVectorType &mv)
InstanceIdentifier Size () const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Private Member Functions

 ListSample (const Self &)
void operator= (const Self &)

Private Attributes

InternalDataContainerType m_InternalContainer

Detailed Description

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

This class is the native implementation of the a Sample with an STL container.

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

ListSample 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:
Sample, Histogram
Wiki Examples:

Definition at line 51 of file itkListSample.h.

Member Typedef Documentation

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

Frequency value type

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 70 of file itkListSample.h.

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

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 58 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::Sample< TMeasurementVector >.

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 72 of file itkListSample.h.

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

internal data container type

Definition at line 79 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::Sample< TMeasurementVector >.

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 69 of file itkListSample.h.

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

Typedef for the length of each measurement vector

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 68 of file itkListSample.h.

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

Typedefs inherited from the superclass

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 64 of file itkListSample.h.

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

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 57 of file itkListSample.h.

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

Standard class typedef.

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 55 of file itkListSample.h.

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

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 56 of file itkListSample.h.

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

Total frequency type

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 71 of file itkListSample.h.

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

Value type of a measurement (component of the measurement vector)

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

template<class TMeasurementVector>
itk::Statistics::ListSample< TMeasurementVector >::ListSample ( const Self &  ) [private]

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 239 of file itkListSample.h.

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

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

returns an iterator that points to the beginning of the container

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 255 of file itkListSample.h.

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

Removes all the elements in the Sample

template<class TMeasurementVector>
virtual::itk::LightObject::Pointer itk::Statistics::ListSample< TMeasurementVector >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

returns an iterator that points to the end of the container

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 263 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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Definition at line 247 of file itkListSample.h.

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

Get the frequency of a measurement. Returns 1 if the measurement exist.

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Get the measurement associated with the specified InstanceIdentifier

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Standard macros

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Get the total frequency of the sample. This is equivalent to the size of the sample.

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

template<class TMeasurementVector>
virtual void itk::Statistics::ListSample< TMeasurementVector >::Graft ( const DataObject *  thatObject) [virtual]

Method to graft another sample

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::operator= ( const Self &  ) [private]

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

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

Inserts a measurement at the end of the list

template<class TMeasurementVector>
void itk::Statistics::ListSample< TMeasurementVector >::Resize ( InstanceIdentifier  newsize)

Resize the container. Using Resize() and then SetMeasurementVector() is about nine times faster than usign PushBack() continously. Which means that whenever the total number of Measurement vectors is known, the users should prefer calling Resize() first and then set the values by calling SetMeasurementVector(). On the other hand, if the number of measurement vectors is not known from the beginning, then calling PushBack() sequentially is a convenient option.

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

Set a component a measurement to a particular value.

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

Replace a measurement with a different measurement

template<class TMeasurementVector>
InstanceIdentifier itk::Statistics::ListSample< TMeasurementVector >::Size ( ) const [virtual]

Get the number of measurement vectors in the sample

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

Reimplemented in itk::Statistics::ImageToListSampleAdaptor< TImage >, itk::Statistics::JointDomainImageToListSampleAdaptor< TImage >, itk::Statistics::PointSetToListSampleAdaptor< TPointSet >, and itk::Statistics::VectorContainerToListSampleAdaptor< TVectorContainer >.

Member Data Documentation

template<class TMeasurementVector>
InternalDataContainerType itk::Statistics::ListSample< TMeasurementVector >::m_InternalContainer [private]

Definition at line 280 of file itkListSample.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:52:13 for ITK by doxygen 1.7.4