MuonCombinePatternTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONCOMBINEPATTERNTOOLS_MUONCOMBINEPATTERNTOOL_H
#define MUONCOMBINEPATTERNTOOLS_MUONCOMBINEPATTERNTOOL_H
 
 
#include "AthenaBaseComps/AthAlgTool.h" //base class
#include "GaudiKernel/ServiceHandle.h"  //member
#include "MuonHoughPatternEvent/MuonHoughMathUtils.h" //member
#include "MuonIdHelpers/IMuonIdHelperSvc.h"  //template parameter
#include "MuonRecToolInterfaces/IMuonCombinePatternTool.h" //base class
#include "MuonRecHelperTools/MuonEDMPrinterTool.h"
 
 
class MuonCombinePatternTool : public AthAlgTool, virtual public Muon::IMuonCombinePatternTool {
private:
    struct ChamberInfo {
        ChamberInfo() = default;
        int neta{0};
        int nphi{0};
        int ninside{0};
        int noutside{0};
        int ninsidePat{0};
        int noutsidePat{0};
        double phiMin{FLT_MAX};
        double phiMax{-FLT_MAX};
    };
    using IdChMap =  std::map<Identifier, ChamberInfo>;
 
public:
    using PrdPatternPair = std::pair<std::unique_ptr<Muon::MuonPrdPattern>, std::unique_ptr<Muon::MuonPrdPattern>>;
 
    using CandPrdPatPtr = std::shared_ptr<const Muon::MuonPrdPattern>;
    using CandidatePatPair = std::pair<CandPrdPatPtr, CandPrdPatPtr>;
 
    MuonCombinePatternTool(const std::string& type, const std::string& name, const IInterface* parent);
    virtual ~MuonCombinePatternTool() = default;
 
    StatusCode initialize() override;

    std::unique_ptr<MuonPrdPatternCollection> combineEtaPhiPatterns(
        const MuonPrdPatternCollection& phiPatternCollection, const MuonPrdPatternCollection& etaPatternCollection,
        const EtaPhiHitAssocMap& phiEtaHitAssMap) const override;

    std::unique_ptr<Muon::MuonPrdPattern> makeCombinedPattern(const Muon::MuonPrdPattern& phipattern, 
                                                              const Muon::MuonPrdPattern& etapattern) const override;

    virtual std::unique_ptr<MuonPatternCombinationCollection> makePatternCombinations(const MuonPrdPatternCollection& muonpatterns) const override;
 
private:
    std::unique_ptr<MuonPrdPatternCollection> makeCombinedPatterns(std::vector<CandidatePatPair>& candidates) const;

    static bool subset(const Muon::MuonPrdPattern* pattern1, const Muon::MuonPrdPattern* pattern2);

    static bool subset(std::pair<PrepDataSet, PrepDataSet>& candidate1,
                       std::pair<PrepDataSet, PrepDataSet>& candidate2);
 

    std::unique_ptr<Muon::MuonPrdPattern> cleanPhiPattern(std::unique_ptr<Muon::MuonPrdPattern> phipattern) const;

    std::unique_ptr<Muon::MuonPrdPattern> cleanupCombinedPattern(const Muon::MuonPrdPattern& combinedpattern) const;

    std::vector<PrdPatternPair> splitPatterns2D(const Muon::MuonPrdPattern* phipattern,
                                                const Muon::MuonPrdPattern* etapattern) const;

    std::vector<PrdPatternPair> splitPatterns3D(const Muon::MuonPrdPattern* phipattern,
                                                const Muon::MuonPrdPattern* etapattern) const;

    std::vector<PrdPatternPair> splitPatternsCylinder(const Muon::MuonPrdPattern* phipattern, 
                                                      const Muon::MuonPrdPattern* etapattern) const;

    std::unique_ptr<Muon::MuonPrdPattern> makeAssPhiPattern(
        const Muon::MuonPrdPattern& pattern,
        const EtaPhiHitAssocMap& phiEtaHitAssMap,
        bool check = false) const;

    std::array<double,4> updateParametersForCosmics(const Muon::MuonPrdPattern& phipattern, 
                                                    const Muon::MuonPrdPattern& etapattern) const;

    std::pair<double, double> calculateR0Phi(const Muon::MuonPrdPattern& phipattern, const Muon::MuonPrdPattern& etapattern,
                                             double phi_estimate = -M_PI_2) const;

    static double calculateRz0(const Muon::MuonPrdPattern& pattern, double phi, double theta);

    PrdPatternPair updatePatternsForCosmics(const Muon::MuonPrdPattern& phipattern, 
                                                   const Muon::MuonPrdPattern& etapattern, 
                                                   const std::array<double,4>&  new_pars) const;
    
    void addCandidate(const CandPrdPatPtr& etapattern, const CandPrdPatPtr& phipattern,
                     std::vector<CandidatePatPair>& candidates, bool add_asspattern,
                     const EtaPhiHitAssocMap& phiEtaHitAssMap) const;

    static void cleanCandidates(std::vector<CandidatePatPair>& candidates);

    void printPattern(const Muon::MuonPrdPattern* muonpattern) const;

    MuonHoughMathUtils m_muonHoughMathUtils;

    const double m_maximum_xydistance;
    const double m_maximum_rzdistance;

    bool m_use_cosmics;

    bool m_splitpatterns;

    bool m_nodiscarding;

    bool m_bestphimatch;

    bool m_flipdirectionforcosmics;
 
    bool m_useTightAssociation;
    unsigned int m_maxSizePhiPatternLoose;
    unsigned int m_maxSizeEtaPatternLoose;
 
    ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
 
    PublicToolHandle<Muon::MuonEDMPrinterTool> m_printer{this, "printerTool", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool",
                                                       "ToolHandle for EDM printing of segments"};
};
 
#endif  // MUONCOMBINEPATTERNTOOLS_MUONCOMBINEPATTERNTOOL_H