LArFCAL_Base_ID.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CALOIDENTIFIER_LARFCAL_BASE_ID_H
#define CALOIDENTIFIER_LARFCAL_BASE_ID_H
 
#include "CaloIdentifier/CaloIDHelper.h"
#include "AtlasDetDescr/AtlasDetectorID.h"
#include "Identifier/IdentifierHash.h"
#include "IdDict/IdDictFieldImplementation.h"
#include "CaloIdentifier/LArNeighbours.h"
#include "CaloIdentifier/LArID_Exception.h"
#include "AthenaKernel/CLASS_DEF.h"
#include <ranges>
 
class IdDictRegion;
 
class LArFCAL_Base_ID : public CaloIDHelper
{
public:
        
  typedef Identifier::size_type  size_type ;
 
  LArFCAL_Base_ID(const std::string& name,
                  const std::string& group,
                  bool supercell);

  Identifier  module_id (const ExpandedIdentifier& exp_id) const ;

  Identifier  channel_id (const ExpandedIdentifier& exp_id) const ;

  Identifier  module_id ( int pos_neg, int module ) const ;
  Identifier  module_id ( int pos_neg, int module, bool checks ) const ;

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

  Identifier  module_id (const Identifier id ) const;
     
  Identifier  channel_id( const Identifier moduleId,
              int eta, int phi) const ;
  Identifier  channel_id( const Identifier moduleId,
              int eta, int phi, bool checks) const ;
                 
  Identifier module_id  (IdentifierHash module_hash_id) const;

  IdentifierHash module_hash  (Identifier module_id) const;

  IdentifierHash channel_hash_binary_search (Identifier channelId) const;

  size_type     module_hash_max () const;

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

  id_iterator mod_begin    () const;
  id_iterator mod_end      () const;
  id_range mod_range () const;

  id_iterator fcal_begin    () const;
  id_iterator fcal_end      () const;
  id_range fcal_range () const;

  const std::vector<Identifier>& channel_ids() const;
 
                 
  int         pos_neg         (const Identifier id)const; 
  int         module          (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;

  IdContext    module_context   () const;
 
 

  int  get_neighbours(const IdentifierHash id,
                      const LArNeighbours::neighbourOption& option,
                      std::vector<IdentifierHash>& neighbourList) const;
 
 

  virtual int  initialize_base_from_dictionary (const IdDictMgr& dict_mgr,
                        const std::string& group_name);
 
 
  using CaloIDHelper::channel_id;
  using CaloIDHelper::channel_hash;
  // Inherited from CaloIDHelper:
  // 
  //Identifier channel_id (IdentifierHash hashId) const;
  //Identifier region_id (IdentifierHash hashId) const;
  //IdentifierHash channel_hash (Identifier channelId) 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  module_id_checks      ( int pos_neg, int module ) const;
  void  channel_id_checks     ( int pos_neg,  int module,
                int eta,      int phi ) const;
  void  channel_id_checks     ( const Identifier moduleId,
                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();
 
  int         init_neighbours_from_file(const std::string& filename, std::vector<std::set<IdentifierHash> > &vec);
 
  int         init_neighbours_2d(const std::string& filename)
    { 
      return init_neighbours_from_file(filename, m_neighbours_2d_vec);
    }
 
  int         init_neighbours_3d_next(const std::string& filename)
    { 
      return init_neighbours_from_file(filename, m_neighbours_3d_next_vec);
    }
 
  int         init_neighbours_3d_prev(const std::string& filename)
    { 
      return init_neighbours_from_file(filename, m_neighbours_3d_prev_vec);
    }
 
  int         init_neighbours(const IdDictMgr& dict_mgr) ;
 
 
private:
  unsigned                      m_slar{0};
 
  bool                          m_two_sym_sides{1};
 
  size_type                     m_fcal_region_index{0};
  size_type                     m_LAR_INDEX{999};
  size_type                     m_SLAR_INDEX{999};
  size_type                     m_FCAL_INDEX{999};
  size_type                     m_POSNEG_INDEX{999};
  size_type                     m_MODULE_INDEX{999};
  size_type                     m_ETA_INDEX{999};
  size_type                     m_PHI_INDEX{999};
 
  MultiRange                    m_full_channel_range;
  MultiRange                    m_full_module_range;
 
  std::vector<short int>        m_vecOfPhiMin;
 
  IdDictFieldImplementation     m_lar_impl;
  IdDictFieldImplementation     m_fcal_impl;
  IdDictFieldImplementation     m_pn_impl;
  IdDictFieldImplementation     m_module_impl;
  IdDictFieldImplementation     m_eta_impl;
  IdDictFieldImplementation     m_phi_impl;
  IdDictFieldImplementation     m_pn_mod_impl;
 
  IdDictFieldImplementation     m_slar_impl;
 
  LArFCAL_Base_ID (const LArFCAL_Base_ID&);
  LArFCAL_Base_ID& operator= (const LArFCAL_Base_ID&);
 
  std::vector<std::set<IdentifierHash> >  m_neighbours_2d_vec;
  std::vector<std::set<IdentifierHash> >  m_neighbours_3d_next_vec;
  std::vector<std::set<IdentifierHash> >  m_neighbours_3d_prev_vec;
};
CLASS_DEF( LArFCAL_Base_ID , 225948692 , 1 )
 
 
#include "CaloIdentifier/LArFCAL_Base_ID.icc"
 
 
#endif // not CALOIDENTIFIER_LARFCAL_BASE_ID_H