IIsolationCloseByCorrectionTool.h

Go to the documentation of this file.

/*
 Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef ISOLATIONSELECTION_IISOLATIONCLOSEBYCORRECTIONTOOL_H
#define ISOLATIONSELECTION_IISOLATIONCLOSEBYCORRECTIONTOOL_H
 
#include <AsgDataHandles/ReadHandleKey.h>
#include <AsgTools/IAsgTool.h>
#include <AsgTools/CurrentContext.h>
#include <CxxUtils/checker_macros.h>
#include <IsolationSelection/Defs.h>
#include <PATCore/AcceptData.h>
#include <PATCore/AcceptInfo.h>
#include <PATInterfaces/CorrectionCode.h>
#include <xAODEgamma/ElectronContainer.h>
#include <xAODEgamma/PhotonContainer.h>
#include <xAODMuon/MuonContainer.h>
#include <xAODPFlow/FlowElementContainer.h>
 
class EventContext;
 
namespace CP {
    class IIsolationCloseByCorrectionTool : public virtual asg::IAsgTool {
        ASG_TOOL_INTERFACE(CP::IIsolationCloseByCorrectionTool)
    public:
        // This function calculates and applies (the particle is not redecorated) the corrections for close-by objects for each isolation
        // variables and tests whether the particle passes the isolation working point after the corrections. Note that to use this
        // functionality, a IsolationSelectionTool must have been passed to the tool (which must have been intialised indicating which
        // isolation working point to use). The result returned is a AcceptData object which is the decision made by the tool with respect
        // to the particle passing the working point.
        virtual asg::AcceptData acceptCorrected(const xAOD::IParticle& x, const xAOD::IParticleContainer& closePar) const = 0;
 
        // This function calculates the values of the corrections for close-by objects to be applied to the isolation variables (without
        // redecorating the particles). The corrections are returned in a vector (one correction per isolation type provided). This function
        // is intended for experts only who want to check the effects of the corrections.
        virtual CorrectionCode getCloseByCorrection(std::vector<float>& corrections, const xAOD::IParticle& par,
                                                    const std::vector<xAOD::Iso::IsolationType>& types,
                                                    const xAOD::IParticleContainer& closePar) const = 0;
 
        // This function calculates the values of the corrections for close-by objects and applies them to the isolation variables and
        // writes them out as a new decoration of the particles. This requires a suffix to be specified for the new decoration, otherwise 
        // an ERROR will be returned.
        virtual CorrectionCode getCloseByIsoCorrection (
                                                        const EventContext& ctx,
                                                        const xAOD::ElectronContainer* Electrons = nullptr, 
                                                        const xAOD::MuonContainer* Muons = nullptr,
                                                        const xAOD::PhotonContainer* Photons = nullptr
                                                        ) const = 0;
        virtual float getOriginalIsolation(const xAOD::IParticle& P, IsoType type) const = 0;
        virtual float getOriginalIsolation(const xAOD::IParticle* P, IsoType type) const = 0;

        virtual void associateCluster(const xAOD::IParticle* particle, float& eta, float& phi, float& energy) const = 0;
 
        virtual void associateFlowElement(const EventContext& ctx, const xAOD::IParticle* particle, float& eta, float& phi,
                                          float& energy) const = 0;

        virtual TrackSet getTrackCandidates(const EventContext& ctx, const xAOD::IParticle* particle) const = 0;

        virtual const xAOD::IParticle* isoRefParticle(const xAOD::IParticle* particle) const = 0;
 
        virtual ~IIsolationCloseByCorrectionTool() = default;
    };
 
}  // namespace CP
#endif