sPhenix code displayed by LXR master/​analysis/​JS-Jet/​BeamBackgroundFilterAndQA/​src/​BeamBackgroundFilterAndQADefs.h	Source navigation Diff markup Identifier search General search
	Version: master Revert   Change

File indexing completed on 2025-08-05 08:13:11

 /// ===========================================================================
 /*! \file    BeamBackgroundFilterAndQADefs.h
  *  \authors Derek Anderson
  *  \date    11.01.2024
  *
  *  A namespace to hold various definitions
  *  useful across the BeamBackgroundFilterAndQA
  *  module and its various filters.
  */
 /// ===========================================================================
 
 #ifndef BEAMBACKGROUNDFILTERANDQADEFS_H
 #define BEAMBACKGROUNDFILTERANDQADEFS_H
 
 // c++ utilities
 #include <algorithm>
 #include <array>
 
 // calo base
 #include <calobase/TowerInfo.h>
 #include <calobase/TowerInfoContainer.h>
 
 // ============================================================================
 //! Misc beam background filter and QA definitions
 // ============================================================================
 namespace BeamBackgroundFilterAndQADefs
 {
 
   // ==========================================================================
   //! Event status codes
   // ==========================================================================
   /*! This enumerates the outcomes of applying a filter:
    *    Evt     = null, no filter applied yet
    *    NoBkgd  = filter finds there is no beam background
    *    HasBkgd = filter finds there is beam background
    */
   enum Status
   {
     Evt,
     NoBkgd,
     HasBkgd
   };
 
   // ==========================================================================
   // Helper struct to scrape info from TowerInfo
   // ==========================================================================
   /*! This is a lightweight struct to scrape only the info relevant to various
    *  filters from a TowerInfo object.
    *
    *  An example usage is in the StreakSidebandFilter algorithm, where its used
    *  to build a 2D array of tower energies & status (see below) for quick
    *  lookup.
    */
   struct Tower
   {
     // members
     uint8_t status = 0;
     double energy = -1.;
     bool isGood = false;
     //! grab info from a TowerInfo object
     void SetInfo(TowerInfo* info)
     {
       status = info->get_status();
       energy = info->get_energy();
       isGood = info->get_isGood();
       return;
     }
 
     //! reset values
     void Reset()
     {
       status = 0;
       energy = -1.;
       return;
     }
 
   };  // end Tower
 
   // ==========================================================================
   //! Helper type for building (eta, phi) maps of towers
   // ==========================================================================
   /*! This is a lightweight struct to organize the above Tower structs into a
    *  handy (eta, phi) map. See the StreakSidebandFilter algorithm for an
    *  example usage.
    */
   template <std::size_t H, std::size_t F>
   struct TowerMap
   {
     // members
     std::array<std::array<Tower, F>, H> towers;
 
     //! build array
     void Build(TowerInfoContainer* container)
     {
       for (std::size_t iTwr = 0; iTwr < container->size(); ++iTwr)
       {
         const int32_t key = container->encode_key(iTwr);
         const int32_t iEta = container->getTowerEtaBin(key);
         const int32_t iPhi = container->getTowerPhiBin(key);
         towers.at(iEta).at(iPhi).SetInfo(container->get_tower_at_channel(iTwr));
       }
       return;
     }
 
     //! reset
     void Reset()
     {
       for (auto row : towers)
       {
         for (auto tower : row)
         {
           tower.Reset();
         }
       }
       return;
     }
 
   };  // end TowerArray
 
   // --------------------------------------------------------------------------
   //! Maps for specific calorimeters
   // --------------------------------------------------------------------------
   typedef TowerMap<96, 256> EMCalMap;
   typedef TowerMap<24, 64> IHCalMap;
   typedef TowerMap<24, 64> OHCalMap;
 
   // ==========================================================================
   //! Make QA-compliant histogram names
   // ==========================================================================
   /*! This helper method takes in a list of base names (e.g.
    *  some variable you want to histogram like "JetEne") and
    *  produces a list of histogram names compliant w/ the
    *  rest of the jet QA.
    *
    *  The format should always be:
    *    h_<module name>_<trigger tag>_<jet tag>_<base name> + <tag>
    *
    *  FIXME this should get moved into JetQADefs.h
    */
   inline std::vector<std::string> MakeQAHistNames(
       const std::vector<std::string>& bases,
       const std::string& module,
       const std::string& tag = "")
   {
     // copy base names to list of hist names
     std::vector<std::string> names = bases;
 
     // inject module names, tags, etc.
     for (auto& name : names)
     {
       name.insert(0, "h_" + module + "_");
       if (!tag.empty())
       {
         name.append("_" + tag);
       }
       std::transform(
           name.begin(),
           name.end(),
           name.begin(),
           ::tolower);
     }
     return names;
 
   }  // end 'MakeQAHistNames(
 
 }  // namespace BeamBackgroundFilterAndQADefs
 
 #endif
 
 // end ========================================================================

This page was automatically generated by the 2.3.7 LXR engine. The LXR team