postProcessIDPVMHistos.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
#include "InDetPhysValMonitoring/ResolutionHelper.h"
 
#include "TFile.h"
#include "TSystem.h"
#include "TH1.h"
#include "TH2.h"
#include "TObject.h"
 
#include <iostream>
#include <memory>
#include <string>
 
using namespace std;
 
 
bool file_exists(const string & p_name) {
  return !gSystem->AccessPathName(p_name.c_str(), kFileExists);    
}
 
// check if the name of an object matches what we expect from a resolution helper 
bool isResolutionHelper(TObject* entry){
  const std::string objName{entry->GetName()}; 
  return ((objName.find("resHelper") == 0 || objName.find("pullHelper") == 0) && dynamic_cast<TH1*>(entry));
}
 
// get the x axis observable and resolution (y axis) from the name of a 2D histo. 
// Relies on the conventions within IDPVM
std::vector<std::string> getObservableAndResoAndSuffix(const TObject* resHelper){
    const std::string name{resHelper->GetName()};
    const std::string keyWord {"Helper_"}; 
    const size_t offset = keyWord.size();
    auto start = name.find(keyWord)+offset;
    auto sep = name.find('_',start);
    auto sep2 = name.find('_',sep+1);
 
    std::string first  = name.substr(start, sep - start);
    std::string second;
    std::string third;
    if (sep2 == std::string::npos) {
        // Only one underscore after Helper_
        second = name.substr(sep + 1);
    } else {
        second = name.substr(sep + 1, sep2 - sep - 1);
        third  = name.substr(sep2 + 1);
    }
    // coverity[copy_constructor_call]
    return {first, second, third};
}
 
// get the resolution type (pull or res) - taken from the prefix of the 2D histo name 
std::string getResoType(const TObject* resHelper){
    std::string aux{resHelper->GetName()};
    return aux.substr(0, aux.find("Helper")); 
}
 
// clone an existing histogram of a known name 
TH1* cloneExisting(const std::string & name){
    auto *h = gDirectory->Get(name.c_str()); 
    if (!h){ 
        std::cerr << "Could not find existing histogram "<<name<<" - will not postprocess "<<std::endl; 
        return nullptr;
    }
    auto *ret = dynamic_cast<TH1*>(h->Clone(name.c_str()));
    if (!ret){ 
        std::cerr << "Found an existing object "<<name<<", but it is not a histogram ("<<h->IsA()->GetName()<<") - will not postprocess "<<std::endl; 
    }
    return ret; // will also catch ret == nullptr
}
 
// get the names of the 1D histograms following IDPVM conventions. 
std::pair<std::string, std::string> getPullAndResoNames(const std::string & type){
  if (type == "res"){
    return {"resolution","resmean"}; 
  }
  else if (type == "pull"){
    return {"pullwidth","pullmean"}; 
  }
  else {
    std::cerr << " Not able to identify the histogram names for a resolution type "<<type<<" - supported are 'res' and 'pull'. "<<std::endl;
  }
  return {"",""}; 
}
 
int postProcessHistos(TObject* resHelper, IDPVM::ResolutionHelper & theHelper){
    // here we have to rely on the naming conventions of IDPVM to identify what we are looking at 
    auto vars = getObservableAndResoAndSuffix(resHelper);
    auto type = getResoType(resHelper); 
    // cast to TH2
    TH2* resHelper2D = dynamic_cast<TH2*>(resHelper); 
    if (!resHelper2D){
        std::cerr <<"Unable to reduce the histogram "<<resHelper->GetName()<<" to a TH2 - this histo can not yet be postprocessed! " <<std::endl; 
        return 1; 
    }
    const auto & oneDimNames = getPullAndResoNames(type);  
    // get the corresponding 1D histos by cloning the existing ones in the same folder
    std::string suffix = "_vs_"+vars[0]+"_"+vars[1];
    if(!vars[2].empty()) suffix += "_" + vars[2];
    TH1* h_width = cloneExisting(oneDimNames.first+suffix);
    TH1* h_mean = cloneExisting(oneDimNames.second+suffix);
    // then call the resolution helper as done in "online" IDPVM
    theHelper.makeResolutions(resHelper2D, h_width, h_mean); 
    // update our 1D histos 
    h_width->Write();
    h_mean->Write();
    // and we are done
    return 0;
}
 
// recursively parse a directory tree, post-processing any histos seen along the way 
int postProcessDir(TDirectory* dir, IDPVM::ResolutionHelper & theHelper){
 
  int outcome = 0; 
  auto theCWD = gDirectory; 
  // walk through all keys in this directory 
  dir->cd();
  auto *keys = dir->GetListOfKeys();
  for (auto *const key : *keys){
    // Check if it's a directory and handle separately
    TDirectory* theDir = dynamic_cast<TDirectory*>(dir->Get(key->GetName()));
    if (theDir){
      outcome |= postProcessDir(theDir, theHelper);
      continue;  // Do NOT delete directories, ROOT manages them
    }
 
    // If it's a histogram, wrap it in a unique_ptr
    std::unique_ptr<TObject> gotIt(dir->Get(key->GetName()));
    if (isResolutionHelper(gotIt.get())){
      outcome |= postProcessHistos(gotIt.get(), theHelper);
    }
  }
  theCWD->cd();
  return outcome;
}
 
// function driving the postprocessing for this file
int pproc_file(const std::string & p_infile) {
 
    IDPVM::ResolutionHelper theHelper; 
 
    std::unique_ptr<TFile> infile(TFile::Open(p_infile.c_str(),"UPDATE"));
    if (!infile || infile->IsZombie()) {
      std::cerr << "could not open input file "<<p_infile<<" for updating "<< std::endl;
      return 1;
    }
 
    int res = postProcessDir(infile.get(), theHelper); // recursively post-process the directory tree, starting from the root.  
    return res;
}
 
 
int main(int argc, char* argv[]) {
  
  std::string infile{""}; 
  if (argc == 2){
     infile  = argv[1];
  }
  else if (argc == 4 && std::string(argv[1]) == std::string{"-f"}){
    gSystem->CopyFile(argv[3],argv[2],true); 
    infile = argv[2]; 
  }
  else {
    std::cerr<<" Usage: postProcessIDPVMHistos <File to post-process>"<<std::endl;
    std::cerr<< "    where the file is typically obtained by hadding" << std::endl;
    std::cerr<< "    outputs of several independent IDPVM runs." << std::endl;
    std::cerr<<" Alternative usage: postProcessIDPVMHistos -f <desired output file name> <File to post-process>"<<std::endl;
    std::cerr<< "    imitates a hadd-like signature for PhysVal merging." << std::endl;
    return 1; 
  }
  if (!file_exists(infile)) {
    std::cerr << "Error: invalid input file: " << infile << std::endl;
    return 1;
  }
  std::cout << " Post-processing file " << infile << "\n" << std::endl;
  return pproc_file(infile);
}