FPGATrackSimRegionMap.h

Go to the documentation of this file.

// Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration

 
#ifndef FPGATrackSimREGIONMAP_H
#define FPGATrackSimREGIONMAP_H
 
#include "FPGATrackSimMaps/FPGATrackSimPlaneMap.h"
 
#include <vector>
#include <map>
#include <fstream>
 
class FPGATrackSimHit;
 
 
struct FPGATrackSimRegionBoundaries
{
    int phi_min{}; // minimum phi ID
    int phi_max{}; // maximum phi ID
    int eta_min{}; // minimum eta ID
    int eta_max{}; // minimum eta ID
};
 
 
class FPGATrackSimRegionMap 
{
    public:

        // Constructors/Initialization
        // See doc on m_layerOverrides for info on argument layerOverrides
 
        FPGATrackSimRegionMap(const std::vector<std::unique_ptr<FPGATrackSimPlaneMap>> & pmaps, std::string const & filepath, bool m_inclusive);
 
        void loadModuleIDLUT(std::string const & filepath);
 
        void loadRadiiFile(std::string const& radii_file, unsigned layer_offset, unsigned layer_max);

        // Simple Getters/Setters
 
        const FPGATrackSimPlaneMap* getPlaneMap(int iRegion) const { return m_pmaps.at(iRegion).get(); }
 
        int getNRegions() const { return m_nregions; }
 
        bool isModuleIDLUTloaded() const { return !m_global_local_map.empty(); }

        // Main Interface Functions
 
        const FPGATrackSimRegionBoundaries & getRegionBoundaries(int region, int layer, int section) const
            { return m_map.at(region).at(layer).at(section); }
 
        bool isInRegion(uint32_t region, const FPGATrackSimHit &hit) const;
        bool isInRegion(uint32_t region, uint32_t plane, uint32_t section, int eta, int phi) const;
 
        // Returns a list of regions that hit belongs to
        std::vector<uint32_t> getRegions(const FPGATrackSimHit &hit) const;
 
        uint32_t getUnmappedID(uint32_t region, const FPGATrackSimHit &hit) const;
 
        // These require the module LUT file to be loaded
        uint32_t getLocalID(uint32_t region, uint32_t layer, uint32_t globalModuleID) const;
        uint32_t getGlobalID(uint32_t region, uint32_t layer, uint32_t localModuleID) const;
 
        // These require the radii file to be loaded.
        double getAvgRadius(unsigned region, unsigned layer) const;
        const std::vector<double>& getAvgRadii(unsigned region) const { return m_radii_map.at(region); };
 
    private:
        std::string m_filepath;
        std::vector<std::unique_ptr<FPGATrackSimPlaneMap>> const & m_pmaps  ;
        int m_nregions = 0;
 
        std::vector<std::vector<std::vector<FPGATrackSimRegionBoundaries>>> m_map;
            // Index by region, logical layer, section
 
        std::vector<std::vector<std::map<uint32_t, uint32_t>>> m_global_local_map;
            // Index by region, logical layer, globalID. Returns a local id.
 
        std::vector<std::vector<double>> m_radii_map;
            // Index by region, logical layer. Assume we DON'T have separate radii per section.
 
        // If set, this means that we don't actually try to read the region map.
        bool m_inclusive = false;

        // Helper Functions
        void allocateMap(std::ifstream & fin);
        void readRegion(std::ifstream & fin, int expected_region);
};
 
#endif // FPGATrackSimREGIONMAP_H