TrigGlobalEfficiencyCorrectionTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// contact: jmaurer@cern.ch
 
#ifndef TRIGGLOBALEFFICIENCYCORRECTION_TRIGGLOBALEFFICIENCYCORRECTIONTOOL_H
#define TRIGGLOBALEFFICIENCYCORRECTION_TRIGGLOBALEFFICIENCYCORRECTIONTOOL_H 1
 
#include "TriggerAnalysisInterfaces/ITrigGlobalEfficiencyCorrectionTool.h"
 
#include "AsgTools/ToolHandleArray.h"
#include "AsgTools/AsgTool.h"
#include "EgammaAnalysisInterfaces/IAsgElectronEfficiencyCorrectionTool.h"
#include "MuonAnalysisInterfaces/IMuonTriggerScaleFactors.h"
#include "EgammaAnalysisInterfaces/IAsgPhotonEfficiencyCorrectionTool.h"
#include "AthContainers/AuxElement.h"
#include "TriggerMatchingTool/IMatchingTool.h"
#include "xAODEgamma/PhotonFwd.h"
 
#include <string>
#include <vector>
#include <map>
#include <set>
#include <boost/container/container_fwd.hpp>
#include <memory>
 
 
namespace TrigGlobEffCorr
{
    class ImportData;
    class Calculator;
    class CheckConfig;
    class Efficiencies;
    class Lepton;
}
 
class TrigGlobalEfficiencyCorrectionTool: public asg::AsgTool, public virtual ITrigGlobalEfficiencyCorrectionTool
{
public: 
    ASG_TOOL_CLASS(TrigGlobalEfficiencyCorrectionTool,ITrigGlobalEfficiencyCorrectionTool)
 
    TrigGlobalEfficiencyCorrectionTool(const std::string& name);
    virtual ~TrigGlobalEfficiencyCorrectionTool();
 
    virtual StatusCode  initialize() override;
 
    virtual CP::CorrectionCode getEfficiencyScaleFactor(const std::vector<const xAOD::IParticle*>& particles, double& efficiencyScaleFactor) override;
    virtual CP::CorrectionCode getEfficiencyScaleFactor(unsigned runNumber, const std::vector<const xAOD::IParticle*>& particles, double& efficiencyScaleFactor) override;
    virtual CP::CorrectionCode getEfficiency(const std::vector<const xAOD::IParticle*>& particles, double& efficiencyData, double& efficiencyMc) override;
    virtual CP::CorrectionCode getEfficiency(unsigned runNumber, const std::vector<const xAOD::IParticle*>& particles, double& efficiencyData, double& efficiencyMc) override;  
    
    virtual bool isAffectedBySystematic(const CP::SystematicVariation& systematic) const override;
    virtual CP::SystematicSet affectingSystematics() const override;
    virtual CP::SystematicSet recommendedSystematics() const override;
    virtual StatusCode applySystematicVariation(const CP::SystematicSet& systConfig) override;
 
    virtual CP::CorrectionCode checkTriggerMatching(bool& matched, const std::vector<const xAOD::IParticle*>& particles) override;
    virtual CP::CorrectionCode getRelevantTriggers(std::vector<std::string>& triggers) override;
    virtual CP::CorrectionCode countTriggerLegs(const std::string& trigger, std::size_t& numberOfLegs) override;
    
    static CP::CorrectionCode suggestElectronMapKeys(const std::map<std::string,std::string>& triggerCombination,
        const std::string& version, std::map<std::string,std::string>& legsPerKey)
    {
        return suggestEgammaMapKeys(triggerCombination, version, legsPerKey, xAOD::Type::Electron);
    }
    static CP::CorrectionCode suggestPhotonMapKeys(const std::map<std::string,std::string>& triggerCombination,
        const std::string& version, std::map<std::string,std::string>& legsPerKey)
    {
        return suggestEgammaMapKeys(triggerCombination, version, legsPerKey, xAOD::Type::Photon);
    }
    static CP::CorrectionCode suggestEgammaMapKeys(const std::map<std::string,std::string>& triggerCombination,
        const std::string& version, std::map<std::string,std::string>& legsPerKey, xAOD::Type::ObjectType type);
        
private: 
 
