CaloBinDescriptor< T > Class Template Reference

Data object containing bin descriptions. More...

#include <CaloBinDescriptor.h>

Collaboration diagram for CaloBinDescriptor< T >:

Public Member Functions
	CaloBinDescriptor ()
	Default constructor generates empty bin descriptor. More...
	CaloBinDescriptor (const CaloBinDescriptor &theBins)
	Explicit copy constructor. More...
CaloBinDescriptor &	operator= (const CaloBinDescriptor &theBins)
	Assignment. More...
	CaloBinDescriptor (const std::vector< T > &theBins)
	Construct with variable sized bins. More...
	CaloBinDescriptor (size_t nBins, const T &lowerLimit, const T &upperLimit)
	Construct with regular bins. More...
	~CaloBinDescriptor ()
	Default constructor. More...
size_t	getNumberOfBins () const
	Retrieve the number of bins. More...
T	lowerBound () const
	Retrieve the lower value range boundary. More...
T	upperBound () const
	Retrieve the upper value range boundary. More...
T	lowerBinEdge (size_t theIndex) const
	Retrieve the lower bin edge of a given bin. More...
T	upperBinEdge (size_t theIndex) const
	Retrieve the upper bin edge of a given bin. More...
T	binWidth (size_t theIndex) const
	Retrieve the bin width of a given bin. More...
const std::vector< T > &	getBinning () const
	Direct Access to the vector describing the binning. More...
size_t	getIndex (const T &theData) const
	Get the index for a iven value. More...
bool	outOfRange (size_t theIndex) const
	Tests if given index is out of valid range. More...
size_t	outOfRangeMarker () const
	Returns the value of the out-of-range marker. More...

Private Attributes
std::vector< T >	m_bins
	Bin store. More...

Static Private Attributes
static const size_t	m_outOfRange = size_t(-1)
	Out-of-range marker (convention) More...

Detailed Description

template<typename T>
class CaloBinDescriptor< T >

Data object containing bin descriptions.

Author

Peter Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Date

April 1, 2005

Version

0

This data object stores the description of bins for any data type T with support for simple arithmatic (operators +,-,*,/) and valid comparators (operators >,=>,<,<=). The bins can be equidistant or variable.

Definition at line 11 of file CaloBinDescriptor.h.

Constructor & Destructor Documentation

CaloBinDescriptor() [1/4]

template<typename T >

CaloBinDescriptor< T >::CaloBinDescriptor ( )

inline

Default constructor generates empty bin descriptor.

Definition at line 16 of file CaloBinDescriptor.h.

{ m_bins.clear(); };

CaloBinDescriptor() [2/4]

template<typename T >

CaloBinDescriptor< T >::CaloBinDescriptor ( const CaloBinDescriptor< T > &  theBins )

explicit

Explicit copy constructor.

Definition at line 122 of file CaloBinDescriptor.h.

  : m_bins (theBins.m_bins)
{
}

CaloBinDescriptor() [3/4]

template<typename T >

CaloBinDescriptor< T >::CaloBinDescriptor

(

const std::vector< T > &

theBins

)

Construct with variable sized bins.

Parameters

theBins

reference to vector of bin boundaries with n+1 entries for n bins;

Note

There is no consistency check performed on the bin delimiters. Any invalid sequence of delimiters, i.e. not ordered increasing in value, will lead to unexpected index mapping.

Definition at line 140 of file CaloBinDescriptor.h.

  : m_bins (theBins)
{
}

CaloBinDescriptor() [4/4]

template<typename T >

CaloBinDescriptor< T >::CaloBinDescriptor	(	size_t	nBins,
		const T &	lowerLimit,
		const T &	upperLimit
	)

Construct with regular bins.

Parameters

nBins	number of bins
lowerLimit	lower limit of value range
upperLimit	upper limit of value range

Note

Invalid input (nbins = 0, lowerLimit >= upperLimit) will lead to empty (unusable) bin descriptor.

The input parameters are internally converted into a vector of lower bin boundaries (first n entries) and the upper limit of the value range (n+1 entry).

Definition at line 146 of file CaloBinDescriptor.h.

{
  if ( lowerEdge < upperEdge && nBins > 0 )
    {
      double fBin =lowerEdge;
      double dBin = ( upperEdge - lowerEdge ) / (double)nBins;
      while ( fBin <= ( upperEdge + dBin/2. ) )
    {
      m_bins.push_back(fBin);
      fBin += dBin;
    }
    }
  else
    {
      m_bins.clear();
    }
}

~CaloBinDescriptor()

template<typename T >

CaloBinDescriptor< T >::~CaloBinDescriptor ( )

inline

Default constructor.

Definition at line 46 of file CaloBinDescriptor.h.

{ }; 

Member Function Documentation

binWidth()

