LArEM_Base_ID.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef CALOIDENTIFIER_LAREM_BASE_ID_H
#define CALOIDENTIFIER_LAREM_BASE_ID_H
 
 
#include "AtlasDetDescr/AtlasDetectorID.h"
#include "Identifier/IdentifierHash.h"
#include "IdDict/IdDictFieldImplementation.h"
#include "CaloIdentifier/LArNeighbours.h"
#include "CaloIdentifier/CaloIDHelper.h"
#include "CaloIdentifier/LArID_Exception.h"
#include <ranges>
 
 
class IdDictRegion;
class LArEM_region;
 
 

class LArEM_Base_ID : public CaloIDHelper
{
public:
  typedef Identifier::size_type  size_type ;

  LArEM_Base_ID (const std::string& name,
                 const std::string& group,
                 bool supercell);
 
  ~LArEM_Base_ID();

  Identifier region_id (const ExpandedIdentifier& exp_id) const;
                 
  Identifier channel_id (const ExpandedIdentifier& exp_id) const;
                 
  Identifier  region_id      (int barrel_ec, int sampling, int region ) const;
  Identifier  region_id      (int barrel_ec, int sampling, int region, bool checks ) const;

  Identifier  channel_id    (int barrel_ec, int sampling, int region,
                 int eta,       int phi )  const;
  Identifier  channel_id    (int barrel_ec, int sampling, int region,
                 int eta,       int phi, bool checks )  const;

  Identifier  region_id      (const Identifier channelId) const ;

  Identifier  channel_id    (const Identifier regionId,
                 int eta,       int phi ) const;
  Identifier  channel_id    (const Identifier regionId,
                 int eta,       int phi, bool checks ) const;

  IdentifierHash channel_hash (Identifier channelId) const;
  IdentifierHash channel_hash_binary_search (Identifier channelId) const;

  using id_iterator = std::vector<Identifier>::const_iterator;
  using id_range = std::ranges::subrange<id_iterator>;
  

  id_iterator reg_begin    () const;
  id_iterator reg_end      () const;
  id_range reg_range () const;

  id_iterator em_begin    () const;
  id_iterator em_end      () const;
  id_range em_range () const;

  const std::vector<Identifier>& channel_ids() const;

  bool  is_em_barrel    (const Identifier id) const;
  
  bool  is_em_endcap    (const Identifier id) const;
  
  bool  is_em_endcap_inner    (const Identifier id) const;
  
  bool  is_em_endcap_outer    (const Identifier id) const;
 
 
 

  int         barrel_ec       (const Identifier id)const;  

  int         sampling        (const Identifier id)const;  
  

  int         region          (const Identifier id)const;  
  
  int         eta             (const Identifier id)const; 
  
  int         phi             (const Identifier id)const;
  

  bool        is_supercell    (const Identifier id)const;
 

  int eta_min(const Identifier regId) const;
  int eta_max(const Identifier regId) const;
  int phi_min(const Identifier regId) const;
  int phi_max(const Identifier regId) const;
  

  int initialize_base_from_dictionary (const IdDictMgr& dict_mgr,
                                       const std::string& group_name);
 

  bool twoSymSides() const;
 

  int get_neighbours(const IdentifierHash id,
                     const LArNeighbours::neighbourOption& option,
                     std::vector<IdentifierHash>& neighbourList) const;
 
 
  using CaloIDHelper::region_id;
  using CaloIDHelper::region_hash;
  using CaloIDHelper::channel_id;
  // Inherited from CaloIDHelper:
  // 
  //Identifier channel_id (IdentifierHash hashId) const;
  //Identifier region_id (IdentifierHash hashId) const;
  //IdentifierHash region_hash (Identifier regionId) const;
  //size_type channel_hash_max() const;
  //size_type region_hash_max() const;
  //IdContext channel_context() const;
  //IdContext region_context() const;
  //const std::vector<const IdDictRegion*>& dictRegions() const;
  //float etaGranularity(const IdentifierHash regHash) const;
  //float phiGranularity(const IdentifierHash regHash) const;
  //float eta0(const IdentifierHash regHash) const;
  //float phi0(const IdentifierHash regHash) const;
  //virtual int get_id (const IdentifierHash& hash_id,
  //                    Identifier& id,
  //                    const IdContext* context = 0 ) const;
  //virtual int  get_hash  (const Identifier& id,
  //                        IdentifierHash& hash_id,
  //                        const IdContext* context = 0 ) const;
 
 
private:
  enum {NOT_VALID_HASH = 256000};
 
