HistogramFactory.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
#include "CxxUtils/checker_macros.h"
 
#include "TH1.h"
#include "TH2.h"
#include "TProfile.h"
#include "TProfile2D.h"
#include "TTree.h"
#include "TROOT.h"
 
#include "HistogramException.h"
#include "HistogramFactory.h"
 
using namespace Monitored;
 
HistogramFactory::HistogramFactory(const ServiceHandle<ITHistSvc>& histSvc,
                                   const std::string& histoPath)
: m_histSvc(histSvc)
{
  size_t whereToStart = 0;
  // do we have a leading slash? This distinguishes temporary streams in THistSvc
  if (! histoPath.empty() && histoPath[0] == '/') {
    whereToStart = 1;
  }
  size_t split = histoPath.find('/', whereToStart);
  m_streamName = (whereToStart == 1 ? "/" : "") + histoPath.substr(0,split);
  m_groupName = split!=std::string::npos ? histoPath.substr(split+1) : "";
  // Infrequently, loading a ROOT class in a MT context can fail.
  // So try to load the classes we'll need early.
  TClass::GetClass("TH1F");
  TClass::GetClass("TH1D");
  TClass::GetClass("TH1C");
  TClass::GetClass("TH1S");
  TClass::GetClass("TH1I");
  TClass::GetClass("TH2F");
  TClass::GetClass("TH2D");
  TClass::GetClass("TH2C");
  TClass::GetClass("TH2S");
  TClass::GetClass("TH2I");
  TClass::GetClass("TProfile");
  TClass::GetClass("TProfile2D");
  TClass::GetClass("TEfficiency");
  TClass::GetClass("TTree");
}
 
 
TNamed* HistogramFactory::create(const HistogramDef& def) {
  std::scoped_lock lock(m_createLock);
  TNamed* rootObj(0);
 
  if (def.type == "TH1F") {
    rootObj = create1D<TH1F>(def);
  } else if (def.type == "TH1D") {
    rootObj = create1D<TH1D>(def);
  } else if (def.type == "TH1C") {
    rootObj = create1D<TH1C>(def);
  } else if (def.type == "TH1S") {
    rootObj = create1D<TH1S>(def);
  } else if (def.type == "TH1I") {
    rootObj = create1D<TH1I>(def);
  } else if (def.type == "TH2F") {
    rootObj = create2D<TH2F>(def);
  } else if (def.type == "TH2D") {
    rootObj = create2D<TH2D>(def);
  } else if (def.type == "TH2C") {
    rootObj = create2D<TH2C>(def);
  } else if (def.type == "TH2S") {
    rootObj = create2D<TH2S>(def);
  } else if (def.type == "TH2I") {
    rootObj = create2D<TH2I>(def);
  } else if (def.type == "TProfile") {
    rootObj = create1DProfile<TProfile>(def);
  } else if (def.type == "TProfile2D") {
    rootObj = create2DProfile<TProfile2D>(def);
  } else if (def.type == "TEfficiency") {
    rootObj = createEfficiency(def);
  } else if (def.type == "TTree") {
    rootObj = createTree(def);
  }
  
  if (rootObj == 0) {
    throw HistogramException("Can not create yet histogram of type: >" + def.type + "<\n" +
                             "Try one of: TH1[F,D,C,S,I], TH2[F,D,C,S,I], TProfile, TProfile2D, " +
                             "TEfficiency, TTree.");
  }
 
  return rootObj;
}
 
template<class H> 
TH1* HistogramFactory::create1D(const HistogramDef& def) {
  if ( def.xarray.size()!=0 ) {
    return create<H,TH1>(def, def.xbins, &(def.xarray)[0]);
  } else {
    return create<H,TH1>(def, def.xbins, def.xmin, def.xmax);
  }
}
 
template<class H> 
TH1* HistogramFactory::create1DProfile(const HistogramDef& def) {
  if (def.xarray.size()!=0) {
    return create<H,TH1>(def, def.xbins, &(def.xarray)[0],
                              def.ymin, def.ymax);
  } else {
    return create<H,TH1>(def, def.xbins, def.xmin, def.xmax, 
                              def.ymin, def.ymax);
  }
}
 
template<class H> 
TH2* HistogramFactory::create2D(const HistogramDef& def) {
  if (def.xarray.size()!=0 && def.yarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, &(def.xarray)[0],
                              def.ybins, &(def.yarray)[0]);
  } else if (def.yarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, def.xmin, def.xmax,
                              def.ybins, &(def.yarray)[0]);
  } else if (def.xarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, &(def.xarray)[0],
                              def.ybins, def.ymin, def.ymax);
  } else {
    return create<H,TH2>(def, def.xbins, def.xmin, def.xmax,
                              def.ybins, def.ymin, def.ymax);
  }
}
 
