SimpleHistogram< T > Class Template Reference

Classical histogram container class. More...

#include <aims/histogram/simpleHisto.h>

Inheritance diagram for SimpleHistogram< T >:

Collaboration diagram for SimpleHistogram< T >:

Public Member Functions
void	doit (const carto::rc_ptr< carto::Volume< float > > &thing)
void	doit (const carto::rc_ptr< carto::Volume< double > > &thing)
Constructors and destructor
	SimpleHistogram ()
	constructor. Does nothing.
	SimpleHistogram (const SimpleHistogram< T > &other)
	copy constructor.
virtual	~SimpleHistogram ()
	destructor.
void	doit (const carto::rc_ptr< carto::Volume< T > > &thing)
	classical histogram computation function.
Rebinning functions.
void	rebin (int size)
	rebinning to a specific result vector size.
void	rebin (carto::Volume< int32_t >::iterator beg, carto::Volume< int32_t >::iterator end)
	rebinning from the beginning iterator to the ending one.
void	rebin (int size, carto::Volume< int32_t >::iterator beg, carto::Volume< int32_t >::iterator end)
	rebinning from iterator 'beg' to iterator 'end' to a result vector of size 'size'
Public Member Functions inherited from Histogram< T >
	Histogram ()
	constructor.
	Histogram (const Histogram< T > &other)
	copy constructor.
virtual	~Histogram ()
	destructor.
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.
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

Additional Inherited Members
int	_nPoints
	total number of points
int	_minValid
	minimum used value
int	_maxValid
	maximum used value
carto::VolumeRef< int32_t >	_data
	histogram datas

Detailed Description

template<class T>
class SimpleHistogram< T >

Classical histogram container class.

Definition at line 44 of file simpleHisto.h.

Constructor & Destructor Documentation

SimpleHistogram() [1/2]

template<class T>

SimpleHistogram< T >::SimpleHistogram ( )

inline

constructor. Does nothing.

Definition at line 51 of file simpleHisto.h.

References Histogram< T >::Histogram().

Referenced by SimpleHistogram().

SimpleHistogram() [2/2]

template<class T>

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

inline

copy constructor.

Definition at line 53 of file simpleHisto.h.

References Histogram< T >::Histogram(), and SimpleHistogram().

~SimpleHistogram()

template<class T>

virtual SimpleHistogram< T >::~SimpleHistogram ( )

inlinevirtual

destructor.

Definition at line 56 of file simpleHisto.h.

Member Function Documentation

doit() [1/3]

void SimpleHistogram< double >::doit ( const carto::rc_ptr< carto::Volume< double > > & thing )

inline

Definition at line 212 of file simpleHisto.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, Histogram< T >::_nPoints, carto::VolumeRef< typename T >::at(), carto::NDIterator_base::ended(), carto::const_line_NDIterator< typename T >::inc_line_ptr(), and carto::const_line_NDIterator< typename T >::line_length().

doit() [2/3]

void SimpleHistogram< float >::doit ( const carto::rc_ptr< carto::Volume< float > > & thing )

inline

Definition at line 164 of file simpleHisto.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, Histogram< T >::_nPoints, carto::VolumeRef< typename T >::at(), carto::NDIterator_base::ended(), carto::const_line_NDIterator< typename T >::inc_line_ptr(), and carto::const_line_NDIterator< typename T >::line_length().

doit() [3/3]

template<class T>

void SimpleHistogram< T >::doit ( const carto::rc_ptr< carto::Volume< T > > & thing )

inlinevirtual

classical histogram computation function.

\ Be careful that for float and double data types the histogram is not set in a float or double 1D Volume but in a 16 bits short 1D Volume, i.e. a rebinning is performed.

Reimplemented from Histogram< T >.

Definition at line 83 of file simpleHisto.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, Histogram< T >::_nPoints, carto::VolumeRef< typename T >::at(), carto::NDIterator_base::ended(), carto::const_line_NDIterator< typename T >::inc_line_ptr(), and carto::const_line_NDIterator< typename T >::line_length().

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

rebin() [1/3]

template<class T>

void SimpleHistogram< T >::rebin ( carto::Volume< int32_t >::iterator beg, carto::Volume< int32_t >::iterator end )

inline

rebinning from the beginning iterator to the ending one.

The result vector size is then defined by the number of bins included between the two iterators.

Definition at line 115 of file simpleHisto.h.

References rebin().

rebin() [2/3]

template<class T>

void SimpleHistogram< T >::rebin ( int size )

inline

rebinning to a specific result vector size.

Definition at line 108 of file simpleHisto.h.

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

Referenced by rebin(), and rebin().

rebin() [3/3]

template<class T>

void SimpleHistogram< T >::rebin ( int size, carto::Volume< int32_t >::iterator beg, carto::Volume< int32_t >::iterator end )

inline

rebinning from iterator 'beg' to iterator 'end' to a result vector of size 'size'

Definition at line 123 of file simpleHisto.h.

References Histogram< T >::_data, Histogram< T >::_maxValid, Histogram< T >::_minValid, Histogram< T >::_nPoints, carto::VolumeRef< typename T >::begin(), and carto::VolumeRef< typename T >::end().

---

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

• aims/histogram/simpleHisto.h