template<typename T >

T CaloBinDescriptor< T >::binWidth ( size_t  theIndex ) const

inline

Retrieve the bin width of a given bin.

Parameters

theIndex

bin index \( i \in [1,n] \) for \( n \) bins.

Returns 0 if theIndex out of range. A valid return is positive definit.

Definition at line 196 of file CaloBinDescriptor.h.

{
  return theIndex < m_bins.size()-2 
    ? m_bins[theIndex+1] - m_bins[theIndex]
    : 0.;
}

getBinning()

template<typename T >

const std::vector< T > & CaloBinDescriptor< T >::getBinning

inline

Direct Access to the vector describing the binning.

Definition at line 204 of file CaloBinDescriptor.h.

{
  return m_bins;
}

getIndex()

template<typename T >

size_t CaloBinDescriptor< T >::getIndex

(

const T &

theData

)

const

Get the index for a iven value.

Parameters

theData

input value to be tested

Returns 0 if theData is smaller than the lower value range boundary, and outOfRangeMarker if theData is bigger than the upper value range boundary.

Definition at line 210 of file CaloBinDescriptor.h.

{
  size_t theIndex = 0;
  while ( theIndex < this->getNumberOfBins() && theData > m_bins[theIndex] )
    {
      theIndex++;
    }
  return theIndex < this->getNumberOfBins() ? theIndex : m_outOfRange;
}

getNumberOfBins()

template<typename T >

size_t CaloBinDescriptor< T >::getNumberOfBins

inline

Retrieve the number of bins.

Returns 0 for empty bin descriptor.

Definition at line 166 of file CaloBinDescriptor.h.

{
  return m_bins.size()-1;
}

lowerBinEdge()

template<typename T >

T CaloBinDescriptor< T >::lowerBinEdge ( size_t  theIndex ) const

inline

Retrieve the lower bin edge of a given bin.

Parameters

theIndex

bin index \( i \in [1,n] \) for \( n \) bins.

Returns 0 if theIndex out of range.

Warning

0 is a valid return as well.

Definition at line 184 of file CaloBinDescriptor.h.

{
  return theIndex < m_bins.size()-2 ? m_bins[theIndex] : 0.;
}

lowerBound()

template<typename T >

T CaloBinDescriptor< T >::lowerBound

inline

Retrieve the lower value range boundary.

Definition at line 172 of file CaloBinDescriptor.h.

{
  return m_bins.size() > 0 ? *(m_bins.begin()) : 0.;
}

operator=()

template<typename T >

CaloBinDescriptor< T > & CaloBinDescriptor< T >::operator=

(

const CaloBinDescriptor< T > &

theBins

)

Assignment.

Definition at line 129 of file CaloBinDescriptor.h.

{
  if (this != &theBins)
    m_bins = theBins.m_bins;
  return *this;
}

outOfRange()

template<typename T >

bool CaloBinDescriptor< T >::outOfRange ( size_t  theIndex ) const

inline

Tests if given index is out of valid range.

Parameters

theIndex

input index to be tested

Returns true if theIndex within range.

Definition at line 221 of file CaloBinDescriptor.h.

{
  return theIndex != m_outOfRange
    ? theIndex < this->getNumberOfBins()
    : true;
}

outOfRangeMarker()

template<typename T >

size_t CaloBinDescriptor< T >::outOfRangeMarker

inline

Returns the value of the out-of-range marker.

Definition at line 229 of file CaloBinDescriptor.h.

{
  return m_outOfRange;
}

upperBinEdge()

template<typename T >

T CaloBinDescriptor< T >::upperBinEdge ( size_t  theIndex ) const

inline

Retrieve the upper bin edge of a given bin.

Parameters

theIndex

bin index \( i \in [1,n] \) for \( n \) bins.

Returns 0 if theIndex out of range.

Warning

0 is a valid return as well.

Definition at line 190 of file CaloBinDescriptor.h.

{
  return theIndex < m_bins.size()-1 ? m_bins[theIndex+1] : 0;
}

upperBound()

template<typename T >

T CaloBinDescriptor< T >::upperBound

inline

Retrieve the upper value range boundary.

Definition at line 178 of file CaloBinDescriptor.h.

{
  return m_bins.size() > 0 ? *(--(m_bins.end())) : 0.;
}

Member Data Documentation

m_bins

template<typename T >

std::vector<T> CaloBinDescriptor< T >::m_bins

private

Bin store.

n+1 entries for n bins.

Definition at line 115 of file CaloBinDescriptor.h.

m_outOfRange

template<typename T >

const size_t CaloBinDescriptor< T >::m_outOfRange = size_t(-1)

staticprivate

Out-of-range marker (convention)

Definition at line 118 of file CaloBinDescriptor.h.

---

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

• CaloBinDescriptor.h