    struct Hierarchy
    {
        short offset, nLegs;
        float minPt, maxPt;
    };
    struct TagDecorator
    {
        SG::AuxElement::ConstAccessor<char> decorator;
        std::size_t hash;
        bool suffixed;
        // cppcheck-suppress uninitMemberVar; false positive (https://trac.cppcheck.net/ticket/13444)
        TagDecorator(const std::string& name, std::size_t the_hash, bool suffixed) : decorator(name), hash(the_hash), suffixed(suffixed) {}
    };
    struct CachedRanking
    {
        float minPt, maxPt;
        unsigned long ranking;
        operator bool() const { return ranking+1; }
        static bool invalid(unsigned long ranking) { return !(ranking+1); }
    };
    struct ToolKey
    {
        std::size_t hash;
        std::pair<unsigned,unsigned> boundaries;
        bool operator<(const ToolKey& rhs) const { return hash<rhs.hash || (hash==rhs.hash && boundaries.second<rhs.boundaries.first); }
        bool operator==(const ToolKey& rhs) const { return hash==rhs.hash && boundaries.second>=rhs.boundaries.first && rhs.boundaries.second>=boundaries.first; }
        // cppcheck-suppress uninitMemberVar; false positive (https://trac.cppcheck.net/ticket/13444)
        ToolKey(std::size_t leg, std::size_t tag, unsigned runNumber) : hash(leg^tag), boundaries(runNumber, runNumber) {}
        // cppcheck-suppress uninitMemberVar; false positive (https://trac.cppcheck.net/ticket/13444)
        ToolKey(std::size_t leg, std::size_t tag, std::pair<unsigned,unsigned> bounds) : hash(leg^tag), boundaries(bounds) {}
        // cppcheck-suppress uninitMemberVar; false positive (https://trac.cppcheck.net/ticket/13444)
        ToolKey(std::size_t leg = 0, std::size_t tag = 0) : hash(leg^tag), boundaries(0, 999999) {}
    };
    using LeptonList = std::vector<TrigGlobEffCorr::Lepton>;
    
    ToolHandleArray<IAsgElectronEfficiencyCorrectionTool> m_suppliedElectronEfficiencyTools;
    ToolHandleArray<IAsgElectronEfficiencyCorrectionTool> m_suppliedElectronScaleFactorTools;
    ToolHandleArray<IAsgPhotonEfficiencyCorrectionTool> m_suppliedPhotonEfficiencyTools;
    ToolHandleArray<IAsgPhotonEfficiencyCorrectionTool> m_suppliedPhotonScaleFactorTools;
    ToolHandleArray<CP::IMuonTriggerScaleFactors> m_suppliedMuonTools;
    std::map<std::string, std::string> m_legsPerTool;
    std::map<std::string, std::string> m_triggerCb;
    std::map<std::string, std::string> m_triggerCbPerYear;
    std::string m_leptonTagDecorations;
    std::map<std::string, std::string> m_tagsPerTool;
    std::map<std::string, std::string> m_electronLegsPerTag; 
    std::map<std::string, std::string> m_muonLegsPerTag; 
    std::map<std::string, std::string> m_legsPerTag;
    std::map<std::string, std::string> m_overrideThresholds;
    unsigned long m_numberOfToys;
    bool m_useInternalSeed;
    ToolHandle<Trig::IMatchingTool> m_trigMatchTool;
 
    std::hash<std::string> m_hasher; 
    std::map<std::size_t,float > m_thresholds; 
    std::multimap<std::size_t, CachedRanking> m_cachedLegRankings; 
    std::map<ToolKey, std::size_t > m_electronSfToolIndex; 
    std::map<ToolKey, std::size_t > m_electronEffToolIndex; 
    std::map<ToolKey, std::size_t > m_photonSfToolIndex; 
    std::map<ToolKey, std::size_t > m_photonEffToolIndex; 
    std::map<ToolKey, std::size_t > m_muonToolIndex; 
    std::set<std::size_t> m_validLegTagPairs; 
    bool m_checkElectronLegTag; 
    bool m_checkMuonLegTag; 
    bool m_checkPhotonLegTag; 
    std::map<std::size_t, std::string> m_dictionary; 
    std::set<ToolKey> m_unsupportedLegs; 
    
    std::vector<Hierarchy> m_hierarchyMeta; 
    std::vector<std::size_t> m_hierarchyData; 
    
    bool m_initialized = false; 
    CP::CorrectionCode m_cpCode = CP::CorrectionCode::Ok; 
    unsigned long m_seed;
    bool m_validTrigMatchTool; 
    
    std::vector<TagDecorator> m_leptonTagDecorators; 
    SG::AuxElement::ConstAccessor<unsigned int> m_runNumberDecorator; 
    std::unique_ptr<TrigGlobEffCorr::Calculator> m_calculator; 
    
    template<typename Key> using flat_set = boost::container::flat_set<Key>;
 
    bool loadHierarchies();
    template<class CPTool> bool enumerateTools(TrigGlobEffCorr::ImportData& data, ToolHandleArray<CPTool>& suppliedTools,
        std::map<ToolKey, std::size_t>& toolIndex, flat_set<std::size_t>& collectedTags);
    flat_set<ToolKey> parseListOfLegs(TrigGlobEffCorr::ImportData& data, const std::string& inputList, bool& success);
    bool parseTagString(const std::string& tagstring, flat_set<std::size_t>& tags);
    bool loadTriggerCombination(TrigGlobEffCorr::ImportData& data, bool useDefaultElectronTools, bool useDefaultPhotonTools);
    bool loadTagDecorators(const flat_set<std::size_t>& collectedElectronTags, const flat_set<std::size_t>& collectedMuonTags, const flat_set<std::size_t>& collectedPhotonTags);
    bool loadListOfLegsPerTag();
    bool processDeprecatedProperties();
    