template<class H> 
TH2* HistogramFactory::create2DProfile(const HistogramDef& def) {
  if (def.xarray.size()!=0 && def.yarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, &(def.xarray)[0],
                              def.ybins, &(def.yarray)[0]);
  } else if (def.yarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, def.xmin, def.xmax, 
                              def.ybins, &(def.yarray)[0]);
  } else if (def.xarray.size()!=0) {
    return create<H,TH2>(def, def.xbins, &(def.xarray)[0],
                              def.ybins, def.ymin, def.ymax);
  } else {
    return create<H,TH2>(def, def.xbins, def.xmin, def.xmax, 
                              def.ybins, def.ymin, def.ymax, 
                              def.zmin, def.zmax);
  }
}
 
TEfficiency* HistogramFactory::createEfficiency(const HistogramDef& def) {    
  std::string fullName = getFullName(def);
 
  // Check if efficiency exists already
  TEfficiency* e = nullptr;
  if ( m_histSvc->existsEfficiency(fullName) ) {
    if ( !m_histSvc->getEfficiency(fullName,e) ) {
      throw HistogramException("Histogram >"+ fullName + "< seems to exist but can not be obtained from THistSvc");
    }
    return e;
  }
 
  // Otherwise, create the efficiency and register it
  // Hold global lock until we have detached object from gDirectory
  {
    std::scoped_lock<std::mutex> dirLock(globalROOTMutex());
    if (def.ybins==0 && def.zbins==0) { // 1D TEfficiency
      if (def.xarray.size()!=0) {
        e = new TEfficiency(def.alias.c_str(), def.title.c_str(),
          def.xbins, &(def.xarray)[0]);
      } else {
        e = new TEfficiency(def.alias.c_str(), def.title.c_str(),
          def.xbins, def.xmin, def.xmax);
      }
    } else if (def.ybins>0 && def.zbins==0) { // 2D TEfficiency
      if (def.xarray.size()!=0 && def.yarray.size()!=0) {
        e = new TEfficiency(def.alias.c_str(), def.title.c_str(),
          def.xbins, &(def.xarray)[0], def.ybins, &(def.yarray)[0]);
      } else {
        e = new TEfficiency(def.alias.c_str(), def.title.c_str(),
          def.xbins, def.xmin, def.xmax, def.ybins, def.ymin, def.ymax);
      }
    } else if (def.ybins>0 && def.zbins>0) { // 3D TEfficiency
      e = new TEfficiency(def.alias.c_str(), def.title.c_str(),
        def.xbins, def.xmin, def.xmax, def.ybins, def.ymin, def.ymax, def.zbins, def.zmin, def.zmax);
    } else {
      throw HistogramException("Histogram >"+ fullName + "< could not be defined. Check xbins, ybins, and zbins.");
    }
    e->SetDirectory(0);
  }
  if ( !m_histSvc->regEfficiency(fullName,e) ) {
    delete e;
    throw HistogramException("Histogram >"+ fullName + "< can not be registered in THistSvc");
  }
  TH1* total ATLAS_THREAD_SAFE = const_cast<TH1*>(e->GetTotalHistogram());
  setLabels(total, def);
  TH1* passed ATLAS_THREAD_SAFE = const_cast<TH1*>(e->GetPassedHistogram());
  setLabels(passed, def);
 
  return e;
}
 
template<class H, class HBASE, typename... Types> 
HBASE* HistogramFactory::create(const HistogramDef& def, Types&&... hargs) {    
  std::string fullName = getFullName(def);
   
  // Check if histogram exists already
  HBASE* histo = nullptr;
  if ( m_histSvc->exists( fullName ) ) {
    if ( !m_histSvc->getHist( fullName, histo ) ) {
      throw HistogramException("Histogram >"+ fullName + "< seems to exist but can not be obtained from THistSvc");
    }    
    return histo;
  }
 
  // Create the histogram and register it
  // Hold global lock until we have detached object from gDirectory
  H* h = nullptr;
  { 
    std::scoped_lock<std::mutex> dirLock(globalROOTMutex());
    h = new H(def.alias.c_str(), def.title.c_str(), std::forward<Types>(hargs)...);
    // cppcheck-suppress nullPointer; false positive
    h->SetDirectory(0);
  }
  if ( !m_histSvc->regHist( fullName, static_cast<TH1*>(h) ) ) {
    delete h;
    throw HistogramException("Histogram >"+ fullName + "< can not be registered in THistSvc");
 
  }
  h->GetYaxis()->SetTitleOffset(1.25); // magic shift to make histograms readable even if no post-procesing is done
 
  setLabels(h, def);
  setOpts(h, def);
 
  return h;
}
 
