CaloMuonScoreTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CALOTRKMUIDTOOLS_CALOMUONSCORETOOL_H
#define CALOTRKMUIDTOOLS_CALOMUONSCORETOOL_H
 
#include <memory>
#include <vector>
 
#include "AthOnnxInterfaces/IOnnxRuntimeSvc.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "ICaloTrkMuIdTools/ICaloMuonScoreTool.h"
#include "RecoToolInterfaces/IParticleCaloCellAssociationTool.h"
 
class CaloMuonScoreTool : public AthAlgTool, virtual public ICaloMuonScoreTool {
public:
    CaloMuonScoreTool(const std::string &type, const std::string &name, const IInterface *parent);
    virtual ~CaloMuonScoreTool() = default;
 
    virtual StatusCode initialize() override;
 
    // Compute the muon score given a track particle
    float getMuonScore(const xAOD::TrackParticle *trk, const CaloCellContainer *cells = nullptr,
                       const CaloExtensionCollection *extensionCache = nullptr) const override;
 
private:
    // run the ONNX inference on the input tensor
    float runOnnxInference(std::vector<float> &tensor) const;
 
    // unwrap phi values by mapping phi vectors that span the boundary
    // between pi and -pi to their 2*pi complement
    std::vector<float> unwrapPhiAngles(const std::vector<float> &v) const;
 
    // fill vectors from the particle cell association
    void fillInputVectors(std::unique_ptr<const Rec::ParticleCellAssociation> &association, std::vector<float> &eta,
                          std::vector<float> &phi, std::vector<float> &energy, std::vector<int> &samplingId) const;
 
    // Compute the median of a vector of floats (can be even or odd in length)
    float getMedian(std::vector<float> v) const;
 
    // Given a vector of bins, return the index of the matching bin
    int getBin(const float low_edge, const float up_edge, const int n_bins, float val) const;
 
    // Given a calo sampling ID (as integer), return the corresponding "RGB"-like channel ID (0,1,2,3,4,5,6)
    int channelForSamplingId(int &samplingId) const;
 
    // for a given particle, consume vectors for eta, phi, energy, sampling ID, and return the input tensor to be used in ONNX
    std::vector<float> getInputTensor(std::vector<float> &eta, std::vector<float> &phi, std::vector<float> &energy,
                                      std::vector<int> &sampling) const;
 
    Gaudi::Property<float> m_CaloCellAssociationConeSize{this, "CaloCellAssociationConeSize", 0.2,
                                                         "Size of the cone within which calo cells are associated with a track particle"};
    Gaudi::Property<int> m_etaBins{this, "etaBins", 30, "Number of bins in eta"};
    Gaudi::Property<int> m_phiBins{this, "phiBins", 30, "Number of bins in phi"};
    Gaudi::Property<float> m_etaCut{
        this, "etaCut", 0.25,
        "Eta cut on the calorimeter cells associated with the track particle after centering of the calorimeter image"};
    Gaudi::Property<float> m_phiCut{
        this, "phiCut", 0.25,
        "Phi cut on the calorimeter cells associated with the track particle after centering of the calorimeter image"};
    Gaudi::Property<int> m_nChannels{this, "nChannels", 7, "Number of colour channels in the convolutional neural network"};
 
    ToolHandle<Rec::IParticleCaloCellAssociationTool> m_caloCellAssociationTool{this, "ParticleCaloCellAssociationTool", ""};
 
    ServiceHandle<AthOnnx::IOnnxRuntimeSvc> m_svc{this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "CaloMuonScoreTool ONNXRuntimeSvc"};
 
    std::unique_ptr<Ort::Session> m_session;
 
    std::vector<const char *> m_input_node_names;
 
    std::vector<const char *> m_output_node_names;
 
    std::vector<int64_t> m_input_node_dims;
 
    // This path needs to point to the ATLAS calibration area (https://atlas-groupdata.web.cern.ch/atlas-groupdata/)
    // It needs to be a full path relative to the root of the calibration area, e.g. `CaloTrkMuIdTools/nnBased_201022/CaloMuonCNN_1.onnx`
    Gaudi::Property<std::string> m_modelFileName{this, "ModelFileName", "CaloTrkMuIdTools/nnBased_201022/CaloMuonCNN_1.onnx"};
 
    Gaudi::Property<double> m_CaloMuonEtaCut{this, "CaloMuonEtaCut", 1.0,
                                             "Eta cut (absolute value) up to which a track particle's muon score will be calculated"};
};
 
#endif