jFexInputByteStreamTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
//***************************************************************************
//                           jFexInputByteStreamTool  -  This tool decodes Run3 jFEX input data!
//                              -------------------
//     begin                : 01 07 2022
//     email                : Sergi.Rodriguez@cern.ch
//  ***************************************************************************/
 
#ifndef JFEXINPUTBYTESTREAMTOOL_H 
#define JFEXINPUTBYTESTREAMTOOL_H
 
// Trigger includes
#include "TrigT1ResultByteStream/IL1TriggerByteStreamTool.h"
#include "xAODTrigL1Calo/jFexTowerContainer.h"
#include "xAODTrigL1Calo/jFexTowerAuxContainer.h"
 
// Athena includes
#include "AthenaBaseComps/AthAlgTool.h"
#include "PathResolver/PathResolver.h"
 
#include "AthenaMonitoringKernel/Monitored.h"
 
// Gaudi includes
#include "Gaudi/Property.h"

class jFexInputByteStreamTool : public extends<AthAlgTool, IL1TriggerByteStreamTool> {
    public:
        jFexInputByteStreamTool(const std::string& type, const std::string& name, const IInterface* parent);
        virtual ~jFexInputByteStreamTool() override = default;
 
        // ------------------------- IAlgTool methods --------------------------------
        virtual StatusCode initialize() override;
 
        // ------------------------- IL1TriggerByteStreamTool methods ----------------------
        virtual StatusCode convertFromBS(const std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*>& vrobf, const EventContext& eventContext)const override;

        virtual StatusCode convertToBS(std::vector<OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment*>& vrobf,
                                       const xAOD::TrigCompositeContainer* tc,
                                       const EventContext& eventContext) override;

        virtual const std::vector<uint32_t>& robIds() const override {
            return m_robIds.value();
        }
 
    private:
        // ------------------------- Properties --------------------------------------
        
        ToolHandle<GenericMonitoringTool> m_monTool{this,"MonTool","","Monitoring tool"};
        bool m_UseMonitoring = false;
        
        Gaudi::Property<bool> m_doThinning    {this, "DoThinning"  , true, "Remove overlapped towers. Only FPGA Core region is saved"};
        
        // ROBIDs property required by the interface
        Gaudi::Property<std::vector<uint32_t>> m_robIds {this, "ROBIDs", {}, "List of ROB IDs required for conversion to/from xAOD RoI"};
        
        // FiberMapping property required by the interface
        Gaudi::Property<std::string> m_FiberMapping {this, "jFexTowerMapping", "L1CaloFEXByteStream/2023-08-01/jFexTowerMap.txt", "Text file to convert from hardware fiber to eta-phi location"};
 
        //Write handle keys for the L1Calo EDMs for BS->xAOD mode of operation
        SG::WriteHandleKey< xAOD::jFexTowerContainer> m_jTowersWriteKey   {this,"jTowersWriteKey"  ,"L1_jFexDataTowers","Write jFexEDM Trigger Tower container"};
        
        // Read handle keys for the L1Calo EDMs for xAOD->BS mode of operation
        SG::ReadHandleKey < xAOD::jFexTowerContainer> m_jTowersReadKey    {this,"jTowersReadKey"   ,"L1_jFexDataTowers","Read jFexEDM Trigger Tower container"};
 
        std::array<uint32_t,4> jFEXtoRODTrailer  (uint32_t, uint32_t) const;
        std::array<uint16_t,2> BulkStreamTrailer (uint32_t, uint32_t, uint32_t) const;
        std::array<uint16_t,3> Dataformat1 (uint32_t ) const;
        std::array<uint16_t,4> Dataformat2 (uint32_t ) const;
        //bool m_verbose = 1;
        
        // Read Mapping file to link fibers to Simulation ID and Eta/Phi coordinates
        StatusCode ReadfromFile(const std::string&);
        
        // hash the index into one integer in the format 0xJFCCT (hexadecimal)
        constexpr static unsigned int mapIndex(unsigned int jfex, unsigned int fpga, unsigned int channel, unsigned int tower);
        std::unordered_map<unsigned int, std::array<float,6> > m_Firm2Tower_map; 
 
        void printError(const std::string& location, const std::string& title, MSG::Level type, const std::string& detail) const;
        
};
 
#endif // JFEXINPUTBYTESTREAMTOOL_H