TElectronEfficiencyCorrectionTool.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
/*
   Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ELECTRONEFFICIENCYCORRECTION_TELECTRONEFFICIENCYCORRECTIONTOOL_H
#define ELECTRONEFFICIENCYCORRECTION_TELECTRONEFFICIENCYCORRECTIONTOOL_H

 
// STL includes
#include <array>
#include <map>
#include <memory>
#include <string>
#include <vector>
// ROOT includes
#include "TH1.h"
#include "TH2.h"
#include "TObjArray.h"
#include "TRandom3.h"
// Core includes
#include "AsgMessaging/AsgMessaging.h"
#include "PATCore/PATCoreEnums.h"
 
namespace Root {
class TElectronEfficiencyCorrectionTool : public asg::AsgMessaging
{
public:
  //We want to have unique ownership of the Histos
  using HistArray = std::vector<std::unique_ptr<TH1>>;
 
  // The Result
  struct Result {
    double SF = 0;
    double Total = 0;
    double Stat = 0;
    double UnCorr = 0;
    std::vector<double> Corr{};
    std::vector<double> toys{};
    int histIndex = -1;
    int histBinNum = -1;
  };

  TElectronEfficiencyCorrectionTool(
    const char* name = "TElectronEfficiencyCorrectionTool");

  ~TElectronEfficiencyCorrectionTool() = default;

  inline void addFileName(const std::string& val) {
    m_corrFileNameList.push_back(val);
  }

  inline void bookToyMCScaleFactors(const int nToyMC) {
    m_doToyMC = true;
    m_nToyMC = nToyMC;
  }
  inline void bookCombToyMCScaleFactors(const int nToyMC) {
    m_doCombToyMC = true;
    m_nToyMC = nToyMC;
  }

  int initialize();

  int calculate(const PATCore::ParticleDataType::DataType dataType,
                const unsigned int runnumber, 
                const double cluster_eta,
                const double et, /* in MeV */
                Result& result,
                const bool onlyTotal = false) const;

  int getNbins(std::map<float, std::vector<float>>& ptEta) const;

  inline int getNSyst() const { return m_nSysMax; }

  inline void setSeed(const unsigned long int seed) { m_seed = seed; }

  bool uncorrEmpty(const PATCore::ParticleDataType::DataType dataType);
 
private:
  // Private methods
  int getHistograms();
 
  int setupHistogramsInFolder(const TObjArray& dirNameArray, int lastIdx);
 
  bool setupUncorrToySyst(std::vector<std::vector<TH1*>>& objs,
                          std::vector<std::vector<TH1*>>& sysObjs,
                          std::vector<std::vector<HistArray>>& uncorrToyMCSyst);
 
  std::vector<HistArray> buildToyMCTable(
    const std::vector<TH1*>& sf,
    const std::vector<TH1*>& eig,
    const std::vector<TH1*>& stat,
    const std::vector<TH1*>& uncorr,
    const std::vector<std::vector<TH1*>>& corr);
 
  std::vector<TH2*> buildSingleToyMC(const TH1* sf,
                                     const TH1* stat,
                                     const TH1* uncorr,
                                     const std::vector<TH1*>& corr,
                                     int& randomCounter);
 
  TH2* buildSingleCombToyMC(const TH1* sf,
                            const TH1* stat,
                            const TH1* uncorr,
                            const std::vector<TH1*>& corr,
                            const int nSys,
                            int& randomCounter);
 
  void setupTempMapsHelper(TH1* obj,
                           std::vector<std::vector<TH1*>>& objs,
                           std::vector<std::vector<TH1*>>& sysObjs,
                           int& seenSystematics);

  int setup(const std::vector<TH1*>& hists,
            std::vector<HistArray>& histList,
            std::vector<unsigned int>& beginRunNumberList,
            std::vector<unsigned int>& endRunNumberList,
            const int runNumBegin,
            const int runNumEnd) const;
 
  struct HistEdge {
    double etaMax = 0;
    double etaMin = 0;
    double etMax = 0;
    double etMin = 0;
    bool isLowPt = false;
  };
 
  static void fillHistEdges(const std::vector<HistArray>& sfPerPeriodHist,
                     std::vector<std::vector<HistEdge>>& sfPerPeriodEdges) ;

    bool m_doToyMC;
    bool m_doCombToyMC;
    int m_nToyMC;
    unsigned long int m_seed;
    int m_nSysMax;
    // The representation of the prepared toy SF tables
    std::vector<std::vector<HistArray>> m_uncorrToyMCSystFull;
    std::vector<std::vector<HistArray>> m_uncorrToyMCSystFast;
    std::vector<std::string> m_corrFileNameList;
    std::vector<unsigned int> m_begRunNumberList;
    std::vector<unsigned int> m_endRunNumberList;
    std::vector<unsigned int> m_begRunNumberListFastSim;
    std::vector<unsigned int> m_endRunNumberListFastSim;
    std::vector<std::vector<HistArray>> m_histList;
    std::vector<std::vector<HistEdge>> m_histEdges;
    std::vector<std::vector<HistArray>> m_sysList;
    std::vector<std::vector<HistArray>> m_fastHistList;
    std::vector<std::vector<HistEdge>> m_fastHistEdges;
    std::vector<std::vector<HistArray>> m_fastSysList;
    // The Random generator class
    TRandom3 m_Rndm;
  };  // End: class definition
} // End: namespace Root
 
#endif