itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength > Class Template Reference

Generates a Histogram using the data from the ListSample object. More...

#include <itkListSampleToHistogramGenerator.h>

Inheritance diagram for itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >:

[legend]Collaboration diagram for itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >:

[legend]List of all members.

Public Types
typedef ListSampleToHistogramGenerator	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Histogram< THistogramMeasurement, itkGetStaticConstMacro(MeasurementVectorSize), TFrequencyContainer	HistogramType )
typedef HistogramType::SizeType	HistogramSizeType
typedef HistogramType::MeasurementVectorType	MeasurementVectorType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TMeasurementVectorLength)
void	SetMarginalScale (float scale)
void	SetNumberOfBins (HistogramSizeType sizes)
const HistogramType *	GetOutput () const
void	Update ()
virtual void	SetAutoMinMax (bool _arg)
virtual const bool &	GetAutoMinMax ()
void	SetHistogramMin (const MeasurementVectorType &histogramMin)
void	SetHistogramMax (const MeasurementVectorType &histogramMax)
void	SetListSample (const TListSample *list)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ListSampleToHistogramGenerator ()
virtual	~ListSampleToHistogramGenerator ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1>
class itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >

Generates a Histogram using the data from the ListSample object.

This class is templated over the type of ListSample (which is a subclass of ListSampleBase class), the type of measurement values in the histogram, and The type of the frequency container that will be used to store frequency in the result histogram.

User should plug in the input list sample and specify the number of bins along each dimension. For example, if a measurement vector of the input list sample has three components, the histogram will be three dimensional histogram. So, the SetNumberOfBins() function will accepts itk::Size object with three components.

The upper bound and lower bound of the histogram will be automatically determined by the FindSampleBound funtion in itkStatisticsAlgorithm.h & .txx. The hitogram object's upper bound will be slightly bigger than the uppper bound from the FindSampleBound to include the maximum values in the Histogram object. To extend the upper bound of the histogram. this class internally uses the intervals between two bins and the marginal scale constant that you can set using the SetMarginalScale(float) funtion. The default marginal scale constant value is 100, which means that the upper bound of Histogram will be upper bound of the list sample + (bin interval) / 100 ( = marginal scale).

The result historam has equi-size bins along each axe.

NOTE: The second template argument, THistogramMeasurement should be float-point type (float or double).

Recent API changes The class is templated over the list sample, the frequency measurement precision, the length of each measurement vector and optionally over the type of frequency container.

See also:

Histogram, ListSampleBase, FindSampleBound

Definition at line 70 of file itkListSampleToHistogramGenerator.h.

---

Member Typedef Documentation

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef SmartPointer<const Self> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::ConstPointer

Reimplemented from itk::Object. Definition at line 78 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef HistogramType::SizeType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramSizeType

Definition at line 94 of file itkListSampleToHistogramGenerator.h. Referenced by itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::~ListSampleToHistogramGenerator().

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef Histogram< THistogramMeasurement, itkGetStaticConstMacro(MeasurementVectorSize), TFrequencyContainer itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramType)

Definition at line 92 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef HistogramType::MeasurementVectorType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::MeasurementVectorType

Definition at line 95 of file itkListSampleToHistogramGenerator.h. Referenced by itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::~ListSampleToHistogramGenerator().

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef SmartPointer<Self> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Pointer

Reimplemented from itk::Object. Definition at line 77 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef ListSampleToHistogramGenerator itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Self

Standard typedefs Reimplemented from itk::Object. Definition at line 75 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef Object itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Superclass

Reimplemented from itk::Object. Definition at line 76 of file itkListSampleToHistogramGenerator.h.

---

Constructor & Destructor Documentation

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::ListSampleToHistogramGenerator (   )  [protected]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::~ListSampleToHistogramGenerator (   )  [inline, protected, virtual]

Definition at line 170 of file itkListSampleToHistogramGenerator.h. References itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramSizeType, and itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::MeasurementVectorType.

---

Member Function Documentation

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GenerateData (   )  [protected]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual const bool& itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetAutoMinMax (   )  [virtual]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual const char* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> const HistogramType* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetOutput (  void   )  const [inline]

Definition at line 118 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::itkStaticConstMacro (  MeasurementVectorSize  , unsigned  int, TMeasurementVectorLength  )

the number of components in a measurement vector

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> Pointer itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::New (   )  [static]

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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::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::Object.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetAutoMinMax (  bool  _arg  )  [virtual]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetHistogramMax (  const MeasurementVectorType &  histogramMax  )  [inline]

Definition at line 147 of file itkListSampleToHistogramGenerator.h. References itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetHistogramMin (  const MeasurementVectorType &  histogramMin  )  [inline]

Definition at line 127 of file itkListSampleToHistogramGenerator.h. References itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetListSample (  const TListSample *  list  )  [inline]

plug in the ListSample object Definition at line 98 of file itkListSampleToHistogramGenerator.h. References itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetMarginalScale (  float  scale  )  [inline]

Definition at line 112 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetNumberOfBins (  HistogramSizeType  sizes  )  [inline]

Definition at line 115 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Update (  void   )  [inline]

Definition at line 121 of file itkListSampleToHistogramGenerator.h.

---

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

• itkListSampleToHistogramGenerator.h

---