TRT_ID.h

Go to the documentation of this file.

/*
   Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef INDETIDENTIFIER_TRT_ID_H
#define INDETIDENTIFIER_TRT_ID_H
 
#include "AtlasDetDescr/AtlasDetectorID.h"
#include "Identifier/Identifier.h"
#include "Identifier/IdentifierHash.h"
#include "Identifier/MultiRange.h"
#include "Identifier/IdHelper.h"
#include "IdDict/IdDictFieldImplementation.h"
#include "AthenaKernel/CLASS_DEF.h"
 
#include <algorithm>
#include <string>
#include <map>
#include <stdexcept>
#include <cassert>
#include <vector>
 
 
class IdDictDictionary;

 
class TRT_ID final: public AtlasDetectorID
{
public:

  typedef Identifier::size_type size_type;
  typedef std::vector<Identifier>::const_iterator const_id_iterator;
  typedef MultiRange::const_identifier_factory const_expanded_id_iterator;


  TRT_ID();
  ~TRT_ID();


  bool is_valid() const;



  Identifier barrel_ec_id(int barrel_ec) const;
  Identifier barrel_ec_id(int barrel_ec, bool checks) const;

  Identifier module_id(int barrel_ec,
                       int phi_module,
                       int layer_or_wheel) const;
  Identifier module_id(int barrel_ec,
                       int phi_module,
                       int layer_or_wheel,
                       bool checks) const;

  Identifier module_id(IdentifierHash module_hash) const;

  Identifier layer_id(int barrel_ec,
                      int phi_module,
                      int layer_or_wheel,
                      int straw_layer) const;
  Identifier layer_id(int barrel_ec,
                      int phi_module,
                      int layer_or_wheel,
                      int straw_layer,
                      bool checks) const;

  Identifier layer_id(IdentifierHash straw_layer_hash) const;

  Identifier layer_id(const Identifier& module_id,
                      int straw_layer) const;
  Identifier layer_id(const Identifier& module_id,
                      int straw_layer,
                      bool checks) const;

  Identifier layer_id(const Identifier& straw_id) const;

  Identifier straw_id(int barrel_ec,
                      int phi_module,
                      int layer_or_wheel,
                      int straw_layer,
                      int straw) const;
  Identifier straw_id(int barrel_ec,
                      int phi_module,
                      int layer_or_wheel,
                      int straw_layer,
                      int straw,
                      bool checks) const;
 
  Identifier straw_id(const Identifier& module_id,
                      int straw_layer,
                      int straw) const;
  Identifier straw_id(const Identifier& module_id,
                      int straw_layer,
                      int straw,
                      bool checks) const;
 
  Identifier straw_id(const Identifier& layer_id,
                      int straw) const;
  Identifier straw_id(const Identifier& layer_id,
                      int straw,
                      bool checks) const;

  Identifier straw_id(IdentifierHash straw_hash) const;



  void init_straw_hash_vector();
  void reset_straw_hash_vector();


  size_type module_hash_max() const;
  size_type straw_layer_hash_max() const;
  size_type straw_hash_max() const;
 



  const_id_iterator module_begin() const;
  const_id_iterator module_end() const;
  const_id_iterator straw_layer_begin() const;
  const_id_iterator straw_layer_end() const;
  const_expanded_id_iterator straw_begin() const;
  const_expanded_id_iterator straw_end() const;



  IdentifierHash module_hash(Identifier module_id) const;

  IdentifierHash straw_layer_hash(Identifier straw_layer_id) const;

  IdentifierHash straw_hash(Identifier straw_id) const;

  bool is_barrel(const Identifier& id) const;

  int barrel_ec(const Identifier& id) const;
  int phi_module(const Identifier& id) const;
  int layer_or_wheel(const Identifier& id) const;
  int straw_layer(const Identifier& id) const;
  int straw(const Identifier& id) const;

  int straw_layer_max(const Identifier& id) const;
  int straw_max(const Identifier& id) const;
 



  IdContext barrel_context() const;
  IdContext module_context() const;
  IdContext straw_layer_context() const;
  IdContext straw_context() const;
 



  virtual int get_id(const IdentifierHash& hash_id,
                     Identifier& id,
                     const IdContext* context = 0) const override final;

  virtual int get_hash(const Identifier& id,
                       IdentifierHash& hash_id,
                       const IdContext* context = 0) const override final;



  Identifier straw_id(const ExpandedIdentifier& straw_id) const;
 
 

  virtual int initialize_from_dictionary(const IdDictMgr& dict_mgr) override final;

  int get_straw_layer_hash_calc(const ExpandedIdentifier& id,
                                IdentifierHash& hash_id) const;
 

  void get_expanded_id(const Identifier& id,
                       ExpandedIdentifier& exp_id,
                       const IdContext* context = 0) const;

  void test_trt_ids();
 
 
  enum        MODULE_RANGE {
    NUMBER_OF_EC_MODULES = 18
  };
private:
  typedef std::vector<Identifier>     hash_vec;
  typedef hash_vec::const_iterator hash_vec_it;
 
  enum        VALUES {
    BARREL_VALUE           = 1
  };
 
  void barrel_ec_id_checks(int barrel_ec) const;
  void module_id_checks(int barrel_ec,
                        int phi_module,
                        int layer_or_wheel) const;
  void straw_id_checks(int barrel_ec,
                       int phi_module,
                       int layer_or_wheel,
                       int straw_layer,
                       int straw) const;
  void layer_id_checks(int barrel_ec,
                       int phi_module,
                       int layer_or_wheel,
                       int straw_layer) const;
 
  int initLevelsFromDict();
 
  void init_hashes();
  // Private access only for hash from binary search - must have
  // done init_straw_hashes for this to work
  IdentifierHash straw_hash_bin(Identifier straw_id) const;
 
  // print out the invalid message
  void invalidMessage() const;
  //compose errMsg used in exception
  std::string errMsg(const std::string & txt, unsigned v, size_t limit) const;
  //
  bool m_is_valid;
  size_type m_trt_region_index;
  size_type m_INDET_INDEX;
  size_type m_TRT_INDEX;
  size_type m_BARREL_EC_INDEX;
  size_type m_PHI_MODULE_INDEX;
  size_type m_LAYER_OR_WHEEL_INDEX;
  size_type m_STRAW_LAYER_INDEX;
  size_type m_STRAW_INDEX;
  const IdDictDictionary* m_dict;
  MultiRange m_full_straw_range;
  MultiRange m_full_straw_layer_range;
  MultiRange m_full_module_range;
  size_type m_module_hash_max;
  size_type m_straw_layer_hash_max;
  size_type m_straw_hash_max;
  Range::field m_barrel_field;
  hash_vec m_module_vec;
  hash_vec m_straw_layer_vec;
  hash_vec m_straw_vec;
 
  class HashCalc
  {
  public:
    HashCalc() :
      m_hash(0),
      m_deltaPhi(0),
      m_layerMin(0),
      m_strLayerMin(0),
      m_nStrawLayers(0),
      m_nstraws(0)
    {}
    IdentifierHash m_hash;
    size_type m_deltaPhi;
    size_type m_layerMin;
    size_type m_strLayerMin;
    size_type m_nStrawLayers;
    size_type m_nstraws;
  };
 
  typedef std::pair<unsigned int, unsigned int> intPair;
  typedef std::map<IdentifierHash, HashCalc> hashCalcMap;
  std::vector<HashCalc>       m_hash_calcs;
  std::vector<intPair>        m_hash_calcs_barrel_indexes;
  std::vector<intPair>        m_hash_calcs_endcap_indexes;
 
  IdDictFieldImplementation m_indet_impl;
  IdDictFieldImplementation m_trt_impl;
  IdDictFieldImplementation m_bec_impl;
  IdDictFieldImplementation m_phi_mod_impl;
  IdDictFieldImplementation m_lay_wheel_impl;
  IdDictFieldImplementation m_str_lay_impl;
  IdDictFieldImplementation m_straw_impl;
};
 
 
 
//using the macros below we can assign an identifier (and a version)
//This is required and checked at compile time when you try to record/retrieve
CLASS_DEF(TRT_ID, 2518, 1)
inline std::string
TRT_ID::errMsg(const std::string & txt, unsigned v, size_t lim) const {
  return txt + std::to_string(v) + " " + std::to_string(lim);
  
}
 
//----------------------------------------------------------------------------
inline bool
TRT_ID::is_valid() const {
  return(m_is_valid);
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::barrel_ec_id(int barrel_ec, bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result((Identifier::value_type) 0);
 
  // Pack fields independently
  m_indet_impl.pack(indet_field_value(), result);
  m_trt_impl.pack(trt_field_value(), result);
  m_bec_impl.pack(barrel_ec, result);
 
  if (checks) {
    barrel_ec_id_checks(barrel_ec);
  }
 
  return result;
}
 
inline Identifier
TRT_ID::barrel_ec_id(int barrel_ec) const {
  return barrel_ec_id(barrel_ec, do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::module_id(int barrel_ec,
                  int phi_module,
                  int layer_or_wheel,
                  bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result((Identifier::value_type) 0);
 
  // Pack fields independently
  m_indet_impl.pack(indet_field_value(), result);
  m_trt_impl.pack(trt_field_value(), result);
  m_bec_impl.pack(barrel_ec, result);
  m_phi_mod_impl.pack(phi_module, result);
  m_lay_wheel_impl.pack(layer_or_wheel, result);
 
  if (checks) {
    module_id_checks(barrel_ec, phi_module, layer_or_wheel);
  }
 
  return result;
}
 
inline Identifier
TRT_ID::module_id(int barrel_ec,
                  int phi_module,
                  int layer_or_wheel) const {
  return module_id(barrel_ec, phi_module, layer_or_wheel, do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::module_id(IdentifierHash module_hash) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_module_vec[module_hash]);
}
 
//----------------------------------------------------------------------------
inline Identifier TRT_ID::layer_id(IdentifierHash layer_hash) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_straw_layer_vec[layer_hash]);
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::layer_id(int barrel_ec,
                 int phi_module,
                 int layer_or_wheel,
                 int straw_layer,
                 bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result((Identifier::value_type) 0);
 
  // Pack fields independently
  m_indet_impl.pack(indet_field_value(), result);
  m_trt_impl.pack(trt_field_value(), result);
  m_bec_impl.pack(barrel_ec, result);
  m_phi_mod_impl.pack(phi_module, result);
  m_lay_wheel_impl.pack(layer_or_wheel, result);
  m_str_lay_impl.pack(straw_layer, result);
 
  if (checks) {
    layer_id_checks(barrel_ec, phi_module, layer_or_wheel, straw_layer);
  }
 
  return result;
}
 
inline Identifier
TRT_ID::layer_id(int barrel_ec,
                 int phi_module,
                 int layer_or_wheel,
                 int straw_layer) const {
  return layer_id(barrel_ec, phi_module, layer_or_wheel, straw_layer,
                  do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::layer_id(const Identifier& module_id,
                 int straw_layer,
                 bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result(module_id);
 
  // Reset field and then pack it
  m_str_lay_impl.reset(result);
  m_str_lay_impl.pack(straw_layer, result);
 
  if (checks) {
    layer_id_checks(barrel_ec(module_id),
                    phi_module(module_id),
                    layer_or_wheel(module_id),
                    straw_layer);
  }
  return result;
}
 
inline Identifier
TRT_ID::layer_id(const Identifier& module_id,
                 int straw_layer) const {
  return layer_id(module_id, straw_layer, do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::layer_id(const Identifier& straw_id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  Identifier result(straw_id);
  //  Reset the straw field
  m_straw_impl.reset(result);
  return(result);
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::straw_id(int barrel_ec,
                 int phi_module,
                 int layer_or_wheel,
                 int straw_layer,
                 int straw,
                 bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result((Identifier::value_type) 0);
 
  // Pack fields independently
  m_indet_impl.pack(indet_field_value(), result);
  m_trt_impl.pack(trt_field_value(), result);
  m_bec_impl.pack(barrel_ec, result);
  m_phi_mod_impl.pack(phi_module, result);
  m_lay_wheel_impl.pack(layer_or_wheel, result);
  m_str_lay_impl.pack(straw_layer, result);
  m_straw_impl.pack(straw, result);
 
  if (checks) {
    straw_id_checks(barrel_ec, phi_module, layer_or_wheel, straw_layer, straw);
  }
 
  return result;
}
 
inline Identifier
TRT_ID::straw_id(int barrel_ec,
                 int phi_module,
                 int layer_or_wheel,
                 int straw_layer,
                 int straw) const {
  return straw_id(barrel_ec, phi_module, layer_or_wheel, straw_layer, straw,
                  do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::straw_id(const Identifier& module_id,
                 int straw_layer,
                 int straw,
                 bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result(module_id);
 
  // Reset fields and then pack them
  m_str_lay_impl.reset(result);
  m_straw_impl.reset(result);
  m_str_lay_impl.pack(straw_layer, result);
  m_straw_impl.pack(straw, result);
 
  if (checks) {
    straw_id_checks(barrel_ec(module_id),
                    phi_module(module_id),
                    layer_or_wheel(module_id),
                    straw_layer,
                    straw);
  }
  return result;
}
 
inline Identifier
TRT_ID::straw_id(const Identifier& module_id,
                 int straw_layer,
                 int straw) const {
  return straw_id(module_id, straw_layer, straw, do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::straw_id(const Identifier& layer_id,
                 int straw,
                 bool checks) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Build identifier
  Identifier result(layer_id);
 
  // Reset field and then pack it
  m_straw_impl.reset(result);
  m_straw_impl.pack(straw, result);
 
  if (checks) {
    straw_id_checks(barrel_ec(layer_id),
                    phi_module(layer_id),
                    layer_or_wheel(layer_id),
                    straw_layer(layer_id),
                    straw);
  }
  return result;
}
 
inline Identifier
TRT_ID::straw_id(const Identifier& layer_id,
                 int straw) const {
  return straw_id(layer_id, straw, do_checks());
}
 
//----------------------------------------------------------------------------
inline Identifier
TRT_ID::straw_id(IdentifierHash straw_hash) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
 
  // Access id from vector ONLY if the vector has been initialized
  //  (done via       init_straw_hash_vector();
  //   and reset by   reset_straw_hash_vector();
  if (straw_hash < m_straw_vec.size()) {
    return(m_straw_vec[straw_hash]);
  }
  // Else return invalid id
  Identifier result;
  return(result); // return hash in invalid state
}
 
//----------------------------------------------------------------------------
inline IdentifierHash TRT_ID::module_hash(Identifier module_id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  hash_vec_it it = std::lower_bound(m_module_vec.begin(),
                                    m_module_vec.end(),
                                    module_id);
  // Require that module_id matches the one in vector
  if (it != m_module_vec.end() && module_id == (*it)) {
    return(it - m_module_vec.begin());
  }
  IdentifierHash result;
  return(result); // return hash in invalid state
}
 
//----------------------------------------------------------------------------
inline
IdentifierHash
TRT_ID::straw_layer_hash(Identifier straw_layer_id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  hash_vec_it it = std::lower_bound(m_straw_layer_vec.begin(),
                                    m_straw_layer_vec.end(),
                                    straw_layer_id);
  // Require that straw_layer_id matches the one in vector
  if (it != m_straw_layer_vec.end() && straw_layer_id == (*it)) {
    return(it - m_straw_layer_vec.begin());
  }
  IdentifierHash result;
  return(result); // return hash in invalid state
}
 
//----------------------------------------------------------------------------
inline
IdentifierHash
TRT_ID::straw_hash(Identifier straw_id) const{
  
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  // Get index into hashCalc vector
  unsigned int hcIndex = 0;
  int be = barrel_ec(straw_id);
  int lw = layer_or_wheel(straw_id);
  int sl = straw_layer(straw_id);
 
  if (is_barrel(straw_id)) { //barrel
    unsigned int index = lw * 32 + sl;
    if (index >= m_hash_calcs_barrel_indexes.size()) [[unlikely]]{
      throw std::out_of_range(errMsg("straw_hash: index > barrel_index size - ", index, m_hash_calcs_barrel_indexes.size()));
    }
    hcIndex = (be < 0) ? m_hash_calcs_barrel_indexes[index].first : m_hash_calcs_barrel_indexes[index].second;
  } else { //endcap
    unsigned int index = lw;
    if (index >= m_hash_calcs_endcap_indexes.size()) [[unlikely]] {
      throw std::out_of_range(errMsg("straw_hash: index > endcap_index size - ", index, m_hash_calcs_endcap_indexes.size()));
    }
    hcIndex = (be < 0) ? m_hash_calcs_endcap_indexes[index].first : m_hash_calcs_endcap_indexes[index].second;
  }
  //
  if (hcIndex>= m_hash_calcs.size())[[unlikely]]{
    throw std::out_of_range(errMsg("straw_hash: hc index > hcCalc  size - ", hcIndex, m_hash_calcs.size()));
  }
  //last resort
  IdentifierHash result;
  const HashCalc& hc = m_hash_calcs[hcIndex];
  result = hc.m_hash +
             phi_module(straw_id) * hc.m_deltaPhi +
             (lw - hc.m_layerMin) * hc.m_nStrawLayers +
             (sl - hc.m_strLayerMin) * hc.m_nstraws +
             straw(straw_id);
  return(result);
}
 
//----------------------------------------------------------------------------
inline
IdentifierHash
TRT_ID::straw_hash_bin(Identifier straw_id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  hash_vec_it it = std::lower_bound(m_straw_vec.begin(),
                                    m_straw_vec.end(),
                                    straw_id);
 
 
 
  if (it != m_straw_vec.end()) {
    return(it - m_straw_vec.begin());
  }
  IdentifierHash result;
  return(result); // return hash in invalid state
}
 
//----------------------------------------------------------------------------
inline
void
TRT_ID::invalidMessage() const {
 
  ATH_MSG_ERROR(" TRT_ID is NOT valid for this layout. ");
  ATH_MSG_ERROR(" Please use 'trt_id->is_valid()' if a layout test is needed. ");
}
 
//----------------------------------------------------------------------------
inline bool
TRT_ID::is_barrel(const Identifier& id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_barrel_field.match(m_bec_impl.unpack(id)));
}
 
//----------------------------------------------------------------------------
inline int
TRT_ID::barrel_ec(const Identifier& id)  const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_bec_impl.unpack(id));
}
 
//----------------------------------------------------------------------------
inline int
TRT_ID::phi_module(const Identifier& id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_phi_mod_impl.unpack(id));
}
 
//----------------------------------------------------------------------------
inline int
TRT_ID::layer_or_wheel(const Identifier& id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_lay_wheel_impl.unpack(id));
}
 
//----------------------------------------------------------------------------
inline int
TRT_ID::straw_layer(const Identifier& id) const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_str_lay_impl.unpack(id));
}
 
//----------------------------------------------------------------------------
inline int
TRT_ID::straw(const Identifier& id)  const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_straw_impl.unpack(id));
}
 
//----------------------------------------------------------------------------
inline TRT_ID::size_type
TRT_ID::module_hash_max() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return m_module_hash_max;
}
 
//----------------------------------------------------------------------------
inline TRT_ID::size_type
TRT_ID::straw_layer_hash_max() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return m_straw_layer_hash_max;
}
 
//----------------------------------------------------------------------------
inline TRT_ID::size_type
TRT_ID::straw_hash_max() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return m_straw_hash_max;
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_id_iterator TRT_ID::module_begin() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_module_vec.begin());
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_id_iterator TRT_ID::module_end() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_module_vec.end());
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_id_iterator TRT_ID::straw_layer_begin() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_straw_layer_vec.begin());
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_id_iterator TRT_ID::straw_layer_end() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_straw_layer_vec.end());
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_expanded_id_iterator TRT_ID::straw_begin() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_full_straw_range.factory_begin());
}
 
//----------------------------------------------------------------------------
inline TRT_ID::const_expanded_id_iterator TRT_ID::straw_end() const {
  // Check if TRT_ID is valid for this layout
  if (!m_is_valid) invalidMessage();
 
  return(m_full_straw_range.factory_end());
}
 
#endif // INDETIDENTIFIER_TRT_ID_H