JepByteStreamTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGT1CALOBYTESTREAM_JEPBYTESTREAMTOOL_H
#define TRIGT1CALOBYTESTREAM_JEPBYTESTREAMTOOL_H
 
#include <stdint.h>
 
#include <map>
#include <string>
#include <vector>
 
#include "L1CaloSrcIdMap.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "TrigT1CaloUtils/JetElementKey.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 <class T> class FullEventAssembler;
 
namespace LVL1 {
  class CMMJetHits;
  class CMMEtSums;
  class IL1CaloMappingTool;
  class JEMHits;
  class JEMEtSums;
  class JEPBSCollection;
  class JetElement;
  class JetElementKey;
}
 
namespace LVL1BS {
 
class CmmEnergySubBlock;
class CmmJetSubBlock;
class JemSubBlock;
class L1CaloErrorByteStreamTool;
class L1CaloSrcIdMap;

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

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

   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::JetElement>* jeCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::JEMHits>* hitCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::JEMEtSums>* etCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMMJetHits>* hitCollection) const;
   StatusCode convert(const std::string& sgKey,
                      const IROBDataProviderSvc::VROBFRAG& robFrags,
                      DataVector<LVL1::CMMEtSums>* etCollection) const;

   StatusCode convert(const LVL1::JEPBSCollection* jep) 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> exVec;
     std::vector<unsigned int> eyVec;
     std::vector<unsigned int> etVec;
     std::vector<int> exErrVec;
     std::vector<int> eyErrVec;
     std::vector<int> etErrVec;
     std::vector<unsigned int> hitsVec;
     std::vector<int> errVec;
     LVL1::JetElementKey elementKey;
   };
 
   enum CollectionType { JET_ELEMENTS, JET_HITS, ENERGY_SUMS,
                                       CMM_HITS, CMM_SUMS };
 
   typedef DataVector<LVL1::JetElement>                  JetElementCollection;
   typedef DataVector<LVL1::JEMHits>                     JetHitsCollection;
   typedef DataVector<LVL1::JEMEtSums>                   EnergySumsCollection;
   typedef DataVector<LVL1::CMMJetHits>                  CmmHitsCollection;
   typedef DataVector<LVL1::CMMEtSums>                   CmmSumsCollection;
   typedef std::map<unsigned int, LVL1::JetElement*>     JetElementMap;
   typedef std::map<unsigned int, const LVL1::JetElement*> ConstJetElementMap;
   typedef std::map<int, LVL1::JEMHits*>                 JetHitsMap;
   typedef std::map<int, const LVL1::JEMHits*>           ConstJetHitsMap;
   typedef std::map<int, LVL1::JEMEtSums*>               EnergySumsMap;
   typedef std::map<int, const LVL1::JEMEtSums*>         ConstEnergySumsMap;
   typedef std::map<int, LVL1::CMMJetHits*>              CmmHitsMap;
   typedef std::map<int, const LVL1::CMMJetHits*>        ConstCmmHitsMap;
   typedef std::map<int, LVL1::CMMEtSums*>               CmmSumsMap;
   typedef std::map<int, const LVL1::CMMEtSums*>         ConstCmmSumsMap;
   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 JetHitsData : public JepByteStreamToolData
   {
     JetHitsData (JetHitsCollection* const hitCollection)
       : JepByteStreamToolData (JET_HITS), m_hitCollection (hitCollection) {}
     JetHitsCollection* const m_hitCollection;
     JetHitsMap    m_hitsMap;
   };
   struct EnergySumsData : public JepByteStreamToolData
   {
     EnergySumsData (EnergySumsCollection* const etCollection)
       : JepByteStreamToolData (ENERGY_SUMS), m_etCollection (etCollection) {}
     EnergySumsCollection* const m_etCollection;
     EnergySumsMap m_etMap;
   };
   struct CmmHitsData : public JepByteStreamToolData
   {
     CmmHitsData (CmmHitsCollection* const cmmHitCollection)
       : JepByteStreamToolData (CMM_HITS), m_cmmHitCollection (cmmHitCollection) {}
     CmmHitsCollection* const m_cmmHitCollection;
     CmmHitsMap    m_cmmHitsMap;
   };
   struct CmmSumsData : public JepByteStreamToolData
   {
     CmmSumsData (CmmSumsCollection* const cmmEtCollection)
       : JepByteStreamToolData (CMM_SUMS), m_cmmEtCollection (cmmEtCollection) {}
     CmmSumsCollection* const m_cmmEtCollection;
     CmmSumsMap    m_cmmEtMap;
   };

   StatusCode convertBs(const std::string& sgKey,
                        const IROBDataProviderSvc::VROBFRAG& robFrags,
                        JepByteStreamToolData& data) const;
   void decodeCmmEnergy(CmmEnergySubBlock* subBlock, int trigCmm, CmmSumsData& data,
                        LocalData& ld) const;
   void decodeCmmJet(CmmJetSubBlock* subBlock, int trigCmm, CmmHitsData& data,
                     LocalData& ld) const;
   void decodeJem(JemSubBlock* subBlock, int trigJem,
                  JepByteStreamToolData& data,
                  LocalData& ld) 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::JEMHits*    findJetHits(int crate, int module,
                                       const ConstJetHitsMap& hitsMap) const;
   LVL1::JEMHits*    findJetHits(const JetHitsData& data, int crate, int module) 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::CMMJetHits* findCmmHits(int crate, int dataID,
                                       const ConstCmmHitsMap& cmmHitsMap) const;
   LVL1::CMMJetHits* findCmmHits(const CmmHitsData& data, int crate, int dataID) const;
   const LVL1::CMMEtSums*  findCmmSums(int crate, int dataID,
                                       const ConstCmmSumsMap& cmmEtMap) const;
   LVL1::CMMEtSums*  findCmmSums(const CmmSumsData& data, int crate, int dataID) const;
 
   std::vector<uint32_t> makeSourceIDs() const;

   void setupJeMap(const JetElementCollection* jeCollection,
                   ConstJetElementMap& jeMap,
                   LVL1::JetElementKey& elementKey) const;
   void setupHitsMap(const JetHitsCollection* hitCollection,
                     ConstJetHitsMap& hitsMap) const;
   void setupEtMap(const EnergySumsCollection* enCollection,
                   ConstEnergySumsMap& etMap) const;
   void setupCmmHitsMap(const CmmHitsCollection* hitCollection,
                        ConstCmmHitsMap& cmmHitsMap) const;
   void setupCmmEtMap(const CmmSumsCollection* enCollection,
                      ConstCmmSumsMap& cmmEtMap) const;

   bool slinkSlices(int crate, int module, int modulesPerSlink,
                    int& timeslices, int& trigJem,
                    const ConstJetElementMap& jeMap,
                    const ConstJetHitsMap& hitsMap,
                    const ConstEnergySumsMap& etMap,
                    const ConstCmmHitsMap& cmmHitsMap,
                    const ConstCmmSumsMap& cmmEtMap,
                    LVL1::JetElementKey& elementKey) const;

   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;
   int m_slinks;
   int m_dfltSlices;
   int m_forceSlices;
   std::vector<uint32_t> m_sourceIDsProp;
   const eformat::SubDetector m_subDetector;
   const L1CaloSrcIdMap m_srcIdMap;
};
 
} // end namespace
 
#endif