CaloBinDescriptor.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CALOEVENT_CALOBINDESCRIPTOR_H
#define CALOEVENT_CALOBINDESCRIPTOR_H
 
#include <vector>
 
template<typename T>
class CaloBinDescriptor
{
 public:
 
  CaloBinDescriptor() { m_bins.clear(); };
  explicit CaloBinDescriptor(const CaloBinDescriptor& theBins);
  CaloBinDescriptor& operator=(const CaloBinDescriptor& theBins);
  CaloBinDescriptor(const std::vector<T>& theBins);
  CaloBinDescriptor(size_t nBins, const T& lowerLimit, const T& upperLimit);
  ~CaloBinDescriptor() { }; 
 
  size_t getNumberOfBins() const;
  T lowerBound()           const;
  T upperBound()           const;
 
  T lowerBinEdge(size_t theIndex) const;
  T upperBinEdge(size_t theIndex) const;
  T binWidth(size_t theIndex)     const;
 
  const std::vector<T>& getBinning() const;
 
  size_t getIndex(const T& theData) const;
  
  bool   outOfRange(size_t theIndex) const;
  size_t outOfRangeMarker()          const;
 
 private:
 
  std::vector<T> m_bins;
 
  static const size_t m_outOfRange;  
};
 
template<typename T>
CaloBinDescriptor<T>::CaloBinDescriptor(const CaloBinDescriptor& theBins)
  : m_bins (theBins.m_bins)
{
}
 
template<typename T>
CaloBinDescriptor<T>&
CaloBinDescriptor<T>::operator=(const CaloBinDescriptor& theBins)
{
  if (this != &theBins)
    m_bins = theBins.m_bins;
  return *this;
}
 
template<typename T>
const size_t CaloBinDescriptor<T>::m_outOfRange = size_t(-1);
 
template<typename T>
CaloBinDescriptor<T>::CaloBinDescriptor(const std::vector<T>& theBins)
  : m_bins (theBins)
{
}
 
template<typename T>
CaloBinDescriptor<T>::CaloBinDescriptor(size_t nBins, const T& lowerEdge,
                    const T& upperEdge)
{
  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();
    }
}
 
template<typename T>
inline size_t CaloBinDescriptor<T>::getNumberOfBins() const
{
  return m_bins.size()-1;
}
 
template<typename T>
inline T CaloBinDescriptor<T>::lowerBound() const
{
  return m_bins.size() > 0 ? *(m_bins.begin()) : 0.;
}
 
template<typename T>
inline T CaloBinDescriptor<T>::upperBound() const
{
  return m_bins.size() > 0 ? *(--(m_bins.end())) : 0.;
}
 
template<typename T>
inline T CaloBinDescriptor<T>::lowerBinEdge(size_t theIndex) const
{
  return theIndex < m_bins.size()-2 ? m_bins[theIndex] : 0.;
}
 
template<typename T>
inline T CaloBinDescriptor<T>::upperBinEdge(size_t theIndex) const
{
  return theIndex < m_bins.size()-1 ? m_bins[theIndex+1] : 0;
}
 
template<typename T>
inline T CaloBinDescriptor<T>::binWidth(size_t theIndex) const
{
  return theIndex < m_bins.size()-2 
    ? m_bins[theIndex+1] - m_bins[theIndex]
    : 0.;
}
 
template<typename T>
inline const std::vector<T>& CaloBinDescriptor<T>::getBinning() const
{
  return m_bins;
}
 
template<typename T>
size_t CaloBinDescriptor<T>::getIndex(const T& theData) const
{
  size_t theIndex = 0;
  while ( theIndex < this->getNumberOfBins() && theData > m_bins[theIndex] )
    {
      theIndex++;
    }
  return theIndex < this->getNumberOfBins() ? theIndex : m_outOfRange;
}
 
template<typename T>
inline bool CaloBinDescriptor<T>::outOfRange(size_t theIndex) const
{
  return theIndex != m_outOfRange
    ? theIndex < this->getNumberOfBins()
    : true;
}
 
template<typename T>
inline size_t CaloBinDescriptor<T>::outOfRangeMarker() const
{
  return m_outOfRange;
}
 
#endif