eFEXSuperCellTowerIdProvider.cxx

Go to the documentation of this file.

/*
   Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "L1CaloFEXSim/eFEXSuperCellTowerIdProvider.h"
#include <iostream>
#include <fstream>
#include <string>
#include "PathResolver/PathResolver.h"
 
LVL1::eFEXSuperCellTowerIdProvider::eFEXSuperCellTowerIdProvider(const std::string &type, const std::string &name, const IInterface *parent):
  AthAlgTool(type, name, parent)
{
  declareInterface<eFEXSuperCellTowerIdProvider>(this);
}
 
LVL1::eFEXSuperCellTowerIdProvider::~eFEXSuperCellTowerIdProvider()
{
}
 
StatusCode LVL1::eFEXSuperCellTowerIdProvider::initialize()
{
  m_hascsvfile = false;
  std::string csvpath = PathResolver::find_file("sc_tower_map.csv", "DATAPATH");
  if (setAddress(csvpath) == StatusCode::FAILURE) {
    ATH_MSG_WARNING("sc_tower_map.csv missing or invalid. Swiching to hard-coded mapping.");
  };
  return StatusCode::SUCCESS;   
}
 
StatusCode LVL1::eFEXSuperCellTowerIdProvider::setAddress(const std::string& inputaddress)
{
  if (inputaddress.empty()) {
    m_hascsvfile = false;
    return StatusCode::FAILURE;
  }
 
  m_hascsvfile = true;
  m_csvaddress = inputaddress;
  if ( loadcsv() == StatusCode::FAILURE) {
    m_hascsvfile = false;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}
 
StatusCode LVL1::eFEXSuperCellTowerIdProvider::geteTowerIDandslot(uint64_t scid, int &eTowerID, int &slot, bool &issplit) const
{
  auto mapentry = m_SuperCelltoTowerIdmap.find(scid);
 
  if (mapentry != m_SuperCelltoTowerIdmap.end()) {
    towerinfo towerinfo_tem = mapentry->second;
    eTowerID = towerinfo_tem.eTowerID;
    slot = towerinfo_tem.slot;
    issplit = towerinfo_tem.isSplit;
  } else {
    // The csv file only contains valid SuperCell
    // Ingore invalid id.
    eTowerID = -1;
    slot = -1;
    issplit = false;
  }
 
  return StatusCode::SUCCESS;
}
 
bool LVL1::eFEXSuperCellTowerIdProvider::hasSuperCell(uint64_t scid) const
{
  auto haskey = m_SuperCelltoTowerIdmap.find(scid);
  if (haskey == m_SuperCelltoTowerIdmap.end()) {
    return false;
  }
  return true;
}
 
bool LVL1::eFEXSuperCellTowerIdProvider::ifhaveinputfile() const {
  return m_hascsvfile;
}
 
StatusCode LVL1::eFEXSuperCellTowerIdProvider::loadcsv()
{
  // read the .csv file line by line
  std::string eachline;
  std::ifstream myfile(m_csvaddress);
  if (myfile.is_open()) {
    while (std::getline(myfile, eachline)) {
 
      // ignore text after #
      std::string::size_type ipos = eachline.find("#");
      if (ipos!=std::string::npos) eachline.resize(ipos);
 
      // prevent reading lines with only white spaces
      if (std::all_of(eachline.begin(), eachline.end(), ::isspace)) {
        continue;
      }
 
      // split lines in the .csv file by comma
      std::stringstream eachline_stream(eachline);
      int each_etowerid{ -1 }, each_slot{ -1 };
      bool eachisSplit{ false };
      std::string each_scid = "";
      int i{ 0 };
      while (eachline_stream.good()) {
        i++;
        int number_in_eachline;
        std::string tem_string;
        std::getline(eachline_stream, tem_string, ',');
        // first column: tower id
        // second column: supercell id
        // third column: slot number
        // fourth column: if split energy
        if (i == 1 || i == 3 || i == 4) {
          try {
            number_in_eachline = std::stoi(tem_string);
          }
          catch (...) {
            ATH_MSG_ERROR( "Invalid input in " << m_csvaddress << ". Unable to convert " << tem_string << " to int.");
            return StatusCode::FAILURE;
          }
          if (i == 1) {
            each_etowerid = number_in_eachline;
          } else if (i == 3) {
            each_slot = number_in_eachline;
          } else {
            // check if the fourth column is a boolean or not
            if (number_in_eachline != 0 && number_in_eachline != 1) {
              ATH_MSG_ERROR("Invalid input in " << m_csvaddress << ". Unable to reader the fourth column.");
              return StatusCode::FAILURE;
            }
            eachisSplit = number_in_eachline;
          }
        }
        else if (i == 2) {
          each_scid = std::move(tem_string);
        }
        else {
          ATH_MSG_ERROR("Invalid input in " << m_csvaddress << ". Too many columns.");
          return StatusCode::FAILURE;
        }
      }
      
      // check the range of tower id
      if (each_etowerid > 601599 || each_etowerid < 100000) {
        ATH_MSG_ERROR("Invalid eTower ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      // check the range of slot
      if (each_slot > 13 || each_slot < 0) {
        ATH_MSG_ERROR("Invalid slot number in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      // The Hexadecimal SuperCell id should always start as 0x
      if (each_scid.find("0x") == std::string::npos) {
        ATH_MSG_ERROR("Invalid SuperCell ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      towerinfo each_towerinfo;
      each_towerinfo.eTowerID = each_etowerid;
      each_towerinfo.slot = each_slot;
      each_towerinfo.isSplit = eachisSplit;
      uint64_t scid_uint64 = strtoull(each_scid.c_str(), nullptr, 16);
      try {
        m_SuperCelltoTowerIdmap[scid_uint64] = each_towerinfo;
      } catch (...) {
        ATH_MSG_ERROR("Invalid SuperCell ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
    }
    myfile.close();
  }
  else {
    ATH_MSG_ERROR("eFEXFPGATowerIdProvider: Unable to open" << m_csvaddress << ".");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}