geant4/source/analysis/g4tools/include/tools/histo/histo_data

// Copyright (C) 2010, Guy Barrand. All rights reserved.
// See the file tools.license for terms.

#ifndef tools_histo_histo_data
#define tools_histo_histo_data

#include <vector>
#include <map> //for annotations

#include "axes"

namespace tools {
namespace histo {

//TC is for a coordinate.
//TO is for an offset used to identify a bin.
//TN is for a number of entries.
//TW is for a weight.

template <class TC,class TO,class TN,class TW>
class histo_data {
public:
  typedef axis<TC,TO> axis_t;
  typedef unsigned int dim_t;
public:
  histo_data()
  :m_dimension(0)
  ,m_bin_number(0)
  ,m_all_entries(0)
  ,m_in_range_entries(0)
  ,m_in_range_Sw(0)
  ,m_in_range_Sw2(0)
  {}
public:
  histo_data(const histo_data& a_from)
  :m_title(a_from.m_title)
  ,m_dimension(a_from.m_dimension)
  ,m_bin_number(a_from.m_bin_number)
  ,m_bin_entries(a_from.m_bin_entries)
  ,m_bin_Sw(a_from.m_bin_Sw)
  ,m_bin_Sw2(a_from.m_bin_Sw2)
  ,m_bin_Sxw(a_from.m_bin_Sxw)
  ,m_bin_Sx2w(a_from.m_bin_Sx2w)
  ,m_axes(a_from.m_axes)
  ,m_annotations(a_from.m_annotations)
  ,m_all_entries(a_from.m_all_entries)
  ,m_in_range_entries(a_from.m_in_range_entries)
  ,m_in_range_Sw(a_from.m_in_range_Sw)
  ,m_in_range_Sw2(a_from.m_in_range_Sw2)
  ,m_in_range_Sxw(a_from.m_in_range_Sxw)
  ,m_in_range_Sx2w(a_from.m_in_range_Sx2w)
  {}

  histo_data& operator=(const histo_data& a_from) {
    if(&a_from==this) return *this;
    m_title = a_from.m_title;
    m_dimension = a_from.m_dimension;
    m_bin_number = a_from.m_bin_number;
    m_bin_entries = a_from.m_bin_entries;
    m_bin_Sw = a_from.m_bin_Sw;
    m_bin_Sw2 = a_from.m_bin_Sw2;
    m_bin_Sxw = a_from.m_bin_Sxw;
    m_bin_Sx2w = a_from.m_bin_Sx2w;
    m_axes = a_from.m_axes;
    m_annotations = a_from.m_annotations;
    m_all_entries = a_from.m_all_entries;
    m_in_range_entries = a_from.m_in_range_entries;
    m_in_range_Sw = a_from.m_in_range_Sw;
    m_in_range_Sw2 = a_from.m_in_range_Sw2;
    m_in_range_Sxw = a_from.m_in_range_Sxw;
    m_in_range_Sx2w = a_from.m_in_range_Sx2w;
    return *this;
  }

  virtual ~histo_data(){}

public:

  // for inlib/rroot/streamers :
  TW get_Sw() const {
    TW sw = 0;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        sw += m_bin_Sw[ibin];
      }
    }
    return sw;
  }
/*
  TW get_all_Sw() const {
    TW sw = 0;
    for(TO ibin=0;ibin<m_bin_number;ibin++) sw += m_bin_Sw[ibin];
    return sw;
  }
  TN get_all_entries() const {
    TN number = 0;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      number += m_bin_entries[ibin];
    }
    return number;
  }

  // for inlib/wroot/streamers :
  TN get_entries() const {
    TN number = 0;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        number += m_bin_entries[ibin];
      }
    }
    return number;
  }
*/

  TW get_Sw2() const {
    TW sw2 = 0;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        sw2 += m_bin_Sw2[ibin];
      }
    }
    return sw2;
  }

  bool get_ith_axis_Sxw(dim_t a_axis,TC& a_value) const {
    a_value = 0;
    if(a_axis>=m_dimension) return false;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        a_value += m_bin_Sxw[ibin][a_axis];
      }
    }
    return true;
  }

  bool get_ith_axis_Sx2w(dim_t a_axis,TC& a_value) const {
    a_value = 0;
    if(a_axis>=m_dimension) return false;
    for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        a_value += m_bin_Sx2w[ibin][a_axis];
      }
    }
    return true;
  }

protected:
  void reset_fast_getters(){
    m_all_entries = 0;
    m_in_range_entries = 0;
    m_in_range_Sw = 0;
    m_in_range_Sw2 = 0;
    m_in_range_Sxw.resize(m_dimension,0);
    m_in_range_Sx2w.resize(m_dimension,0);
  }
public:
  void update_fast_getters() {
    reset_fast_getters();
   {for(TO ibin=0;ibin<m_bin_number;ibin++) {
      if(!histo::is_out(m_axes,ibin)) {
        m_in_range_entries += m_bin_entries[ibin];
        m_in_range_Sw += m_bin_Sw[ibin];
        m_in_range_Sw2 += m_bin_Sw2[ibin];
        for(dim_t iaxis=0;iaxis<m_dimension;iaxis++) {
           m_in_range_Sxw[iaxis] += m_bin_Sxw[ibin][iaxis];
           m_in_range_Sx2w[iaxis] += m_bin_Sx2w[ibin][iaxis];
        }
      }
      m_all_entries += m_bin_entries[ibin];
    }}
  }

public:
  // General :
  std::string m_title;
  dim_t m_dimension;
  // Bins :
  TO m_bin_number;
  std::vector<TN> m_bin_entries;
  std::vector<TW> m_bin_Sw;
  std::vector<TW> m_bin_Sw2;
  std::vector< std::vector<TC> > m_bin_Sxw;
  std::vector< std::vector<TC> > m_bin_Sx2w;
  // Axes :
  std::vector<axis_t> m_axes;
  // etc :
  std::map<std::string,std::string> m_annotations;
  // fast getters :
  TN m_all_entries; //used if reading from a ROOT file.
  TN m_in_range_entries;
  TW m_in_range_Sw;
  TW m_in_range_Sw2;
  std::vector<TC> m_in_range_Sxw;
  std::vector<TC> m_in_range_Sx2w;
};

}}

#endif