TTree* HistogramFactory::createTree(const HistogramDef& def) {
   std::string fullName = getFullName(def);
 
  // Check if tree exists already
  TTree* t = nullptr;
  if ( m_histSvc->existsTree(fullName) ) {
    if ( !m_histSvc->getTree(fullName,t) ) {
      throw HistogramException("Tree >"+ fullName + "< seems to exist but can not be obtained from THistSvc");
    }
    return t;
  }
 
  // Otherwise, create the tree and register it
  // branches will be created by HistogramFillerTree
  {
    std::scoped_lock<std::mutex> dirLock(globalROOTMutex());
    t = new TTree(def.alias.c_str(),def.title.c_str());
    t->SetDirectory(0);
  }
  if ( !m_histSvc->regTree(fullName,std::unique_ptr<TTree>(t) ) ) {
    throw HistogramException("Tree >"+ fullName + "< can not be registered in THistSvc");
  }
  // cppcheck-suppress deallocret; false positive
  return t;
}
 
void HistogramFactory::setOpts(TH1* hist, const HistogramDef& def) {
  // apply extension policy
  const unsigned canExtendPolicy = def.kCanRebin ? TH1::kAllAxes : TH1::kNoAxis;
  hist->SetCanExtend(canExtendPolicy);
 
  // apply Sumw2 option
  hist->Sumw2(def.Sumw2);
}
 
void HistogramFactory::setLabels(TH1* hist, const HistogramDef& def) {
  setLabels(hist->GetXaxis(), def.xlabels);
  setLabels(hist->GetYaxis(), def.ylabels);
  setLabels(hist->GetZaxis(), def.zlabels);
}
 
void HistogramFactory::setLabels(TAxis* axis, const std::vector<std::string>& labels) {
  if ( !labels.empty() ) {
    const int nBin = axis->GetNbins();
    for ( int bin=0; bin<nBin; bin++ ) {
      axis->SetBinLabel(bin+1, labels[bin].c_str());
    }
  }
}
 
namespace {
  const static std::set<std::string> onlinePaths( { "EXPERT", "SHIFT", "DEBUG", "RUNSTAT", "EXPRESS" } );
}
std::string HistogramFactory::getFullName(const HistogramDef& def) const {
 
  // for online paths, always prepend a slash. Otherwise take it from provided stream name
  std::string path;
  if ( onlinePaths.count( def.path)!=0 ) {
    path =  "/" + def.path + "/" + m_streamName + "/" + m_groupName;
  } else if ( def.path=="DEFAULT" ) {
    path = "/" + m_streamName + "/" + m_groupName;
  } else {
    path = m_streamName + "/" + def.tld + "/" + m_groupName + "/" + def.path;
  }
 
  // remove duplicate slashes
  std::string fullName = path + "/" + def.alias;
  fullName.erase( std::unique( fullName.begin(), fullName.end(), 
    [](const char a, const char b) { 
      return a == b and a == '/';
    } ), fullName.end() );
 
  return fullName;
}
 
void HistogramFactory::remove(const HistogramDef& def) {
  std::string path = getFullName( def );
 
  bool exists = false;
  if (def.type=="TEfficiency") {
    exists = m_histSvc->existsEfficiency(path);
  } else if (def.type=="TGraph") {
    exists = m_histSvc->existsGraph(path);
  } else if (def.type=="TTree") {
    exists = m_histSvc->existsTree(path);
  } else {
    exists = m_histSvc->existsHist(path);
  }
 
  // see docu here:
  // https://acode-browser1.usatlas.bnl.gov/lxr/source/Gaudi/GaudiSvc/src/THistSvc/THistSvc.h#0146
  // and here:
  // https://acode-browser1.usatlas.bnl.gov/lxr/source/athena/HLT/Trigger/TrigControl/TrigServices/src/TrigMonTHistSvc.cxx#0216
  // online implementation actually claims ownership of the object and we ever need to call this in online situation
  //
  if (exists)
    m_histSvc->deReg(path).ignore(); // we actually ignore if that was sucessfull as we plan to use is eagerly to cleanup LumiBlock histograms history
}