IMuonLRTOverlapRemovalTool.h

Go to the documentation of this file.

/*
 Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef IMUONLRTOVERLAPREMOVALTOOL__H
#define IMUONLRTOVERLAPREMOVALTOOL__H
 
// Framework include(s):
#include "AsgTools/IAsgTool.h"
 
// EDM include(s):
#include <xAODEventInfo/EventInfo.h>
 
#include "xAODMuon/Muon.h"
#include "xAODMuon/MuonContainer.h"
 
// Local include(s):

namespace CP {
 
    class   IMuonLRTOverlapRemovalTool : public virtual asg::IAsgTool {
 
        ASG_TOOL_INTERFACE(CP::IMuonLRTOverlapRemovalTool)
 
        public:

        typedef enum {
            defaultStrategy=0, //default strategy which does a basic overlap removal.
            passThroughAndDecorate=1 //writes all the muons in the combined container irrespective of overlap, 
                                //and adds a decoration `MuonLRTOverlapDecision` which contains overlap information for all muons.
        } overlapStrategy;

        virtual std::pair<bool, bool> resolveOverlap(const xAOD::Muon* promptMuon,
                                                   const xAOD::Muon* lrtMuon) const = 0;

        virtual std::tuple<int, int> checkOverlapForDecor(const xAOD::Muon* promptMuon,
                                                           const xAOD::Muon* lrtMuon) const = 0;

        virtual void checkOverlap(const xAOD::MuonContainer & promptCollection,
                                  const xAOD::MuonContainer & lrtCollection,
                                  std::vector<bool>& promptMuonsSelectedToKeep,
                                  std::vector<bool>& lrtMuonsSelectedToKeep ) const = 0;

        virtual bool hasOverlap(const xAOD::Muon* promptMuon,
                              const xAOD::Muon* lrtMuon) const = 0;                              
    };
    // class IMuonLRTOverlapRemovalTool
 
}  // namespace CP
 
#endif /* IMUONLRTOVERLAPREMOVALTOOL__H */