OutputConversionTool.h

Go to the documentation of this file.

/*
    Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef EFTRACKING_FPGA_INTEGRATION__OUTPUT_CONVERSION_TOOL_H
#define EFTRACKING_FPGA_INTEGRATION__OUTPUT_CONVERSION_TOOL_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "EFTrackingFPGAUtility/IEFTrackingFPGAIntegrationTool.h"
#include "EFTrackingFPGAUtility/EFTrackingTransient.h"
 
namespace OutputConversion
{
    // define the FSM for the output conversion
    enum class FSM
    {
        Unknown,
        EventHeader,
        EventFooter,
        GlobalHits,
        PixelEDM,
        StripEDM,
        Error
    };
}
 
class OutputConversionTool : public extends<AthAlgTool, IEFTrackingFPGAIntegrationTool>
{
public:
    using extends::extends;
    StatusCode initialize() override;
 
    // User-level functions to decode the clusters/L2G/SpacePoints
    StatusCode decodePixelEDM(const std::vector<uint64_t> &bytestream,
                              EFTrackingTransient::Metadata *metadata,
                              EFTrackingTransient::PixelClusterAuxInput &pcAux) const;
 
    StatusCode decodeStripEDM(const std::vector<uint64_t> &bytestream,
                              EFTrackingTransient::Metadata *metadata,
                              EFTrackingTransient::StripClusterAuxInput &scAux) const;
 
    StatusCode decodeSpacePoints(const std::vector<uint64_t> &bytestream, EFTrackingTransient::Metadata *metadata) const;
 
    StatusCode decodeFPGAoutput(const std::vector<uint64_t> &bytestream,
                                EFTrackingTransient::Metadata *metadata,
                                EFTrackingTransient::PixelClusterAuxInput *pcAux = nullptr,
                                EFTrackingTransient::StripClusterAuxInput *scAux = nullptr,
                                OutputConversion::FSM blockType = OutputConversion::FSM::Unknown) const;
};
 
#endif // EFTRACKING_FPGA_INTEGRATION__OUTPUT_CONVERSION_TOOL_H