Base class of histogram container class. More...

#include <aims/histogram/histogram.h>

Inheritance diagram for Histogram< T >:

Collaboration diagram for Histogram< T >:

[legend]

Public Member Functions
int	minValid () const
	return the minimum valid (used) value of the histogram More...

int	maxValid () const
	returnn the maximum valid (used) value of the histogram More...

int	totalPoints () const
	return the total number of points in the histogram More...

virtual void	doit (const AimsData< T > &)
	the histogram computation function. More...

Constructors and destructor.
	Histogram ()
	constructor. More...

	Histogram (const Histogram< T > &other)
	copy constructor. More...

virtual	~Histogram ()
	destructor. More...

Data of histogram
AimsData< int32_t > &	data ()
	return a reference to the data field of the histogram class. More...

const AimsData< int32_t > &	data () const
	return a constant reference to the data field of the histogram class. More...

Iterators
AimsData< int32_t >::iterator	beginValid ()
	return the iterator to the first valid value of the histogram More...

AimsData< int32_t >::iterator	endValid ()
	return the iterator to the last valid value of the histogram More...

AimsData< int32_t >::const_iterator	beginValid () const
	return the constant iterator to the first valid value of the histogram More...

AimsData< int32_t >::const_iterator	endValid () const
	return the constant iterator to the last valid value of the histogram More...

Protected Attributes
int	_nPoints
	total number of points More...

int	_minValid
	minimum used value More...

int	_maxValid
	maximum used value More...

AimsData< int32_t >	_data
	histogram datas More...

Friends
Output stream
std::ostream &	operator<< (std::ostream &os, const Histogram< T > &thing)

Detailed Description

template<class T>
class Histogram< T >

Base class of histogram container class.

Definition at line 42 of file histogram.h.

Constructor & Destructor Documentation

◆ Histogram() [1/2]

template<class T >

Histogram< T >::Histogram ( )

inline

constructor.

Definition at line 122 of file histogram.h.

◆ Histogram() [2/2]

template<class T >

Histogram< T >::Histogram ( const Histogram< T > & other )

inline

copy constructor.

Definition at line 129 of file histogram.h.

References Histogram< T >::_data, AimsData< int32_t >::clone(), and Histogram< T >::data().

◆ ~Histogram()

template<class T>

virtual Histogram< T >::~Histogram ( )

inlinevirtual

destructor.

Definition at line 60 of file histogram.h.

References Histogram< T >::_data, and Histogram< T >::data().

Member Function Documentation

◆ beginValid() [1/2]

template<class T>

AimsData<int32_t>::iterator Histogram< T >::beginValid ( )

inline

return the iterator to the first valid value of the histogram

Definition at line 74 of file histogram.h.

Referenced by Histogram< T >::data().

◆ beginValid() [2/2]

template<class T>

AimsData<int32_t>::const_iterator Histogram< T >::beginValid ( ) const

inline

return the constant iterator to the first valid value of the histogram

Definition at line 81 of file histogram.h.

References Histogram< T >::_data, and AimsData< int32_t >::begin().

◆ data() [1/2]

template<class T>

AimsData<int32_t>& Histogram< T >::data ( )

inline

return a reference to the data field of the histogram class.

Definition at line 66 of file histogram.h.

Referenced by CumulatedHistogram< T >::doit(), Histogram< T >::Histogram(), AimsEMThreshold< T, U >::processEMThresholds(), and Histogram< T >::~Histogram().

◆ data() [2/2]

template<class T>

const AimsData<int32_t>& Histogram< T >::data ( ) const

inline

return a constant reference to the data field of the histogram class.

Definition at line 68 of file histogram.h.

References Histogram< T >::_data, AimsData< int32_t >::begin(), and Histogram< T >::beginValid().

◆ doit()

template<class T>

virtual void Histogram< T >::doit ( const AimsData< T > & )

inlinevirtual

the histogram computation function.

\ This virtual function must be defined in the child classes.

Reimplemented in SimpleHistogram< T >, CumulatedHistogram< T >, and aims::RegularBinnedHistogram< T >.

