METNet.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
// Author: Bill Balunas <balunas@cern.ch>, based on earlier implementation by M. Leigh
 
#ifndef METUTILITIES_MET_METNET_H
#define METUTILITIES_MET_METNET_H
 
// STL includes
#include <string>
 
// Asg tool includes
#include "AsgTools/AsgTool.h"
#include "AsgTools/ToolHandle.h"
#include "AsgTools/PropertyWrapper.h"
#include "AsgDataHandles/ReadHandleKey.h"
 
// EDM includes
#include "xAODEventInfo/EventInfo.h"
#include "xAODTracking/VertexContainer.h"
 
// METInterface includes
#include "METInterface/IMETMaker.h"
 
// Network handler
#include "METNetHandler.h"
 
// Forward declarations
class IMETMaker;
class METNetHandler;
 
namespace met {
 
  class METNet final: public asg::AsgTool, virtual public IMETMaker {
 
    // This macro defines the constructor with the interface declaration
    ASG_TOOL_CLASS( METNet, IMETMaker )
 
  public:
 
    METNet( const std::string& name );
 
    virtual ~METNet() = default;
 
    virtual StatusCode initialize() override;
 
    // Adds a collection of objects to the core MET container, must be done for photons, elections and muons.
    virtual StatusCode rebuildMET( const std::string& metKey,
                         xAOD::Type::ObjectType metType,
                         xAOD::MissingETContainer* metCont,
                         const xAOD::IParticleContainer* collection,
                         xAOD::MissingETAssociationHelper& helper,
                         MissingETBase::UsageHandler::Policy objScale ) const override;
 
    // Adds multiple jet definitions to seperate MET containers and creates the collection of input features for the neural network
    virtual StatusCode rebuildJetMET( const std::string& metJetKey,
                         const std::string& softTrkKey,
                         xAOD::MissingETContainer* metCont,
                         const xAOD::JetContainer* jets,
                         const xAOD::MissingETContainer* metCoreCont,
                         xAOD::MissingETAssociationHelper& helper,
                         bool doJetJVT = false) const override;
 
    // Uses ONNX runtime to propagate the input features created in rebuildJetMET through the trained network
    virtual StatusCode evaluateNNMET( const std::string& totalName,
                         xAOD::MissingETContainer* metCont ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildMET( xAOD::MissingET* met,
                         const xAOD::IParticleContainer* collection,
                         xAOD::MissingETAssociationHelper& helper,
                         MissingETBase::UsageHandler::Policy objScale ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildMET( xAOD::MissingET* met,
                         const xAOD::IParticleContainer* collection,
                         xAOD::MissingETAssociationHelper& helper,
                         MissingETBase::UsageHandler::Policy p,
                         bool removeOverlap,
                         MissingETBase::UsageHandler::Policy objScale ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildJetMET( const std::string& metJetKey,
                         const std::string& softClusKey,
                         const std::string& softTrkKey,
                         xAOD::MissingETContainer* metCont,
                         const xAOD::JetContainer* jets,
                         const xAOD::MissingETContainer* metCoreCont,
                         xAOD::MissingETAssociationHelper& helper,
                         bool doJetJVT ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildJetMET( xAOD::MissingET* metJet,
                         const xAOD::JetContainer* jets,
                         xAOD::MissingETAssociationHelper& helper,
                         xAOD::MissingET* metSoftClus,
                         const xAOD::MissingET* coreSoftClus,
                         xAOD::MissingET* metSoftTrk,
                         const xAOD::MissingET* coreSoftTrk,
                         bool doJetJVT,
                         bool tracksForHardJets = false,
                         std::vector<const xAOD::IParticle*>* softConst = 0 ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildTrackMET( const std::string& metJetKey,
                         const std::string& softTrkKey,
                         xAOD::MissingETContainer* metCont,
                         const xAOD::JetContainer* jets,
                         const xAOD::MissingETContainer* metCoreCont,
                         xAOD::MissingETAssociationHelper& helper,
                         bool doJetJVT ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode rebuildTrackMET( xAOD::MissingET* metJet,
                         const xAOD::JetContainer* jets,
                         xAOD::MissingETAssociationHelper& helper,
                         xAOD::MissingET* metSoftTrk,
                         const xAOD::MissingET* coreSoftTrk,
                         bool doJetJVT ) const override;
 
    // Unsupported method inherited from METMaker. Please do not use.
    virtual StatusCode markInvisible( const xAOD::IParticleContainer* collection,
                         xAOD::MissingETAssociationHelper& helper,
                         xAOD::MissingETContainer* metCont ) const override;
 
  private:
 
    Gaudi::Property<std::string> m_netLocation{this, "NetworkFile", "", "Location of NN file to use"};
 
    SG::ReadHandleKey<xAOD::EventInfo> m_eventInfoKey{this, "EventInfoKey", "EventInfo", "Event info key"};
    SG::ReadHandleKey<xAOD::VertexContainer> m_pvContainerKey{this, "PVContainerKey", "PrimaryVertices", "Primary vertex container"};
 
    std::unique_ptr<const METNetHandler> m_metNetHandler;
    // Users do not need to interact with these ToolHandles; they're managed by METNet
    ToolHandle<IMETMaker> m_metmaker_loose{this, "METMakerLoose",     "", "METMaker for Loose WP. Do not configure manually except for expert usage." };
    ToolHandle<IMETMaker> m_metmaker_tight{this, "METMakerTight",     "", "METMaker for Tight WP. Do not configure manually except for expert usage." };
    ToolHandle<IMETMaker> m_metmaker_tghtr{this, "METMakerTighter",   "", "METMaker for Tighter WP. Do not configure manually except for expert usage." };
    ToolHandle<IMETMaker> m_metmaker_tenac{this, "METMakerTenacious", "", "METMaker for Tenacious WP. Do not configure manually except for expert usage." };
 
    StatusCode addMETFinal( const std::string& WP_name, xAOD::MissingETContainer* met_container, std::vector<std::string>& name_vec, std::vector<float>& val_vec ) const;
    StatusCode addMETTerm( const std::string& WP_name, xAOD::MissingET* met, std::vector<std::string>& name_vec, std::vector<float>& val_vec ) const;
    StatusCode addInputValue( const std::string& var_name, float value,std::vector<std::string>& name_vec, std::vector<float>& val_vec ) const;
    StatusCode copyMETContainer( xAOD::MissingETContainer* new_container, const xAOD::MissingETContainer* old_container) const;
 
  };
 
}
 
#endif