LArHEC_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_LARHEC_BASE_ID_H
#define CALOIDENTIFIER_LARHEC_BASE_ID_H
 
 
#include "CaloIdentifier/CaloIDHelper.h"
#include "CaloIdentifier/LArNeighbours.h"
#include "IdDict/IdDictFieldImplementation.h"
#include "Identifier/IdentifierHash.h"
#include "AthenaKernel/CLASS_DEF.h"
 
#include <vector>
#include <algorithm>
 
class Range;
class LArHEC_region;
 

class LArHEC_Base_ID : public CaloIDHelper
{
public:        

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

  Identifier  region_id (const ExpandedIdentifier& exp_id ) const ;

  Identifier  channel_id (const ExpandedIdentifier& exp_id ) const ;

  Identifier  region_id      (int pos_neg, int sampling, int region ) const ;
  Identifier  region_id      (int pos_neg, int sampling, int region, bool checks) const;

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

  Identifier  channel_id  ( int pos_neg, int sampling, int sector, int region, 
                int eta,     int phi_sector ) 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;

  bool        is_supercell    (const Identifier id)const;
                 
  IdentifierHash channel_hash (Identifier channelId) const;
  IdentifierHash channel_hash_binary_search (Identifier channelId) const;

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

  id_iterator hec_begin    () const;
  id_iterator hec_end      () const;
  id_range hec_range () const;

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

  int         pos_neg       (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;

  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::channel_id;
  using CaloIDHelper::region_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 = 64000};
 
  int phi_min_init(const Identifier regId) const;
 
  // Check methods
 
  void  region_id_checks    (int pos_neg, int sampling, int region ) const;
  void  channel_id_checks      (int pos_neg, 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         initLevelsFromDict (const std::string& group_name) ;
 
  int         init_hashes();
 
  static int   get_prevInPhi(const LArHEC_region* hecRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
              int& neighbourIndex, IdentifierHash* neighbList) ;
  
  static int   get_nextInPhi(const LArHEC_region* hecRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
              int& neighbourIndex, IdentifierHash* neighbList) ;
 
  int   get_prevInEta(const LArHEC_region* hecRegion, 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 LArHEC_region* hecRegion, 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 LArHEC_region* hecRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
               const double& absEta,
               int& neighbourIndex, IdentifierHash* neighbList) const;
 
  int   get_nextInSamp(const LArHEC_region* hecRegion, const unsigned int& index, const short int& nPhi, const unsigned int& minHash, 
               const double& absEta,
               int& neighbourIndex, IdentifierHash* neighbList) const;
 
 
  int         init_neighbors();
 
 
  unsigned                      m_slar;
 
  size_type                     m_hec_region_index;
  size_type                     m_LAR_INDEX;
  size_type                     m_HEC_INDEX;
  size_type                     m_POSNEG_INDEX;
  size_type                     m_SAMPLING_INDEX;
  size_type                     m_REGION_INDEX;
  size_type                     m_ETA_INDEX;
  size_type                     m_PHI_INDEX;
  size_type                     m_SLAR_INDEX;
 
  MultiRange                    m_full_channel_range;
  MultiRange                    m_full_region_range;
 
  bool                          m_two_sym_sides;
 
  std::vector<short 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_lar_impl;
  IdDictFieldImplementation    m_hec_impl;
  IdDictFieldImplementation    m_pn_impl;
  IdDictFieldImplementation    m_sampling_impl;
  IdDictFieldImplementation    m_region_impl;
  IdDictFieldImplementation    m_eta_impl;
  IdDictFieldImplementation    m_phi_impl;
  IdDictFieldImplementation    m_slar_impl;
 
  IdDictFieldImplementation    m_pn_reg_impl;
 
  std::vector<LArHEC_region*>   m_vecOfRegions;
  std::vector<short int>        m_vecOfCellInfo;
};
 
 
#include "CaloIdentifier/LArHEC_Base_ID.icc"
 
#endif // LARHEC_BASE_ID_H