  // Check methods
  void  region_id_checks    (int barrel_ec, int sampling, int region ) const;
  void  channel_id_checks      (int barrel_ec, int sampling, int region,
                 int eta,       int phi ) const;
  void  channel_id_checks      (const Identifier regionId,
                 int eta,       int phi ) const;

  virtual int  get_expanded_id  (const Identifier& id, ExpandedIdentifier& exp_id, const IdContext* context) const;
 
  int phi_min_init(const Identifier regId) const;
 
  int         initLevelsFromDict (const std::string& group_name);
  int         init_hashes();
 
  static int   get_prevInPhi(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
              int& neighbourIndex, IdentifierHash* neighbList) ;
 
  static int   get_nextInPhi(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
              int& neighbourIndex, IdentifierHash* neighbList) ;
 
  int   get_prevInEta(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const float& gPhi, const unsigned int& minHash, 
              int& neighbourIndex, IdentifierHash* neighbList, unsigned int& nBiggerCell) const;
 
  int   get_nextInEta(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const float& gPhi, const unsigned int& maxHash, 
              int& neighbourIndex, IdentifierHash* neighbList, unsigned int& nBiggerCell) const;
 
  int   get_prevInSamp(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
               const double& gEta, const float& gPhi, const double& absEta,
               int& neighbourIndex, IdentifierHash* neighbList) const;
  
  int   get_nextInSamp(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
               const double& gEta, const float& gPhi, const double& absEta,
               int& neighbourIndex, IdentifierHash* neighbList) const;
 
  int   get_prevInSubdet(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
             const double& gEta, const float& gPhi, const double& absEta,
             int& neighbourIndex, IdentifierHash* neighbList) const;
 
  int   get_nextInSubdet(const LArEM_region* emRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
             const double& gEta, const float& gPhi, const double& absEta,
             int& neighbourIndex, IdentifierHash* neighbList) const;
 
 
 
  int         init_neighbors();
 
 
private:
  unsigned                      m_slar{0};
 
  bool                          m_two_sym_sides{true};
 
  MultiRange                    m_full_region_range;
  MultiRange                    m_full_em_range;
 
  size_type                     m_em_region_index{0};
  size_type                     m_LAR_INDEX{999};
  size_type                     m_EM_INDEX{999};
  size_type                     m_BEC_INDEX{999};
  size_type                     m_SAMPLING_INDEX{999};
  size_type                     m_REGION_INDEX{999};
  size_type                     m_ETA_INDEX{999};
  size_type                     m_PHI_INDEX{999};
  size_type                     m_SLAR_INDEX{999};
 
  IdDictFieldImplementation     m_lar_impl;
  IdDictFieldImplementation    m_em_impl;
  IdDictFieldImplementation    m_bec_impl;
  IdDictFieldImplementation    m_sampling_impl;
  IdDictFieldImplementation    m_region_impl;
  IdDictFieldImplementation    m_eta_impl;
  IdDictFieldImplementation    m_phi_impl;
 
  IdDictFieldImplementation    m_slar_impl;
 
  std::vector<int>              m_vecOfPhiMin;

    class HashCalc
    {
    public:
    HashCalc() :
        m_hash(0),
        m_etamin(0),
        m_phimin(0),
        m_nphi(0) {}
    IdentifierHash m_hash;
    size_type      m_etamin;
    size_type      m_phimin;
    size_type      m_nphi;
    };
  std::vector<HashCalc>         m_hash_calcs;
 
  IdDictFieldImplementation    m_bec_reg_impl;
 
  std::vector<LArEM_region*>    m_vecOfRegions;
  std::vector<unsigned>         m_cells;          // stores starting hash number of each region, regions are ordered by hash so this array is ordered as well
 
  LArEM_Base_ID (const LArEM_Base_ID&);
  LArEM_Base_ID& operator= (const LArEM_Base_ID&);
};
 
 
#include "CaloIdentifier/LArEM_Base_ID.icc"
 
 
#endif // not CALOIDENTIFIER_LAREM_BASE_ID_H