FPGATrackSimGNNGraphConstructionTool.h

Go to the documentation of this file.

// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
#ifndef FPGATRACKSIMGNNGRAPHCONSTRUCTIONTOOL_H
#define FPGATRACKSIMGNNGRAPHCONSTRUCTIONTOOL_H

 
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "FPGATrackSimMaps/IFPGATrackSimMappingSvc.h"
#include "FPGATrackSimObjects/FPGATrackSimGNNEdge.h"
#include "FPGATrackSimObjects/FPGATrackSimGNNHit.h"
 
#include "AthOnnxInterfaces/IOnnxRuntimeInferenceTool.h"
#include "AthOnnxUtils/OnnxUtils.h"
#include <onnxruntime_cxx_api.h>
 
class FPGATrackSimGNNGraphConstructionTool : public AthAlgTool
{
    public:

        // AthAlgTool
 
        FPGATrackSimGNNGraphConstructionTool(const std::string&, const std::string&, const IInterface*);
 
        virtual StatusCode initialize() override;

        // Functions
 
        virtual StatusCode getEdges(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits,
                                    std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges);
 
    private:
        
        // Handles
 
        ToolHandle<AthOnnx::IOnnxRuntimeInferenceTool> m_MLInferenceTool {this, "MLInferenceTool", "AthOnnx::OnnxRuntimeInferenceTool"};
        ServiceHandle<IFPGATrackSimMappingSvc> m_FPGATrackSimMapping{this, "FPGATrackSimMappingSvc", ""};

        // Properties
 
        Gaudi::Property<std::string> m_graphTool { this, "graphTool", "", "Tool for graph construction" };
        Gaudi::Property<std::string> m_moduleMapType { this, "moduleMapType", "", "Type for Module Map for graph construction" };
        Gaudi::Property<std::string> m_moduleMapFunc { this, "moduleMapFunc", "", "Function for Module Map for graph construction" };
        Gaudi::Property<float> m_moduleMapTol { this, "moduleMapTol", 0.0, "Tolerance value for Module Map cut calculations" };
        Gaudi::Property<float> m_metricLearningR { this, "metricLearningR", 0.0, "Clustering radius for Metric Learning"};
        Gaudi::Property<int> m_metricLearningMaxN { this, "metricLearningMaxN", 1, "Max number of neighbours for Metric Learning"};

        // Convenience
 
        // Module Map Information
        std::string m_moduleMapPath;
        std::vector<unsigned int> m_mid1{};
        std::vector<unsigned int> m_mid2{};
        std::vector<float> m_z0min_12{};
        std::vector<float> m_dphimin_12{};
        std::vector<float> m_phislopemin_12{};
        std::vector<float> m_detamin_12{};
        std::vector<float> m_z0max_12{};
        std::vector<float> m_dphimax_12{};
        std::vector<float> m_phislopemax_12{};
        std::vector<float> m_detamax_12{};

        // Helpers
 
        void loadDoubletModuleMap();
        void doModuleMap(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits,
                               std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges);
        void getDoubletEdges(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits,
                             std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges);
        void applyDoubletCuts(const std::shared_ptr<FPGATrackSimGNNHit> & hit1, const std::shared_ptr<FPGATrackSimGNNHit> & hit2,
                              std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges,
                              int hit1_index, int hit2_index, unsigned int modulemap_id);
        bool doMask(float val, float min, float max);
        bool doMinMaxMask(float val, float min, float max);
        float featureSign(float feature);
        void doMetricLearning(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits, std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges);
        std::vector<float> getNodeFeatures(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits);
        std::vector<float> embed(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits);
        void doClustering(const std::vector<std::shared_ptr<FPGATrackSimGNNHit>> & hits, std::vector<std::shared_ptr<FPGATrackSimGNNEdge>> & edges, std::vector<float> & gEmbedded);
        // Metric Learning Properties
        StringArrayProperty m_MLFeatureNamesVec{
            this, "MLFeatureNames",
            {"r", "phi", "z"},
            "Feature names for the Metric Learning model"};
        FloatArrayProperty m_MLFeatureScalesVec{
            this, "MLFeatureScales",
            {1000.0, 3.14159265359, 1000.0},
            "Feature scales for the Metric Learning model"};
};
 
#endif // FPGATRACKSIMGNNGRAPHCONSTRUCTIONTOOL_H