Base class of histogram container class. More...

#include <aims/histogram/histogram.h>

Inheritance diagram for Histogram< T >:

[legend]

Collaboration diagram for Histogram< T >:

[legend]

Public Member Functions
Constructors and destructor.
	Histogram ()
	constructor.

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

virtual	~Histogram ()
	destructor.

Data of histogram
carto::VolumeRef< int32_t > &	data ()
	return a reference to the data field of the histogram class.

const carto::VolumeRef< int32_t > &	data () const
	return a constant reference to the data field of the histogram class.

Iterators
int32_t *	beginValid ()
	return the iterator to the first valid value of the histogram

int32_t *	endValid ()
	return the iterator to the last valid value of the histogram

const int32_t *	beginValid () const
	return the constant iterator to the first valid value of the histogram

const int32_t *	endValid () const
	return the constant iterator to the last valid value of the histogram

int	minValid () const
	return the minimum valid (used) value of the histogram

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

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

virtual void	doit (const carto::rc_ptr< carto::Volume< T > > &)
	the histogram computation function.

Output stream
int	_nPoints
	total number of points

int	_minValid
	minimum used value

int	_maxValid
	maximum used value

carto::VolumeRef< int32_t >	_data
	histogram datas

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

References _maxValid, _minValid, and _nPoints.

Referenced by CumulatedHistogram< T >::CumulatedHistogram(), CumulatedHistogram< T >::CumulatedHistogram(), Histogram(), operator<<, aims::RegularBinnedHistogram< T >::RegularBinnedHistogram(), aims::RegularBinnedHistogram< T >::RegularBinnedHistogram(), SimpleHistogram< T >::SimpleHistogram(), and SimpleHistogram< T >::SimpleHistogram().

◆ 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 _data, _maxValid, _minValid, _nPoints, data(), and Histogram().

◆ ~Histogram()

template<class T>

virtual Histogram< T >::~Histogram ( )

inlinevirtual

destructor.

Definition at line 60 of file histogram.h.

Member Function Documentation

◆ beginValid() [1/2]

template<class T>

int32_t * Histogram< T >::beginValid ( )

inline

return the iterator to the first valid value of the histogram

Definition at line 74 of file histogram.h.

References _data.

◆ beginValid() [2/2]

template<class T>

const int32_t * 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 _data.

◆ data() [1/2]

template<class T>

carto::VolumeRef< 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.

References _data.

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

◆ data() [2/2]

template<class T>

const carto::VolumeRef< 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 _data.

◆ doit()

template<class T>

virtual void Histogram< T >::doit ( const carto::rc_ptr< carto::Volume< T > > & )

inlinevirtual

the histogram computation function.

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

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

Definition at line 98 of file histogram.h.

◆ endValid() [1/2]

template<class T>

int32_t * Histogram< T >::endValid ( )

inline

return the iterator to the last valid value of the histogram

Definition at line 77 of file histogram.h.

References _data, _maxValid, and _minValid.

◆ endValid() [2/2]

template<class T>

const int32_t * 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 _data, _maxValid, and _minValid.

◆ 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 _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 _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 _nPoints.

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

Friends And Related Symbol Documentation

◆ operator<<

template<class T>

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

friend

Definition at line 138 of file histogram.h.

References _data, _maxValid, _minValid, _nPoints, and Histogram().

Member Data Documentation

◆ _data

template<class T>

carto::VolumeRef<int32_t> Histogram< T >::_data

protected

histogram datas

Definition at line 117 of file histogram.h.

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

◆ _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(), SimpleHistogram< T >::doit(), SimpleHistogram< T >::doit(), endValid(), endValid(), Histogram(), Histogram(), maxValid(), operator<<, 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(), SimpleHistogram< T >::doit(), SimpleHistogram< T >::doit(), endValid(), endValid(), Histogram(), Histogram(), minValid(), operator<<, 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 >::doit(), SimpleHistogram< T >::doit(), Histogram(), Histogram(), operator<<, SimpleHistogram< T >::rebin(), totalPoints(), and CumulatedHistogram< T >::valueForPercentage().

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

aims/histogram/histogram.h

Public Member Functions

Output stream

Detailed Description

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 Symbol Documentation

◆ operator<<

Member Data Documentation

◆ _data

◆ _maxValid

◆ _minValid

◆ _nPoints