Definition at line 98 of file histogram.h.

◆ endValid() [1/2]

template<class T>

AimsData<int32_t>::iterator Histogram< T >::endValid ( )

inline

return the iterator to the last valid value of the histogram

Definition at line 77 of file histogram.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, and AimsData< int32_t >::begin().

◆ endValid() [2/2]

template<class T>

AimsData<int32_t>::const_iterator Histogram< T >::endValid ( ) const

inline

return the constant iterator to the last valid value of the histogram

Definition at line 84 of file histogram.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, and AimsData< int32_t >::begin().

◆ maxValid()

template<class T>

int Histogram< T >::maxValid ( ) const

inline

returnn the maximum valid (used) value of the histogram

Definition at line 91 of file histogram.h.

References Histogram< T >::_maxValid.

Referenced by CumulatedHistogram< T >::doit().

◆ minValid()

template<class T>

int Histogram< T >::minValid ( ) const

inline

return the minimum valid (used) value of the histogram

Definition at line 89 of file histogram.h.

References Histogram< T >::_minValid.

Referenced by CumulatedHistogram< T >::doit().

◆ totalPoints()

template<class T>

int Histogram< T >::totalPoints ( ) const

inline

return the total number of points in the histogram

Definition at line 94 of file histogram.h.

References Histogram< T >::_nPoints.

Referenced by CumulatedHistogram< T >::doit().

Friends And Related Function Documentation

◆ operator<<

template<class T>

std::ostream& operator<<	(	std::ostream &	os,
		const Histogram< T > &	thing
	)

friend

Definition at line 138 of file histogram.h.

Member Data Documentation

◆ _data

template<class T>

AimsData<int32_t> Histogram< T >::_data

protected

histogram datas

Definition at line 117 of file histogram.h.

Referenced by Histogram< T >::beginValid(), Histogram< T >::data(), CumulatedHistogram< T >::doit(), aims::RegularBinnedHistogram< T >::doit(), SimpleHistogram< T >::doit(), Histogram< T >::endValid(), Histogram< T >::Histogram(), SimpleHistogram< T >::rebin(), aims::RegularBinnedHistogram< T >::setBins(), CumulatedHistogram< T >::valueForPercentage(), and Histogram< T >::~Histogram().

◆ _maxValid

template<class T>

int Histogram< T >::_maxValid

protected

maximum used value

Definition at line 114 of file histogram.h.

Referenced by CumulatedHistogram< T >::doit(), SimpleHistogram< T >::doit(), Histogram< T >::endValid(), Histogram< T >::maxValid(), and SimpleHistogram< T >::rebin().

◆ _minValid

template<class T>

int Histogram< T >::_minValid

protected

minimum used value

Definition at line 112 of file histogram.h.

Referenced by CumulatedHistogram< T >::doit(), SimpleHistogram< T >::doit(), Histogram< T >::endValid(), Histogram< T >::minValid(), SimpleHistogram< T >::rebin(), and CumulatedHistogram< T >::valueForPercentage().

◆ _nPoints

template<class T>

int Histogram< T >::_nPoints

protected

total number of points

Definition at line 110 of file histogram.h.

Referenced by CumulatedHistogram< T >::doit(), SimpleHistogram< T >::doit(), SimpleHistogram< T >::rebin(), Histogram< T >::totalPoints(), and CumulatedHistogram< T >::valueForPercentage().

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

aims/histogram/histogram.h

Public Member Functions

Protected Attributes

Friends

Detailed Description

template<class T> class Histogram< T >

Constructor & Destructor Documentation

◆ Histogram() [1/2]

◆ Histogram() [2/2]

◆ ~Histogram()

Member Function Documentation

◆ beginValid() [1/2]

◆ beginValid() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ doit()

◆ endValid() [1/2]

◆ endValid() [2/2]

◆ maxValid()

◆ minValid()

◆ totalPoints()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ _data

◆ _maxValid

◆ _minValid

◆ _nPoints

template<class T>
class Histogram< T >