InDetNNScoringTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
// Markus Elsing
 
#ifndef INDETNNSCORINGTOOL_H
#define INDETNNSCORINGTOOL_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "StoreGate/ReadHandleKey.h"
#include "TrkCaloClusterROI/ROIPhiRZContainer.h"
#include "TrkEventPrimitives/TrackScore.h"
#include "TrkToolInterfaces/ITrackScoringTool.h"
#include "lwtnn/lightweight_network_config.hh"
#include "lwtnn/LightweightNeuralNetwork.hh"
#include "lwtnn/LightweightGraph.hh"
#include "lwtnn/parse_json.hh"
#include "PathResolver/PathResolver.h"
#include "TrkParameters/TrackParameters.h"
#include "AthenaKernel/CLASS_DEF.h"
#include "AthenaKernel/IOVSvcDefs.h"
// MagField cache
#include "MagFieldConditions/AtlasFieldCacheCondObj.h"
#include "MagFieldElements/AtlasFieldCache.h"
#include <fstream>
#include <vector>
#include <string>
#include "BeamSpotConditionsData/BeamSpotData.h"
 
namespace Trk {
  class IExtrapolator;
  class Track;
  class TrackSummary;
 
}
class EventContext;
 
namespace InDet {
class ITrtDriftCircleCutTool;
 
class InDetNNScoringTool : virtual public Trk::ITrackScoringTool,  
                             public AthAlgTool
{
 
 public:
  InDetNNScoringTool(const std::string&,const std::string&,const IInterface*);
  virtual ~InDetNNScoringTool () = default;
  virtual StatusCode initialize() override;
  virtual Trk::TrackScore score( const Trk::Track& track ) const override;
  
  virtual Trk::TrackScore simpleScore( const Trk::Track& track, const Trk::TrackSummary& trackSum ) const override;
  Trk::TrackScore  ambigScore( const Trk::Track& track, const Trk::TrackSummary& trackSum ) const;
  Trk::TrackScore calcNnScore( const Trk::Track &track, const Trk::TrackSummary& trackSum , const Trk::Perigee *extrapolatedPerigee) const;
  
 
 private:
  void setupScoreModifiers();
  
    // DNN tools
    std::unique_ptr<lwt::LightweightGraph> m_graph;
    std::map<std::string, double> m_DNN_inputValues;
  
  bool isEmCaloCompatible(const Trk::Track& track, const EventContext& ctx) const;
  
  
  //these are used for ScoreModifiers 
  int m_maxDblHoles, m_maxPixHoles, m_maxSCT_Holes,  m_maxHits, m_maxSigmaChi2, m_maxTrtRatio, m_maxTrtFittedRatio,
    m_maxB_LayerHits, m_maxPixelHits, m_maxPixLay,  m_maxGangedFakes;
  std::vector<double> m_factorDblHoles, m_factorPixHoles, m_factorSCT_Holes,  m_factorHits,
    m_factorSigmaChi2, m_factorB_LayerHits, m_factorPixelHits, m_factorPixLay, m_factorGangedFakes;
  std::vector<double> m_boundsSigmaChi2,
    m_boundsTrtRatio, m_factorTrtRatio, m_boundsTrtFittedRatio, m_factorTrtFittedRatio;
 
  ToolHandle<ITrtDriftCircleCutTool>          m_selectortool;
  
  std::vector<Trk::TrackScore>           m_summaryTypeScore;
  
  SG::ReadCondHandleKey<InDet::BeamSpotData> m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" };
  
  ToolHandle<Trk::IExtrapolator>         m_extrapolator;
 
  // Read handle for conditions object to get the field cache
  SG::ReadCondHandleKey<AtlasFieldCacheCondObj> m_fieldCacheCondObjInputKey {this, "AtlasFieldCacheCondObj", "fieldCondObj", "Name of the Magnetic Field conditions object key"};
 
  
  bool m_useAmbigFcn;
  bool m_useTRT_AmbigFcn;
  bool m_useSigmaChi2;
  std::string m_nnCutConfig;
  double m_nnCutThreshold;
  
  bool m_usePixel;
  bool m_useSCT;
 
  double m_minPt;         
  double m_maxEta;        
  double m_maxRPhiImp;    
  double m_maxZImp;       
  int    m_minSiClusters; 
  int    m_maxDoubleHoles;//|< maximum number of SCT double holes
  int    m_maxSiHoles;    
  int    m_maxPixelHoles; 
  int    m_maxSctHoles;   
  int    m_minTRTonTrk;   
  double m_minTRTprecision;   
  int    m_minPixel;      
  double m_maxRPhiImpEM;    
 
  bool  m_useEmClusSeed;
  float m_phiWidthEm;
  float m_etaWidthEm;
 
  SG::ReadHandleKey<ROIPhiRZContainer> m_caloClusterROIKey
     {this, "EMROIPhiRZContainer", "", "Name of the calo cluster ROIs in Phi,R,Z parameterization"};
};
 
 
} // namespace InDet
 
 
#endif