JepByteStreamV2Tool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGT1CALOBYTESTREAM_JEPBYTESTREAMV2TOOL_H
#define TRIGT1CALOBYTESTREAM_JEPBYTESTREAMV2TOOL_H
 
#include <stdint.h>
 
#include <map>
#include <string>
#include <vector>
 
#include "L1CaloSrcIdMap.h"
#include "TrigT1CaloUtils/JetElementKey.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"
 
#include "CmxEnergySubBlock.h"
 
class IInterface;
class InterfaceID;
class StatusCode;
 
template <class T> class FullEventAssembler;
 
namespace LVL1 {
  class CMXJetHits;
  class CMXJetTob;
  class CMXEtSums;
  class IL1CaloMappingTool;
  class JEMEtSums;
  class JEPBSCollectionV2;
  class JetElement;
  class JetElementKey;
}
 
namespace LVL1BS {
 
class CmxJetSubBlock;
class JemSubBlockV2;
class L1CaloErrorByteStreamTool;
class L1CaloSrcIdMap;

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

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

   StatusCode convert(const EventContext& ctx,
                      const std::string& name,
                      DataVector<LVL1::JetElement>* jeCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::JetElement>* jeCollection) const;
   StatusCode convert(const EventContext& ctx,
                      const std::string& name,
                      DataVector<LVL1::JEMEtSums>* etCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::JEMEtSums>* etCollection) const;
   StatusCode convert(const EventContext& ctx,
                      const std::string& name,
                      DataVector<LVL1::CMXJetTob>* tobCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMXJetTob>* tobCollection) const;
   StatusCode convert(const EventContext& ctx,
                      const std::string& name,
                      DataVector<LVL1::CMXJetHits>* hitCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMXJetHits>* hitCollection) const;
   StatusCode convert(const EventContext& ctx,
                      const std::string& name,
                      DataVector<LVL1::CMXEtSums>* etCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMXEtSums>* etCollection) const;

   StatusCode convert(const LVL1::JEPBSCollectionV2* jep) const;

   const std::vector<uint32_t>& sourceIDs() const;
 
 private:
   // Need option to disable dependency on offline ByteStreamCnvSvc to be able to run
   // decoding in online HLT framework (which uses TrigByteStreamCnvSvc)
   Gaudi::Property<bool> m_enableEncoding{
     this, "enableEncoding", true, "Enable conversion from RDO to ByteStream"};
   SmartIF<IByteStreamCnvSvc> m_byteStreamCnvSvc;
 
  struct LocalData
  {
    int coreOverlap = 0;
    // Unpacking error code
    unsigned int rodErr = 0;
    std::vector<unsigned int> uintVec0;
    std::vector<unsigned int> uintVec1;
    std::vector<unsigned int> uintVec2;
    std::vector<int> intVec0;
    std::vector<int> intVec1;
    std::vector<int> intVec2;
    // Jet element key provider
    LVL1::JetElementKey elementKey;
  };
 
  enum CollectionType { JET_ELEMENTS, ENERGY_SUMS, CMX_TOBS,
                                       CMX_HITS, CMX_SUMS };
 
   typedef DataVector<LVL1::JetElement>                  JetElementCollection;
   typedef DataVector<LVL1::JEMEtSums>                   EnergySumsCollection;
   typedef DataVector<LVL1::CMXJetTob>                   CmxTobCollection;
   typedef DataVector<LVL1::CMXJetHits>                  CmxHitsCollection;
   typedef DataVector<LVL1::CMXEtSums>                   CmxSumsCollection;
   typedef std::map<unsigned int, LVL1::JetElement*>     JetElementMap;
   typedef std::map<unsigned int, const LVL1::JetElement*> ConstJetElementMap;
   typedef std::map<int, LVL1::JEMEtSums*>               EnergySumsMap;
   typedef std::map<int, const LVL1::JEMEtSums*>         ConstEnergySumsMap;
   typedef std::map<int, LVL1::CMXJetTob*>               CmxTobMap;
   typedef std::map<int, const LVL1::CMXJetTob*>         ConstCmxTobMap;
   typedef std::map<int, LVL1::CMXJetHits*>              CmxHitsMap;
   typedef std::map<int, const LVL1::CMXJetHits*>        ConstCmxHitsMap;
   typedef std::map<int, LVL1::CMXEtSums*>               CmxSumsMap;
   typedef std::map<int, const LVL1::CMXEtSums*>         ConstCmxSumsMap;
 
   typedef IROBDataProviderSvc::VROBFRAG::const_iterator ROBIterator;
   typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType      ROBPointer;
   typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType      RODPointer;
 
