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

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

#include <itkListSampleToHistogramGenerator.h>

Inheritance diagram for itk::Statistics::ListSampleToHistogramGenerator:

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

[legend]List of all members.

Public Types
typedef ListSampleToHistogramGenerator	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef Histogram< THistogramMeasurement, itkGetStaticConstMacro(MeasurementVectorSize), TFrequencyContainer	HistogramType )
typedef HistogramType::SizeType	HistogramSizeType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TListSample::MeasurementVectorSize)
void	SetListSample (TListSample *list)
void	SetMarginalScale (float scale)
void	SetNumberOfBins (HistogramSizeType sizes)
HistogramType *	GetOutput ()
void	Update ()
Static Public Methods
Pointer	New ()
Protected Methods
	ListSampleToHistogramGenerator ()
virtual	~ListSampleToHistogramGenerator ()
void	GenerateData ()

---

Detailed Description

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >>
class itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >

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).

See also:

Histogram, ListSampleBase, FindSampleBound

Definition at line 63 of file itkListSampleToHistogramGenerator.h.

---

Member Typedef Documentation

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> typedef HistogramType::SizeType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramSizeType

Definition at line 86 of file itkListSampleToHistogramGenerator.h.

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

Definition at line 84 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> typedef SmartPointer<Self> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Pointer

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

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> typedef ListSampleToHistogramGenerator itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Self

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

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> typedef Object itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Superclass

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

---

Constructor & Destructor Documentation

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToHistogramGenerator (    )  [protected]

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

Definition at line 106 of file itkListSampleToHistogramGenerator.h.

---

Member Function Documentation

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

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> virtual const char* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetClassName (    )  const [virtual]

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

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> HistogramType* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetOutput (  void    )  [inline]

Definition at line 98 of file itkListSampleToHistogramGenerator.h.

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

the number of components in a measurement vector

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

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

template<class TListSample, class THistogramMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer< float >> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetListSample (  TListSample *    list )  [inline]

plug in the ListSample object Definition at line 89 of file itkListSampleToHistogramGenerator.h.

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

Definition at line 92 of file itkListSampleToHistogramGenerator.h.

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

Definition at line 95 of file itkListSampleToHistogramGenerator.h.

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

Definition at line 101 of file itkListSampleToHistogramGenerator.h. References HardConnectedComponentImageFilter::GenerateData().

---

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

• itkListSampleToHistogramGenerator.h

---