RpcRdoToPrepDataToolMT.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONRDOTOPREPDATA_RPCRDOTOPREPDATATOOLMT_H
#define MUONRDOTOPREPDATA_RPCRDOTOPREPDATATOOLMT_H
 
#include <set>
#include <string>
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "MuonCablingData/MuonNRPC_CablingMap.h"
#include "MuonCnvToolInterfaces/IMuonRdoToPrepDataTool.h"
#include "MuonCondData/RpcCondDbData.h"
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MuonPrepRawData/MuonPrepDataCollection_Cache.h"
#include "MuonPrepRawData/MuonPrepDataContainer.h"
#include "MuonRDO/RpcCoinMatrix.h"
#include "MuonRDO/RpcPadContainer.h"
#include "MuonRPC_CnvTools/IRPC_RDO_Decoder.h"
#include "MuonReadoutGeometry/MuonDetectorManager.h"
#include "MuonTrigCoinData/MuonTrigCoinData_Cache.h"
#include "MuonTrigCoinData/RpcCoinDataContainer.h"
#include "RPC_CondCabling/RpcCablingCondData.h"
#include "StoreGate/ReadCondHandleKey.h"
#include "xAODEventInfo/EventInfo.h"
#include "xAODMuonPrepData/RpcStripContainer.h"
#include "xAODMuonRDO/NRPCRDOContainer.h"
namespace Muon {
 
 
class RpcRdoToPrepDataToolMT
    : public extends<AthAlgTool, IMuonRdoToPrepDataTool> {
 public:
  RpcRdoToPrepDataToolMT(const std::string&, const std::string&,
                         const IInterface*);
 
  // setup/teardown functions, similar like those for Algorithm/Service
  virtual StatusCode initialize() override;
 
  virtual StatusCode decode(const EventContext& ctx, 
                            const std::vector<IdentifierHash>& idVect) const override;
 
  virtual StatusCode decode(const EventContext& ctx,
                            const std::vector<uint32_t>& robIds) const override;
  virtual StatusCode provideEmptyContainer(const EventContext& ctx) const override;
  
 protected:
  struct State;
 
  StatusCode transferAndRecordPrepData(const EventContext& ctx,
                                       State& state) const;
  StatusCode transferAndRecordCoinData(const EventContext& ctx,
                                       State& state) const;
  StatusCode loadProcessedChambers(const EventContext& ctx, State& state) const;
 
  void printMTPrepData(const Muon::RpcPrepDataContainer& prepData) const;
  void printMTCoinData(const Muon::RpcCoinDataContainer& prepData) const;
 
  // decoding method
  StatusCode decodeImpl(const EventContext& ctx, State& state,
                        const std::vector<IdentifierHash>& idVect,
                        bool firstTimeInTheEvent) const;
  StatusCode decodeImpl(const EventContext& ctx, State& state,
                        const std::vector<uint32_t>& robIds,
                        bool firstTimeInTheEvent) const;
 
  StatusCode processPad(const EventContext& ctx, State& state,
                        const RpcPad* rdoColl, bool& processingetaview,
                        bool& processingphiview, int& nPrepRawData,
                        const std::vector<IdentifierHash>& idVect,
                        bool doingSecondLoopAmbigColls) const;
 
  void processTriggerHitHypothesis(RpcCoinMatrix::const_iterator itD,
                                   RpcCoinMatrix::const_iterator itD_end,
                                   bool highptpad,  // these are inputs
                                   bool& triggerHit, unsigned short& threshold,
                                   unsigned short& overlap, bool& toSkip) const;
 
  StatusCode processNrpcRdo(const EventContext& ctx, State& state) const;
 
  struct State {
    State(const RpcIdHelper& idHelper,
          const SG::WriteHandleKey<xAOD::RpcStripContainer>& key,
          const EventContext& ctx);
 
    Muon::RpcPrepDataCollection* getPrepCollection(const IdentifierHash& hash,
                                                   MsgStream& msg);
    Muon::RpcCoinDataCollection* getCoinCollection(const IdentifierHash& hash,
                                                   MsgStream& msg);
 
    const RpcIdHelper& m_rpcIdHelper;
 
    std::map<IdentifierHash, std::unique_ptr<Muon::RpcPrepDataCollection>>
        m_rpcPrepDataCollections{};
    std::map<IdentifierHash, std::unique_ptr<Muon::RpcCoinDataCollection>>
        m_rpcCoinDataCollections{};
 
    std::unique_ptr<Muon::RpcPrepDataContainer> m_prepDataCont{nullptr};
    std::unique_ptr<Muon::RpcCoinDataContainer> m_coinDataCont{nullptr};
    SG::WriteHandle<xAOD::RpcStripContainer> m_xaodHandle;
 
    // keepTrackOfFullEventDecoding
    bool m_fullEventDone{false};
 
    // the set of already requested and decoded offline (PrepRawData)
    // collections
    std::set<IdentifierHash> m_decodedOfflineHashIds{};
 
    // the set of unrequested collections with phi hits stored with
    // ambiguityFlag > 1
    std::set<IdentifierHash> m_ambiguousCollections{};
 
    // the set of already requested and decoded ROBs
    std::set<uint32_t> m_decodedRobIds{};
 
    const IdContext m_modContext{m_rpcIdHelper.module_context()};
  };
 
  Gaudi::Property<float> m_etaphi_coincidenceTime{
      this, "etaphi_coincidenceTime", 20., "time for phi*eta coincidence"};
  Gaudi::Property<float> m_overlap_timeTolerance{
      this, "overlap_timeTolerance", 10.,
      "tolerance of the timing calibration"};
  Gaudi::Property<bool> m_producePRDfromTriggerWords{
      this, "produceRpcCoinDatafromTriggerWords", true,
      "tore as prd the trigger hits"};
  Gaudi::Property<bool> m_solvePhiAmbiguities{
      this, "solvePhiAmbiguities", true,
      "toggle on/off the removal of phi ambiguities"};
  Gaudi::Property<bool> m_reduceCablingOverlap{
      this, "reduceCablingOverlap", true, "toggle on/off the overlap removal"};
  Gaudi::Property<float> m_timeShift{this, "timeShift", -12.5,
                                     "any global time shift ?!"};
  Gaudi::Property<bool> m_decodeData{
      this, "DecodeData",
      true};  
  Gaudi::Property<bool> m_RPCInfoFromDb{
      this, "RPCInfoFromDb", false};  
  // end of configurable options
 
  SG::ReadCondHandleKey<MuonGM::MuonDetectorManager> m_muDetMgrKey{
      this, "DetectorManagerKey", "MuonDetectorManager",
      "Key of input MuonDetectorManager condition data"};
 
  ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{
      this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
 
  SG::WriteHandleKey<Muon::RpcPrepDataContainer> m_rpcPrepDataContainerKey{
      this, "OutputCollection", "RPC_Measurements"};
  SG::WriteHandleKey<Muon::RpcCoinDataContainer> m_rpcCoinDataContainerKey{
      this, "TriggerOutputCollection", "RPC_triggerHits"};
 
  SG::ReadHandleKey<RpcPadContainer> m_rdoContainerKey{this, "RDOContainer",
                                                       "RPCPAD"};
 
  SG::ReadHandleKey<xAOD::NRPCRDOContainer> m_rdoNrpcContainerKey{
      this, "NrpcInputCollection", "NRPCRDO"};
 
  // Rob Data Provider handle
  ToolHandle<Muon::IRPC_RDO_Decoder> m_rpcRdoDecoderTool{
      this, "RdoDecoderTool", "Muon::RpcRDO_Decoder"};
 
  SG::ReadCondHandleKey<RpcCondDbData> m_readKey{
      this, "ReadKey", "RpcCondDbData", "Key of RpcCondDbData"};
  SG::ReadCondHandleKey<RpcCablingCondData> m_rpcReadKey{
      this, "RpcCablingKey", "RpcCablingCondData", "Key of RpcCablingCondData"};
  SG::ReadHandleKey<xAOD::EventInfo> m_eventInfo{this, "EventInfoContName",
                                                 "EventInfo", "event info key"};
  SG::ReadCondHandleKey<MuonNRPC_CablingMap> m_nRpcCablingKey{
      this, "NrpcCablingKey", "MuonNRPC_CablingMap",
      "Key of MuonNRPC_CablingMap"};
 
  SG::UpdateHandleKey<RpcPrepDataCollection_Cache> m_prdContainerCacheKey{
      this, "RpcPrdContainerCacheKey", "",
      "Optional external cache for the RPC PRD container"};
  SG::UpdateHandleKey<RpcCoinDataCollection_Cache> m_coindataContainerCacheKey{
      this, "RpcCoinDataContainerCacheKey", "",
      "Optional external cache for the RPC coin data container"};
 
  SG::WriteHandleKey<xAOD::RpcStripContainer> m_xAODKey{
      this, "xAODKey", "",
      "If empty, do not produce xAOD, otherwise this is the key of the output "
      "xAOD MDT PRD container"};
};
}  // namespace Muon
 
#endif  // !ATHEXJOBOPTIONS_CONCRETETOOL_H