A.I.M.S algorithms


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

Additional Inherited Members

- Protected Attributes inherited from Histogram< T >
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...
 

Detailed Description

template<class T>
class SimpleHistogram< T >

Classical histogram container class.

Definition at line 43 of file simpleHisto.h.

Constructor & Destructor Documentation

template<class T>
SimpleHistogram< T >::SimpleHistogram ( )
inline

constructor. Does nothing.

Definition at line 50 of file simpleHisto.h.

template<class T>
SimpleHistogram< T >::SimpleHistogram ( const SimpleHistogram< T > &  other)
inline

copy constructor.

Definition at line 52 of file simpleHisto.h.

template<class T>
virtual SimpleHistogram< T >::~SimpleHistogram ( )
inlinevirtual

destructor.

Definition at line 55 of file simpleHisto.h.

Member Function Documentation

template<class T >
void SimpleHistogram< T >::doit ( const AimsData< 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 AimsData but in a 16 bits short 1D AimsData, i.e. a rebinning is performed.

Reimplemented from Histogram< T >.

Definition at line 82 of file simpleHisto.h.

References AimsData< T >::begin(), AimsData< T >::dimT(), AimsData< T >::dimX(), AimsData< T >::dimY(), AimsData< T >::dimZ(), AimsData< T >::maximum(), AimsData< T >::minimum(), AimsData< T >::oFirstPoint(), AimsData< T >::oLineBetweenSlice(), AimsData< T >::oPointBetweenLine(), and AimsData< T >::oSliceBetweenVolume().

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

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.

template<class T >
void SimpleHistogram< T >::rebin ( AimsData< int32_t >::iterator  beg,
AimsData< 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.

template<class T >
void SimpleHistogram< T >::rebin ( int  size,
AimsData< int32_t >::iterator  beg,
AimsData< 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 ASSERT, AimsData< T >::begin(), and AimsData< T >::end().


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