L1Menu.cxx

Go to the documentation of this file.

/*
   Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "TrigConfData/L1Menu.h"
using namespace std;
 
#include <iterator>
#include <utility>
TrigConf::L1Menu::L1Menu()
{}
 
TrigConf::L1Menu::L1Menu(const boost::property_tree::ptree & data) 
   : DataStructure(data)
{
   load();
}
 
void
TrigConf::L1Menu::load()
{
   if(! isInitialized() || empty() ) {
      return;
   }
 
   m_run = getAttribute_optional<int>("run").value_or(3);
   
   // thresholds
   try {
      m_name = getAttribute("name");
      for( const std::string path : {"thresholds", "thresholds.legacyCalo" } ) {
         for( auto & thrByType : data().get_child( path ) ) {
            const std::string & thrType = thrByType.first;
            if (thrType == "legacyCalo")
               continue;
         
            // first create the extraInfo object for this type of thresholds
            auto extraInfo = m_thrExtraInfo.addExtraInfo(thrByType.first,thrByType.second);
 
            auto & v = m_thresholdsByType[thrType] = std::vector<std::shared_ptr<TrigConf::L1Threshold>>();
            if(thrType == "internal") {
               for( auto & thr : data().get_child( path + ".internal.names") ) {
                  const std::string thrName = thr.second.data();
                  v.push_back( L1Threshold::createThreshold( thrName, thrType, extraInfo, thr.second ) );
               }
            } else {
               for( auto & thr : data().get_child( path + "." + thrType + ".thresholds") ) {
                  const std::string thrName = thr.first;
                  v.push_back( L1Threshold::createThreshold( thrName, thrType, extraInfo, thr.second ) );
               }
            }
            for( auto & thr : v ) {
               m_thresholdsByName[ thr->name() ] = thr;
            }
            for (auto &thr : v) {
               m_thresholdsByTypeAndMapping[thrType][thr->mapping()] = thr;
            }
         }
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (thresholds). " << ex.what() << std::endl;
      throw;
   }
 
   // boards
   try {
      for( auto & board : data().get_child( "boards" ) ) {
         m_boards.emplace( std::piecewise_construct,
                           std::forward_as_tuple(board.first),
                           std::forward_as_tuple(board.first, board.second) );
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (boards). " << ex.what() << std::endl;
      throw;
   }
 
   // connectors
   try {
      for( auto & conn : data().get_child( "connectors" ) ) {
         auto res = m_connectors.emplace( std::piecewise_construct,
                                          std::forward_as_tuple(conn.first),
                                          std::forward_as_tuple(conn.first, conn.second) );
         for( auto & tl : res.first->second.triggerLineNames() ) {
            m_threshold2ConnectorName.emplace( std::piecewise_construct,
                                               std::forward_as_tuple(tl),
                                               std::forward_as_tuple(conn.first));
         }
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (connectors). " << ex.what() << std::endl;
      throw;
   }
 
   // algorithms
   if(m_run>1) {
      try {
         auto topoCategories = isRun2() ? std::vector<std::string> {"R2TOPO"} : std::vector<std::string> {"TOPO", "MUTOPO", "MULTTOPO", "R2TOPO"};
         for( const std::string& algoCategory : topoCategories ) {
            auto & v = m_algorithmsByCategory[algoCategory] = std::vector<TrigConf::L1TopoAlgorithm>();
            m_algorithmsByName.emplace(algoCategory, std::map<std::string, TrigConf::L1TopoAlgorithm*>());
            m_algorithmsByOutput.emplace(algoCategory, std::map<std::string, TrigConf::L1TopoAlgorithm*>());
            if(algoCategory == "MULTTOPO") {
               for( auto & alg : data().get_child( "topoAlgorithms." + algoCategory + ".multiplicityAlgorithms" ) ) {
                  v.emplace_back( alg.first, L1TopoAlgorithm::AlgorithmType::MULTIPLICITY, algoCategory, alg.second );
               }
            } else {
               for( L1TopoAlgorithm::AlgorithmType algoType : { L1TopoAlgorithm::AlgorithmType::DECISION, L1TopoAlgorithm::AlgorithmType::SORTING } ) {
                  std::string subpath = "topoAlgorithms." + algoCategory + (algoType==L1TopoAlgorithm::AlgorithmType::DECISION ? ".decisionAlgorithms" : ".sortingAlgorithms" );  
                  for( auto & algorithm : data().get_child( subpath ) ) {
                     v.emplace_back( algorithm.first, algoType, algoCategory, algorithm.second );
                  }
               }
            }
            for( auto & algo : v ) {
               if( m_algorithmsByName[algoCategory].count(algo.name()) > 0 ) {
                  std::cerr << "ERROR : Topo algorithm with name " << algo.name() << " and of type " << algoCategory << " already exists" << std::endl;
                  throw std::runtime_error("Found duplicate topo algorithm name " + algo.name() + " of type " + algoCategory);
               }
               m_algorithmsByName[ algoCategory ][ algo.name() ] = & algo;
               for( const std::string & output : algo.outputs() ) {
                  if( m_algorithmsByOutput[algoCategory].count(output) > 0 ) {
                     std::cerr << "ERROR : Topo algorithm output " << output << " already exists" << std::endl;
                     throw std::runtime_error("Found duplicate topo algorithm output " + output + " of type " + algoCategory);
                  }
                  m_algorithmsByOutput[algoCategory][output] = & algo;
               }
            }
         }
      }
      catch(std::exception & ex) {
         std::cerr << "ERROR: problem when building L1 menu structure (algorithms). " << ex.what() << std::endl;
         throw;
      }
   }
 
   // CTP
   try {
      m_ctp.setData(data().get_child("ctp"));
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (CTP). " << ex.what() << std::endl;
      throw;
   }
}
 
void
TrigConf::L1Menu::clear()
{
   DataStructure::clear();
 
   m_smk = 0;
   m_run = 3;
   m_connectors.clear();
   m_threshold2ConnectorName.clear();
   m_boards.clear();
   m_thresholdsByType.clear();
   m_thresholdsByName.clear();
   m_thresholdsByTypeAndMapping.clear();
 
   m_thrExtraInfo.clear();
 
   m_algorithmsByCategory.clear();
   m_algorithmsByName.clear();
   m_algorithmsByOutput.clear(); 
 
   m_ctp.clear();
}
 
unsigned int 
TrigConf::L1Menu::version() const
{
   return getAttribute<unsigned int>("version");
}
 
unsigned int 
TrigConf::L1Menu::ctpVersion() const
{
   return getAttribute<unsigned int>("ctpVersion");
}
 
std::size_t 
TrigConf::L1Menu::size() const
{
   return data().get_child("items").size();
}
 
unsigned int
TrigConf::L1Menu::smk() const {
   return m_smk;
}
 
void
TrigConf::L1Menu::setSMK(unsigned int smk) {
   m_smk = smk;
}
 
TrigConf::L1Item
TrigConf::L1Menu::item(const std::string & itemName) const
{
   if(itemName=="") {
      throw std::runtime_error("L1Menu::item() was called with empty itemName");
   }
   const ptree * pt;
   try {
      pt = & data().get_child(ptree::path_type("items/"+itemName,'/')); // '/' is not used in any item Name, so we can use it as separator in the path 
   } catch(boost::property_tree::ptree_bad_path & ex) {
      throw std::runtime_error("L1Item " + itemName + " does not exist in the menu");
   }
   return L1Item(*pt);
}
 
TrigConf::L1Menu::const_iterator
TrigConf::L1Menu::begin() const
{
   return {data().get_child("items"), 0,  [](auto & x){return L1Item(x.second);}};
}
 
 
TrigConf::L1Menu::const_iterator
TrigConf::L1Menu::end() const
{
   const auto & items = data().get_child("items");
   return {items, items.size(), [](auto & x){return L1Item(x.second);}};
}
 
 
std::vector<std::string> 
TrigConf::L1Menu::thresholdTypes() const
{
   std::vector<std::string> thrTypeNames;
   thrTypeNames.reserve(m_thresholdsByType.size());
   for( const auto & x : m_thresholdsByType ) {
      thrTypeNames.emplace_back(x.first);
   }
   return thrTypeNames;
}
 
std::vector<std::string>
TrigConf::L1Menu::thresholdNames() const
{
   std::vector<std::string> thrNames;
   thrNames.reserve(m_thresholdsByName.size());
   for( const auto & x : m_thresholdsByName ) {
      thrNames.emplace_back(x.first);
   }
   return thrNames;
}
 
 
const std::vector<std::shared_ptr<TrigConf::L1Threshold>>&
TrigConf::L1Menu::thresholds(std::string_view typeName) const
{
  const auto it = m_thresholdsByType.find(typeName);
  if (it == m_thresholdsByType.end()) {
    std::cerr << "No threshold type '" << typeName
              << "' defined in the thresholds section of the L1 menu" << std::endl;
    throw std::out_of_range("No threshold type defined in the thresholds section of the L1 menu");
  }
  return it->second;
}
 
std::vector<std::shared_ptr<TrigConf::L1Threshold>> 
TrigConf::L1Menu::thresholds() const
{
   std::vector<std::shared_ptr<TrigConf::L1Threshold>> thrlist;
   for ( const std::string & type : thresholdTypes() ) {
      const auto & thrOfType = thresholds(type);
      std::copy(thrOfType.begin(), thrOfType.end(), std::back_inserter(thrlist));
   }
   return thrlist;
}
 
 
const TrigConf::L1Threshold&
TrigConf::L1Menu::threshold(std::string_view thresholdName) const
{
  const auto it = m_thresholdsByName.find(thresholdName);
  if (it == m_thresholdsByName.end()) {
    std::cerr << "No threshold '" << thresholdName
              << "' defined in the thresholds section of the L1 menu" << std::endl;
    throw std::out_of_range("No threshold defined in the thresholds section of the L1 menu");
  }
 
  return *it->second;
}

const TrigConf::L1Threshold&
TrigConf::L1Menu::threshold(std::string_view typeName, unsigned int mapping) const
{
  const auto typeIt = m_thresholdsByTypeAndMapping.find(typeName);
  if (typeIt == m_thresholdsByTypeAndMapping.end()) {
    std::cerr << "No threshold of type '" << typeName
              << "' defined in the thresholds section of the L1 menu" << std::endl;
    throw std::out_of_range("No threshold type defined in the thresholds section of the L1 menu");
  }
 
  const auto mappingIt = typeIt->second.find(mapping);
  if (mappingIt == typeIt->second.end()) {
    std::cerr << "No threshold of type '" << typeName
              << "' with mapping " << mapping
              << " defined in the thresholds section of the L1 menu" << std::endl;
    throw std::out_of_range("No threshold mapping defined in the thresholds section of the L1 menu");
  }
 
  return *mappingIt->second;
}
 
const TrigConf::L1ThrExtraInfo &
TrigConf::L1Menu::thrExtraInfo() const
{
   return m_thrExtraInfo;
}
 
const std::string &
TrigConf::L1Menu::connectorNameFromThreshold(const std::string & thresholdName) const
{
   try {
      return m_threshold2ConnectorName.at(thresholdName);
   }
   catch(...) {
      std::cerr << "Threshold '" << thresholdName << "' not defined as triggerline in the L1 menu" << std::endl;
      throw;      
   }
}
 
std::vector<std::string>
TrigConf::L1Menu::connectorNames() const {
   std::vector<std::string> connNames;
   connNames.reserve(m_connectors.size());
   for( auto & x : m_connectors ) {
      connNames.emplace_back(x.first);
   }
   return connNames;
}
 
const TrigConf::L1Connector &
TrigConf::L1Menu::connector(const std::string & connectorName) const {
   try {
      return m_connectors.at(connectorName);
   }
   catch(std::exception & ex) {
      std::cerr << "No connector " << connectorName << " defined in the L1 menu" << std::endl;
      throw;
   }
}

std::vector<std::string>
TrigConf::L1Menu::topoAlgorithmNames(const std::string & category) const
{
   std::vector<std::string> algoNames;
   try {
      for(auto & entry : m_algorithmsByName.at(category) ) {
         algoNames.push_back(entry.first);
      }
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm category '" << category << "' defined in the L1 menu" << std::endl;
      throw;
   }
   return algoNames;
}

std::vector<std::string>
TrigConf::L1Menu::topoAlgorithmOutputNames(const std::string & category) const
{
   std::vector<std::string> outputNames;
   try {
      for(auto & entry : m_algorithmsByOutput.at(category) ) {
         outputNames.push_back(entry.first);
      }
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm category '" << category << "' defined in the L1 menu" << std::endl;
      throw;
   }
   return outputNames;
}
 
 
 
const TrigConf::L1TopoAlgorithm & 
TrigConf::L1Menu::algorithm(const std::string & algoName, std::string_view category) const
{
   const auto itr = m_algorithmsByName.find(category);
   if (itr == m_algorithmsByName.end()){
     throw std::out_of_range("TrigConf::L1Menu::algorithm: No algorithm of category "+std::string{category}+ " found.");
   }
   try {
      return * itr->second.at(algoName);
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm " << algoName << " in the " << category << "category  defined in the L1 menu" << std::endl;
      throw;
   }
}
 
const TrigConf::L1TopoAlgorithm &
TrigConf::L1Menu::algorithmFromTriggerline(const std::string & triggerlineName) const
{
   std::string category {"MULTTOPO"};
   std::string outputName {triggerlineName};
   if( std::size_t pos = triggerlineName.find('_'); pos != std::string::npos ) {
      category = triggerlineName.substr(0,pos);
      outputName = triggerlineName.substr(pos+1);
   }
   const static std::vector<string> topoTypes {"TOPO", "R2TOPO", "MULTTOPO", "MUTOPO"};
   if( std::none_of(cbegin(topoTypes), cend(topoTypes), [&category](const std::string & str){return str==category;}) ) {
      std::string msg = "L1Menu::algorithmFromTriggerLine(" + triggerlineName + "): triggerline " + triggerlineName + " is not produced by a topo algorithm.";
      throw std::runtime_error(msg);
   }
   try {
      return * m_algorithmsByOutput.at(category).at(outputName);
   }
   catch(std::exception & ex) {
      std::cerr << "L1Menu::algorithmFromTriggerLine(): No output " << outputName << " defined by any algorithm of category " << category << " in the L1 menu. (It was asked for " << triggerlineName << ")" << std::endl;
      throw;
   }
}
 
const TrigConf::L1TopoAlgorithm &
TrigConf::L1Menu::algorithmFromOutput(const std::string & bareOutputName, const std::string & type) const
{
   try {
      return * m_algorithmsByOutput.at(type).at(bareOutputName);
   }
   catch(std::exception & ex) {
      std::cerr << "No output " << bareOutputName << " defined by any algorithm of type " << type << " in the L1 menu" << std::endl;
      throw;
   }
}
 
const TrigConf::L1Board &
TrigConf::L1Menu::board(const std::string & boardName) const
{
   try {
      return m_boards.at(boardName);
   }
   catch(std::exception & ex) {
      std::cerr << "No board " << boardName << " defined in the L1 menu" << std::endl;
      throw;
   }
}
 
std::vector<std::string>
TrigConf::L1Menu::boardNames() const
{
   std::vector<std::string> boardNames;
   boardNames.reserve(m_boards.size());
   for(auto & board : m_boards) {
      boardNames.emplace_back(board.first);
   }
   return boardNames;
}
 
 
 
 
void
TrigConf::L1Menu::printMenu(bool full) const
{
   cout << "L1 menu '" << name() << "'" << endl;
   cout << "Items: " << size() << endl;
   if(full) {
      int c(0);
      for(const L1Item & item : *this ) {
         cout << "  " << c++ << ": " << item.name() << endl;
      }
   }
   cout << "Thresholds: " << thresholds().size() << "(of " << thresholdTypes().size() << " different types)" << endl;
   if(full) {
      int c(0);
      for(const std::string & thrType : thresholdTypes() ) {
         cout << thrType << " :" << endl;
         for(auto & thr : thresholds(thrType)) {
            cout << "  " << c++ << ": " << thr->name() << "[" << thr->type() << "]" << endl;
         }
      }
   }
   if(m_run>1) {
      cout << "Topo algorithms: " << endl;
      cout << "    new   : " << data().get_child("topoAlgorithms.TOPO.decisionAlgorithms").size() << endl;
      cout << "    muon  : " << data().get_child("topoAlgorithms.MUTOPO.decisionAlgorithms").size() << endl;
      cout << "    mult  : " << data().get_child("topoAlgorithms.MULTTOPO.multiplicityAlgorithms").size() << endl;
      cout << "    legacy: " << data().get_child("topoAlgorithms.R2TOPO.decisionAlgorithms").size() << endl;
   }
   cout << "Boards: " << data().get_child("boards").size() << endl;
   cout << "Connectors: " << data().get_child("connectors").size() << endl;
   unsigned int ctpinputs = data().get_child("ctp.inputs.optical").size();
   ctpinputs += data().get_child("ctp.inputs.electrical").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot7").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot8").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot9").size();
   cout << "CTP connections: " << ctpinputs << endl;
}