    bool retrieveRunNumber(unsigned& runNumber);
    bool retrieveEventNumber(unsigned long& eventNumber);
    bool aboveThreshold(const TrigGlobEffCorr::Lepton& p,std::size_t leg) const;
    template<class... ListOfLegs> unsigned long getCachedTriggerLegsRanking(const TrigGlobEffCorr::Lepton& lepton, ListOfLegs... legs);
    std::size_t getLoosestLegAboveThreshold(const TrigGlobEffCorr::Lepton& lepton, const flat_set<std::size_t>& legs, bool& success);
    std::size_t getLoosestLeg(const TrigGlobEffCorr::Lepton& lepton, std::size_t leg1, std::size_t leg2, bool& success);
    std::pair<std::size_t,std::size_t> getTwoLoosestLegs(const TrigGlobEffCorr::Lepton& lepton, const flat_set<std::size_t>& legs, bool& success);
    std::vector<std::size_t> getSortedLegs(const TrigGlobEffCorr::Lepton& lepton, const flat_set<std::size_t>& legs, bool& success);
    template<class Container> CachedRanking rankTriggerLegs(float pt, const Container& legs);
    template<class Particle> bool updateLeptonList(LeptonList& leptons, const std::vector<const Particle*>& particles);
    void updateMuonTriggerNames(std::size_t leg, const std::string& name);
    enum TLE_RESULT
    {
        TLE_OK,
        TLE_UNAVAILABLE,
        TLE_ERROR
    };
    TLE_RESULT getTriggerLegEfficiencies(const xAOD::Electron* p, unsigned runNumber, std::size_t leg, std::size_t tag, TrigGlobEffCorr::Efficiencies& efficiencies);
    TLE_RESULT getTriggerLegEfficiencies(const xAOD::Muon* p, unsigned runNumber, std::size_t leg, std::size_t tag, TrigGlobEffCorr::Efficiencies& efficiencies);
    TLE_RESULT getTriggerLegEfficiencies(const xAOD::Photon* p, unsigned runNumber, std::size_t leg, std::size_t tag, TrigGlobEffCorr::Efficiencies& efficiencies);
    template<class ParticleType>
    TLE_RESULT getEgammaTriggerLegEfficiencies(const ParticleType* p, unsigned runNumber, std::size_t leg, std::size_t tag, TrigGlobEffCorr::Efficiencies& efficiencies);
    decltype(m_electronSfToolIndex)& GetScaleFactorToolIndex(const xAOD::Electron*) { return m_electronSfToolIndex; }
    decltype(m_photonSfToolIndex)& GetScaleFactorToolIndex(const xAOD::Photon*) { return m_photonSfToolIndex; }
    decltype(m_electronEffToolIndex)& GetEfficiencyToolIndex(const xAOD::Electron*) { return m_electronEffToolIndex; }
    decltype(m_photonEffToolIndex)& GetEfficiencyToolIndex(const xAOD::Photon*) { return m_photonEffToolIndex; }
    IAsgElectronEfficiencyCorrectionTool& GetScaleFactorTool(const xAOD::Electron*, std::size_t index)
        { return *m_suppliedElectronScaleFactorTools[index]; }
    IAsgPhotonEfficiencyCorrectionTool& GetScaleFactorTool(const xAOD::Photon*, std::size_t index)
        { return *m_suppliedPhotonScaleFactorTools[index]; }
    IAsgElectronEfficiencyCorrectionTool& GetEfficiencyTool(const xAOD::Electron*, std::size_t index)
        { return *m_suppliedElectronEfficiencyTools[index]; }
    IAsgPhotonEfficiencyCorrectionTool& GetEfficiencyTool(const xAOD::Photon*, std::size_t index)
        { return *m_suppliedPhotonEfficiencyTools[index]; }
    std::size_t getCombinedHash(const flat_set<std::size_t>& legs);
    std::size_t getCombinedHash(std::size_t leg1, std::size_t leg2);
    static inline constexpr const flat_set<std::size_t>& forwardLegs(const flat_set<std::size_t>& legs);
    static inline constexpr std::array<std::size_t, 2> forwardLegs(std::size_t leg1, std::size_t leg2);
    
    inline bool checkAndRecord(CP::CorrectionCode&& cc);
    flat_set<std::size_t> listNonOrderedCSValues(const std::string& s, bool& success);
 
    friend class TrigGlobEffCorr::ImportData;
    friend class TrigGlobEffCorr::CheckConfig;
    friend class TrigGlobEffCorr::Calculator;
};
 
#endif