CpByteStreamV1Tool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGT1CALOBYTESTREAM_CPBYTESTREAMV1TOOL_H
#define TRIGT1CALOBYTESTREAM_CPBYTESTREAMV1TOOL_H
 
#include <stdint.h>
 
#include <map>
#include <string>
#include <vector>
 
#include "L1CaloSrcIdMap.h"
#include "TrigT1CaloUtils/TriggerTowerKey.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "ByteStreamCnvSvcBase/IROBDataProviderSvc.h"
#include "ByteStreamCnvSvcBase/IByteStreamCnvSvc.h"
#include "ByteStreamData/RawEvent.h"
#include "AthContainers/DataVector.h"
#include "eformat/SourceIdentifier.h"
#include "GaudiKernel/ToolHandle.h"
 
class IInterface;
class InterfaceID;
class StatusCode;
 
template <typename> class FullEventAssembler;
 
namespace LVL1 {
  class CMMCPHits;
  class CPMHits;
  class CPMTower;
  class CPBSCollectionV1;
  class IL1CaloMappingTool;
  class TriggerTowerKey;
}
 
namespace LVL1BS {
 
class CmmCpSubBlock;
class CpmSubBlockV1;
class L1CaloErrorByteStreamTool;
class L1CaloSrcIdMap;

 
class CpByteStreamV1Tool : public AthAlgTool {
 
 public:
   CpByteStreamV1Tool(const std::string& type, const std::string& name,
                                               const IInterface* parent);
   virtual ~CpByteStreamV1Tool();

   static const InterfaceID& interfaceID();
 
   virtual StatusCode initialize() override;

   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CPMTower>* ttCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CPMHits>* hitCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMMCPHits>* hitCollection) const;

   StatusCode convert(const LVL1::CPBSCollectionV1* cp) const;

   const std::vector<uint32_t>& sourceIDs() const;
 
 private:
   ServiceHandle<IByteStreamCnvSvc> m_byteStreamCnvSvc
   { this, "ByteStreamCnvSvc", "ByteStreamCnvSvc" };
 
   struct LocalData
   {
     int coreOverlap = 0;
     unsigned int rodErr = 0;
     std::vector<unsigned int> hitsVec0;
     std::vector<unsigned int> hitsVec1;
     std::vector<int> errVec0;
     std::vector<int> errVec1;
     std::vector<int> emVec;
     std::vector<int> hadVec;
     std::vector<int> emErrVec;
     std::vector<int> hadErrVec;
     LVL1::TriggerTowerKey towerKey;
   };
 
   enum CollectionType { CPM_TOWERS, CPM_HITS, CMM_CP_HITS };
 
   typedef DataVector<LVL1::CPMTower>                    CpmTowerCollection;
   typedef DataVector<LVL1::CPMHits>                     CpmHitsCollection;
   typedef DataVector<LVL1::CMMCPHits>                   CmmCpHitsCollection;
   typedef std::map<unsigned int, const LVL1::CPMTower*> ConstCpmTowerMap;
   typedef std::map<unsigned int, LVL1::CPMTower*>       CpmTowerMap;
   typedef std::map<int, const LVL1::CPMHits*>           ConstCpmHitsMap;
   typedef std::map<int, LVL1::CPMHits*>                 CpmHitsMap;
   typedef std::map<int, const LVL1::CMMCPHits*>         ConstCmmCpHitsMap;
   typedef std::map<int, LVL1::CMMCPHits*>               CmmCpHitsMap;
   typedef IROBDataProviderSvc::VROBFRAG::const_iterator ROBIterator;
   typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType      ROBPointer;
   typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType      RODPointer;
 
   struct CpByteStreamToolData
   {
     CpByteStreamToolData (const CollectionType collection)
       : m_collection(collection){}
     const CollectionType m_collection;
   };
   struct CpmTowerData : public CpByteStreamToolData
   {
     CpmTowerData (CpmTowerCollection* const ttCollection)
       : CpByteStreamToolData (CPM_TOWERS), m_ttCollection (ttCollection) {}
     CpmTowerCollection* const m_ttCollection;
     CpmTowerMap  m_ttMap;
   };
   struct CpmHitsData : public CpByteStreamToolData
   {
     CpmHitsData (CpmHitsCollection* const hitCollection)
       : CpByteStreamToolData (CPM_HITS), m_hitCollection (hitCollection) {}
     CpmHitsCollection* const m_hitCollection;
     CpmHitsMap   m_hitsMap;
   };
   struct CmmHitsData : public CpByteStreamToolData
   {
     CmmHitsData (CmmCpHitsCollection* const hitCollection)
       : CpByteStreamToolData (CMM_CP_HITS), m_cmmHitCollection (hitCollection) {}
     CmmCpHitsCollection* const m_cmmHitCollection;
     CmmCpHitsMap m_cmmHitsMap;
   };

   std::vector<uint32_t> makeSourceIDs() const;

   StatusCode convertBs(const std::string& sgKey,
                        const IROBDataProviderSvc::VROBFRAG& robFrags,
                        CpByteStreamToolData& data) const;
   void decodeCmmCp(CmmCpSubBlock* subBlock, int trigCmm, CmmHitsData& data,
                    LocalData& ld) const;
   void decodeCpm(CpmSubBlockV1* subBlock, int trigCpm, CpByteStreamToolData& data,
                  LocalData& ld) const;

   const LVL1::CPMTower*  findCpmTower(unsigned int key,
                                       const ConstCpmTowerMap& ttMap) const;
   LVL1::CPMTower*  findCpmTower(const CpmTowerData& data, unsigned int key) const;
   const LVL1::CPMHits*   findCpmHits(int crate, int module,
                                      const ConstCpmHitsMap& hitsMap) const;
   LVL1::CPMHits*   findCpmHits(const CpmHitsData& data, int crate, int module) const;
   const LVL1::CMMCPHits* findCmmCpHits(int crate, int dataID,
                                        const ConstCmmCpHitsMap& cmmHitsMap) const;
   LVL1::CMMCPHits* findCmmCpHits(const CmmHitsData& data,
                                  int crate, int dataID) const;

   void setupCpmTowerMap(const CpmTowerCollection* ttCollection,
                         ConstCpmTowerMap& ttMap,
                         LVL1::TriggerTowerKey& towerKey) const;
   void setupCpmHitsMap(const CpmHitsCollection* hitCollection,
                        ConstCpmHitsMap& hitsMap) const;
   void setupCmmCpHitsMap(const CmmCpHitsCollection* hitCollection,
                          ConstCmmCpHitsMap& cmmHitsMap) const;

   bool slinkSlices(int crate, int module, int modulesPerSlink,
                    int& timeslices, int& trigJem,
                    const ConstCpmTowerMap& ttMap,
                    const ConstCpmHitsMap& hitsMap,
                    const ConstCmmCpHitsMap& cmmHitsMap,
                    LVL1::TriggerTowerKey& towerKey) const;

   ToolHandle<LVL1::IL1CaloMappingTool> m_cpmMaps;
   ToolHandle<LVL1BS::L1CaloErrorByteStreamTool> m_errorTool;

   int m_crateOffsetHw;
   int m_crateOffsetSw;
   int m_version;
   int m_dataFormat;
   const int m_channels;
   int m_crates;
   const int m_modules;
   int m_slinks;
   int m_dfltSlices;
   int m_forceSlices;
   int m_crateMin;
   int m_crateMax;
   std::vector<uint32_t> m_sourceIDsProp;
   const eformat::SubDetector m_subDetector;
   const L1CaloSrcIdMap m_srcIdMap;
};
 
} // end namespace
 
#endif