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

This class is the base class for Samples that store measurements in a list. More...

#include <itkListSampleBase.h>

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

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

[legend]List of all members.

Public Types
typedef ListSampleBase	Self
typedef Sample< TMeasurementVector >	Superclass
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::FrequencyType	FrequencyType
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef std::vector< InstanceIdentifier >	SearchResultVectorType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	Search (MeasurementVectorType center, double radius, SearchResultVectorType &result) const
Protected Member Functions
	ListSampleBase ()
virtual	~ListSampleBase ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

This class is the base class for Samples that store measurements in a list.

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.

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

See also:

Sample, Histogram

Definition at line 48 of file itkListSampleBase.h.

---

Member Typedef Documentation

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

Frequency value type Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 62 of file itkListSampleBase.h.

template<class TMeasurementVector> typedef Superclass::InstanceIdentifier itk::Statistics::ListSampleBase< 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::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 63 of file itkListSampleBase.h.

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

ValueType of a measurement (ValueType of a component of the MeasurementVector Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 61 of file itkListSampleBase.h.

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

Typedef for the length of each measurement vector Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 60 of file itkListSampleBase.h.

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

Typedefs inherited from the superclass Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 59 of file itkListSampleBase.h.

template<class TMeasurementVector> typedef std::vector< InstanceIdentifier > itk::Statistics::ListSampleBase< TMeasurementVector >::SearchResultVectorType

Vector of InstanceIdentifiers used for returning search results. Reimplemented in itk::Statistics::ListSample< TMeasurementVector >. Definition at line 67 of file itkListSampleBase.h.

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

Standard class typedef. Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 52 of file itkListSampleBase.h.

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

Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 53 of file itkListSampleBase.h.

---

Constructor & Destructor Documentation

template<class TMeasurementVector> itk::Statistics::ListSampleBase< TMeasurementVector >::ListSampleBase (   )  [inline, protected]

Definition at line 116 of file itkListSampleBase.h.

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

Definition at line 117 of file itkListSampleBase.h.

---

Member Function Documentation

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

Standard macros Reimplemented from itk::Statistics::Sample< TMeasurementVector >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >.

template<class TMeasurementVector> void itk::Statistics::ListSampleBase< TMeasurementVector >::PrintSelf (  std::ostream &  os, Indent  indent )  const [inline, 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 >. Reimplemented in itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, TMeasurementVector >, itk::Statistics::JointDomainImageToListAdaptor< TImage >, itk::Statistics::ListSample< TMeasurementVector >, itk::Statistics::PointSetToListAdaptor< TPointSet >, itk::Statistics::ScalarImageToListAdaptor< TImage >, itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 2 > >, itk::Statistics::ImageToListAdaptor< TImage, ImageJointDomainTraits< TImage >::MeasurementVectorType >, and itk::Statistics::ImageToListAdaptor< TImage, FixedArray< TImage::PixelType, 1 > >. Definition at line 118 of file itkListSampleBase.h.

template<class TMeasurementVector> void itk::Statistics::ListSampleBase< TMeasurementVector >::Search (  MeasurementVectorType  center, double  radius, SearchResultVectorType &  result )  const [inline]

Search for measurements within the specified radius of a search point. A vector of InstanceIdentifiers is returned. Definition at line 71 of file itkListSampleBase.h.

---

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

• itkListSampleBase.h

---