BeamBackgroundFiller.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef RECBACKGROUNDALGS_BEAMBACKGROUNDFILLER
#define RECBACKGROUNDALGS_BEAMBACKGROUNDFILLER
 
 
 
#include "AthLinks/ElementLinkVector.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/ServiceHandle.h"
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MuonRecHelperTools/IMuonEDMHelperSvc.h"
#include "MuonSegment/MuonSegment.h"
#include "RecBackgroundEvent/BeamBackgroundData.h"
#include "TrkSegment/Segment.h"
#include "TrkSegment/SegmentCollection.h"
#include "xAODCaloEvent/CaloClusterContainer.h"
#include "xAODJet/JetContainer.h"
#include "GaudiKernel/SystemOfUnits.h"
#include "MuonSegmentMakerToolInterfaces/IMuonSegmentSelectionTool.h"
 
#include <string>
#include <vector>
class BeamBackgroundFiller : public AthReentrantAlgorithm {
 public:
  BeamBackgroundFiller(const std::string& name, ISvcLocator* pSvcLocator);
  virtual ~BeamBackgroundFiller() = default;
 
  virtual StatusCode initialize() override;
  virtual StatusCode execute(const EventContext& ctx) const override;
 
 private:
  struct Cache {
    int m_numSegment{0};  // number of segments with the direction parallel to
                           // the beam pipe
    int m_numSegmentEarly{0};     // number of early segments
    int m_numSegmentACNoTime{0};  // number of matched pairs of segments on
                                   // side A and side C
    int m_numSegmentAC{0};        // number of matched pairs of segments with
                                   // corresponding time difference
    int m_numMatched{0};      // number of clusters matched with the segments
    int m_numNoTimeLoose{0};  // number of clusters identified by the "No-Time
                               // Method"
    int m_numNoTimeMedium{0};
    int m_numNoTimeTight{0};
    int m_numOneSidedLoose{0};  // number of clusters identified by the
                                 // "One-Sided Method"
    int m_numOneSidedMedium{0};
    int m_numOneSidedTight{0};
    int m_numTwoSidedNoTime{0};  // number of clusters identified by the
                                  // "Two-Sided No-Time Method"
    int m_numTwoSided{0};  // number of clusters identified by the "Two-Sided
                            // Method"
    int m_numClusterShape{0};  // number of clusters identified by the
                                // "Cluster-Shape Method"
    int m_numJet{0};           // number of fake jets
    int m_direction{0};  // direction of beam halo from the "Two-Sided Method"
                          // (positive for A->C, negative for C->A)
    // link to the calorimeter cluster
    ElementLinkVector<xAOD::CaloClusterContainer> m_indexClus{};
    // line to the muon segment
    ElementLinkVector<Trk::SegmentCollection> m_indexSeg{};
    // matching matrix (stores results for each muon segment and calorimeter
    // cluster)
    std::vector<std::vector<int> > m_matchMatrix{};
    // summary of the results for each muon segment
    std::vector<int> m_resultSeg{};
    // summary of the results for each cluster segment
    std::vector<int> m_resultClus{};
    // shape of the cluster
    std::vector<float> m_drdzClus{};
 
    ElementLinkVector<xAOD::JetContainer> m_indexJet{};  // link to the jet
    std::vector<int> m_resultJet{};  // summary of the results for each jet
  };
 
  // Function matching calorimeter clusters with muon segments
  void FillMatchMatrix(const EventContext& ctx, Cache& cache) const;
  // Beam background identification methods
  void SegmentMethod(Cache& cache) const;
  void OneSidedMethod(Cache& cache) const;
  void TwoSidedMethod(Cache& cache) const;
  void ClusterShapeMethod(Cache& cache) const;
 
  // Function calculating time for mboy CSC segments
  // (needed until release 17.1.0, does not work on AOD)
  double GetSegmentTime(const Muon::MuonSegment& pMuonSegment) const;
 
  // Function to identify fake jets
  void FindFakeJets(const EventContext& ctx, Cache& cache) const;
  // Function to store the results in BeamBackgroundData
  void FillBeamBackgroundData(
      SG::WriteHandle<BeamBackgroundData>& beamBackgroundDataWriteHandle,
      Cache& cache) const;

  SG::ReadHandleKeyArray<Trk::SegmentCollection> m_segmentKeys{
      this, "SegmentKeys", {"NCB_TrackMuonSegments", /*"TrackMuonSegments" */}  ,
      "Muon segment collections from the MS patterns"};

  SG::ReadHandleKey<xAOD::CaloClusterContainer>
      m_caloClusterContainerReadHandleKey{
          this, "caloClusterContainerKey", "CaloCalTopoClusters",
          "ReadHandleKey for CaloClusterContainer"};

  SG::ReadHandleKey<xAOD::JetContainer> m_jetContainerReadHandleKey{
      this, "jetContainerKey", "AntiKt4EMTopoJets",
      "ReadHandleKey for JetContainer"};
 
  /* WriteHandleKey for BeamBackgroundData */
  SG::WriteHandleKey<BeamBackgroundData> m_beamBackgroundDataWriteHandleKey{
      this, "BeamBackgroundKey", "BeamBackgroundData",
      "WriteHandleKey for BeamBackgroundData"};
  
  ToolHandle<Muon::IMuonSegmentSelectionTool> m_segmentSelector{this, "SegmentSelector",""};
 
  
  Gaudi::Property<double> m_thetaCutNCB{this, "cutThetaNCB", 5. * Gaudi::Units::deg};
 
  Gaudi::Property<double> m_cutDphiSegAC{this,"cutPhi", 4.* Gaudi::Units::deg};

  Gaudi::Property<double> m_clusEnergyCut{this,"clustEnergy", 10. *Gaudi::Units::GeV};
  // CSC :  881 < R < 2081
  // LAr barrel :  1500 < R < 1970
  // TileCal :  2280 < R < 4250
  Gaudi::Property<double> m_clusRadiusLow{this, "cutRadiusLow", 881. * Gaudi::Units::mm};
  Gaudi::Property<double> m_clusRadiusHigh{this,"cutRadiusHigh", 4250. * Gaudi::Units::mm};
 
  Gaudi::Property<double> m_cutDphiClusSeg{this, "cutDphiClusSeg", 4.* Gaudi::Units::deg};
  Gaudi::Property<double> m_cutDradClusSeg{this,"cutDrClusSet", 40. * Gaudi::Units::cm};
 
 
 
  Gaudi::Property<double> m_cutMuonTime{this, "cutMuonTime", 25.};
  Gaudi::Property<double> m_cutClusTime{this,"cutClusTime", 2.5};
  Gaudi::Property<double> m_cutTimeDiffAC{this,"cutTimeDiffAC", 25.};
  Gaudi::Property<double> m_cutDrdz{this,"cutDrdz", 0.15};
  ServiceHandle<Muon::IMuonEDMHelperSvc> m_edmHelperSvc{
      this, "edmHelper", "Muon::MuonEDMHelperSvc/MuonEDMHelperSvc",
      "Handle to the service providing the IMuonEDMHelperSvc interface"};
  ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{
      this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
};
 
#endif