   struct JepByteStreamToolData
   {
     JepByteStreamToolData (const CollectionType collection)
       : m_collection(collection){}
     const CollectionType m_collection;
   };
   struct JetElementData : public JepByteStreamToolData
   {
     JetElementData (JetElementCollection* const jeCollection)
       : JepByteStreamToolData (JET_ELEMENTS), m_jeCollection (jeCollection) {}
     JetElementCollection* const m_jeCollection;
     JetElementMap m_jeMap;
   };
   struct EnergySumsData : public JepByteStreamToolData
   {
     EnergySumsData (EnergySumsCollection* const etCollection)
       : JepByteStreamToolData (ENERGY_SUMS), m_etCollection (etCollection) {}
     EnergySumsCollection* const m_etCollection;
     EnergySumsMap m_etMap;
   };
   struct CmxTobData : public JepByteStreamToolData
   {
     CmxTobData (CmxTobCollection* const tobCollection)
       : JepByteStreamToolData (CMX_TOBS), m_cmxTobCollection (tobCollection) {}
     CmxTobCollection* const m_cmxTobCollection;
     CmxTobMap     m_cmxTobMap;
   };
   struct CmxHitsData : public JepByteStreamToolData
   {
     CmxHitsData (CmxHitsCollection* const hitCollection)
       : JepByteStreamToolData (CMX_HITS), m_cmxHitCollection (hitCollection) {}
     CmxHitsCollection* const m_cmxHitCollection;
     CmxHitsMap    m_cmxHitsMap;
   };
   struct CmxSumsData : public JepByteStreamToolData
   {
     CmxSumsData (CmxSumsCollection* const etCollection)
       : JepByteStreamToolData (CMX_SUMS), m_cmxEtCollection (etCollection) {}
     CmxSumsCollection* const m_cmxEtCollection;
     CmxSumsMap    m_cmxEtMap;
   };

   StatusCode convertBs(const std::string& sgKey,
                        const IROBDataProviderSvc::VROBFRAG& robFrags,
                        JepByteStreamToolData& data) const;
   void decodeCmxEnergy(CmxEnergySubBlock* subBlock, int trigJem, CmxSumsData& data,
                        LocalData& ld) const;
   void decodeCmxJet(CmxJetSubBlock* subBlock, int trigJem,
                     JepByteStreamToolData& data,
                     LocalData& ld) const;
   void decodeJem(JemSubBlockV2* subBlock, int trigJem,
                  JepByteStreamToolData& data,
                  LocalData& ld) const;

   int tobKey(int crate, int jem, int frame, int loc) const;
   const LVL1::JetElement* findJetElement(double eta, double phi,
                                          const ConstJetElementMap& jeMap,
                                          LVL1::JetElementKey& elementKey) const;
   LVL1::JetElement* findJetElement(const JetElementData& data, double eta, double phi,
                                    LVL1::JetElementKey& elementKey) const;
   const LVL1::JEMEtSums*  findEnergySums(int crate, int module,
                                          const ConstEnergySumsMap& etMap) const;
   LVL1::JEMEtSums*  findEnergySums(const EnergySumsData& data, int crate, int module) const;
   const LVL1::CMXJetTob*  findCmxTob(int key,
                                      const ConstCmxTobMap& cmxTobMap) const;
   LVL1::CMXJetTob*  findCmxTob(const CmxTobData& data, int key) const;
   const LVL1::CMXJetHits* findCmxHits(int crate, int source,
                                       const ConstCmxHitsMap& cmxHitsMap) const;
   LVL1::CMXJetHits* findCmxHits(const CmxHitsData& data, int crate, int source) const;
   const LVL1::CMXEtSums*  findCmxSums(int crate, int source,
                                       const ConstCmxSumsMap& cmxEtMap) const;
   LVL1::CMXEtSums*  findCmxSums(const CmxSumsData& data, int crate, int source) const;
 
   std::vector<uint32_t> makeSourceIDs() const;

   void setupJeMap(const JetElementCollection* jeCollection,
                   ConstJetElementMap& jeMap,
                   LVL1::JetElementKey& elementKey) const;
   void setupEtMap(const EnergySumsCollection* enCollection,
                   ConstEnergySumsMap& etMap) const;
   void setupCmxTobMap(const CmxTobCollection* tobCollection,
                       ConstCmxTobMap& cmxTobMap) const;
   void setupCmxHitsMap(const CmxHitsCollection* hitCollection,
                        ConstCmxHitsMap& cmxHitsMap) const;
   void setupCmxEtMap(const CmxSumsCollection* enCollection,
                      ConstCmxSumsMap& cmxEtMap) const;

   bool slinkSlices(int crate, int module, int modulesPerSlink,
                    int& timeslices, int& trigJem,
                    const ConstJetElementMap& jeMap,
                    const ConstEnergySumsMap& etMap,
                    const ConstCmxTobMap& cmxTobMap,
                    const ConstCmxHitsMap& cmxHitsMap,
                    const ConstCmxSumsMap& cmxEtMap,
                    LVL1::JetElementKey& elementKey) const;
   void energySubBlockTypes(int source,
                            CmxEnergySubBlock::SourceType& srcType,
                CmxEnergySubBlock::SumType&    sumType,
                CmxEnergySubBlock::HitsType&   hitType) const;
   int jetSubBlockSourceId(int source) const;
 
   ServiceHandle<IROBDataProviderSvc> m_robDataProvider;
   ToolHandle<LVL1::IL1CaloMappingTool> m_jemMaps;
   ToolHandle<LVL1BS::L1CaloErrorByteStreamTool> m_errorTool;

   int m_crateOffsetHw;
   int m_crateOffsetSw;
   int m_version;
   int m_dataFormat;
   const int m_channels;
   const int m_crates;
   const int m_modules;
   const int m_frames;
   const int m_locations;
   const int m_maxTobs;
   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