CaloCell_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_CALOCELL_BASE_ID_H
#define CALOIDENTIFIER_CALOCELL_BASE_ID_H
 
 
#include "AthenaKernel/CLASS_DEF.h"
#include "AtlasDetDescr/AtlasDetectorID.h"
#include "CaloIdentifier/CaloID.h"
#include "CaloIdentifier/LArNeighbours.h"
#include "CaloGeoHelpers/CaloSampling.h"
#include <ranges>
#include <array>
 
 
class CaloNeighbours;
 
  
class CaloCell_Base_ID : public AtlasDetectorID, public CaloSampling
{
public:
  typedef Identifier::size_type  size_type ;

  enum SUBCALO { LAREM = 0, LARHEC = 1, LARFCAL = 2, TILE = 3, LARMINIFCAL = 4, NSUBCALO = 5, NOT_VALID=CaloIDHelper::NOT_VALID /*999999*/ };

  //typedef CaloSampling::CaloSample CaloSample;
  // enum CaloSample {
  //   PreSamplerB=0, EMB1, EMB2, EMB3,              // LAr barrel
  //   PreSamplerE, EME1, EME2, EME3,                // LAr EM endcap
  //   HEC0, HEC1, HEC2, HEC3,                       // Hadronic end cap cal.
  //   TileBar0, TileBar1, TileBar2,                 // Tile barrel
  //   TileGap1, TileGap2, TileGap3,                 // Tile gap (ITC & scint)
  //   TileExt0, TileExt1, TileExt2,                 // Tile extended barrel
  //   FCAL0, FCAL1, FCAL2,                          // Forward EM endcap
  //   MINIFCAL0, MINIFCAL1, MINIFCAL2, MINIFCAL3,   // MiniFCAL 
  //   Unknown
  // };
 

  CaloCell_Base_ID(const std::string& name,
                   const LArEM_Base_ID*    em_id,
                   const LArHEC_Base_ID*   hec_id,
                   const LArFCAL_Base_ID*  fcal_id, 
                   const LArMiniFCAL_ID*   minifcal_id,
                   const Tile_Base_ID*     tile_id,
           bool supercell);
 
  ~CaloCell_Base_ID();
 
 
  int GetSubCaloName( const std::string& SubCaloName ) const;

  virtual int         initialize_from_dictionary(const IdDictMgr& dict_mgr) override;

  Identifier  region_id      (const int subCalo, 
                 const int barec_or_posneg, 
                                 const int sampling_or_fcalmodule, 
                                 const int region_or_dummy ) const;
  Identifier  region_id      (const int subCalo, 
                 const int barec_or_posneg, 
                                 const int sampling_or_fcalmodule, 
                                 const int region_or_dummy,
                                 bool checks) const;

  Identifier  cell_id      (const int subCalo, 
                 const int barec_or_posneg, 
                                 const int sampling_or_fcalmodule,
                                 const int region_or_dummy,
                 const int eta,    
                                 const int phi ) const;
  Identifier  cell_id      (const int subCalo, 
                 const int barec_or_posneg, 
                                 const int sampling_or_fcalmodule,
                                 const int region_or_dummy,
                 const int eta,    
                                 const int phi,
                                 bool checks) const;
                      
  Identifier  region_id  (const Identifier cellId ) const;

  Identifier  cell_id( const Identifier regionId,
               const int eta, const int phi,
                       int depth = 0) const ;
  Identifier  cell_id( const Identifier regionId,
               const int eta, const int phi,
                       int depth,
                       bool checks) const ;
                 
  Identifier region_id   (const IdentifierHash caloRegionHash) const;
  Identifier region_id   (const int subCalo, const IdentifierHash subCaloRegionHash) const; 

  Identifier cell_id   (const IdentifierHash caloCellHash) const;
  Identifier cell_id   (const int subCalo, const IdentifierHash subCaloCellHash) const;

  IdentifierHash calo_region_hash  (const Identifier regionId) const;
  IdentifierHash subcalo_region_hash  (const Identifier regionId, int& subCalo) const;  // subCalo is an output argument

  IdentifierHash calo_cell_hash (const Identifier cellId) const; 
  IdentifierHash subcalo_cell_hash (const Identifier cellId, int& subCalo) const;  // subCalo is an output argument

  size_type     calo_cell_hash_max () const;
  size_type     calo_region_hash_max () const;

  void calo_cell_hash_range (const Identifier id, IdentifierHash& caloCellMin, IdentifierHash& caloCellMax) const;
  void calo_cell_hash_range (const int subCalo,   IdentifierHash& caloCellMin, IdentifierHash& caloCellMax) const;
  void calo_reg_hash_range (const Identifier id, IdentifierHash& caloCellMin, IdentifierHash& caloCellMax) const;
  void calo_reg_hash_range (const int subCalo,   IdentifierHash& caloCellMin, IdentifierHash& caloCellMax) const;

  IdentifierHash subcalo_cell_hash (const IdentifierHash caloHash, int& subCalo) const;
  IdentifierHash subcalo_region_hash (const IdentifierHash caloHash, int& subCalo) const;

  IdentifierHash calo_cell_hash (const int subCalo, const IdentifierHash subCaloHash) const;
  IdentifierHash calo_region_hash (const int subCalo, const IdentifierHash subCaloHash) const;

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

  id_iterator cell_begin    () const;
  id_iterator cell_end      () const;
  id_range cell_range      () const;

  id_iterator cell_begin    (const int subCalo) const;
  id_iterator cell_end      (const int subCalo) const;
  id_range cell_range      (const int subCalo) const;

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

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

  bool  is_em      (const Identifier id) const;
  bool  is_em      (const IdentifierHash caloHash) 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;
  
  bool  is_hec    (const Identifier id) const;
  bool  is_hec    (const IdentifierHash caloHash) const;
  
  bool  is_fcal      (const Identifier id) const;
  bool  is_fcal      (const IdentifierHash caloHash) const;
  
  bool  is_minifcal      (const Identifier id) const;
  bool  is_minifcal      (const IdentifierHash caloHash) const;
  
  bool  is_tile      (const Identifier id) const;
  bool  is_tile      (const IdentifierHash caloHash) const;
  bool  is_tile      (const ExpandedIdentifier& id) const;

  bool  is_tile_barrel                  (const Identifier id) const;
  bool  is_tile_extbarrel               (const Identifier id) const;
  bool  is_tile_gap                     (const Identifier id) const;
  bool  is_tile_gapscin                 (const Identifier id) const;
  bool  is_tile_negative                (const Identifier id) const;
  bool  is_tile_positive                (const Identifier id) const;

  int         sub_calo    (const Identifier         id)const;
  int         sub_calo    (const IdentifierHash caloHash)const;

  int         calo_sample    (const Identifier         id)const;
  int         calo_sample    (const IdentifierHash caloHash)const;
                 
  
  /* field values (proposal)*/
  /*
  int         first_field     (const Identifier id)const;  // corresponds to 'barrel_ec' for LArEM, 'pos_neg' for LArHEC and LArFCAL, 'section' for Tile
  int         second_field    (const Identifier id)const;  // corresponds to 'sampling' for LArEM and LArHEC, 'module' for LArFCAL, 'side' for Tile
  int         third_field     (const Identifier id)const;  // corresponds to 'region' for LArEM and LArHEC, nothing for LArFCAL, 'module' for Tile
  int         fourth_field    (const Identifier id)const;  // corresponds to 'eta' for LAr, 'tower' for Tile
  int         fifth_field     (const Identifier id)const;  // corresponds to 'phi' for LAr, 'sample' for Tile
  */

  int         pos_neg         (const Identifier id)const;        // corresponds to 'barrel_ec' for LArEM
  int         sampling        (const Identifier id)const;        // corresponds 'module' for FCAL/MiniFCAL
  int         region          (const Identifier id)const;        // no region for FCAL, is 'depth' for MiniFCAL
  int         eta             (const Identifier id)const;       
  int         phi             (const Identifier id)const;       
  int         section         (const Identifier id)const;       
  int         side            (const Identifier id)const;
  int         module          (const Identifier id)const;      
  int         tower           (const Identifier id)const;       
  int         sample          (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;    // LAr only
  int phi_max(const Identifier regId) const;

  float etaGranularity(const Identifier regId) const;
  float phiGranularity(const Identifier regId) const;
  float eta0(const Identifier regId) const;
  float phi0(const Identifier regId) const;

    const LArEM_Base_ID*        em_idHelper() const 
    {     return m_emHelper;
      }

    const LArHEC_Base_ID*       hec_idHelper() const
      {     return m_hecHelper;
      }

    const LArFCAL_Base_ID*      fcal_idHelper() const
      {     return m_fcalHelper;
      }

    const LArMiniFCAL_ID*      minifcal_idHelper() const
      {     return m_minifcalHelper;
      }

    const Tile_Base_ID*        tile_idHelper() const 
      {     return m_tileHelper;
      }
      
 
  int    get_neighbours(const IdentifierHash caloHash,
                        const LArNeighbours::neighbourOption& option,
                        std::vector<IdentifierHash>& neighbourList) const;

  std::string cell_name(const Identifier id) const;
 
  std::string show_to_string(const Identifier id,
                             const IdContext *context = 0,
                             char sep = '.') const;
 
 
private:
  SUBCALO get_subcalo (Identifier id) const;
 
  const LArEM_Base_ID*        m_emHelper;
  const LArHEC_Base_ID*       m_hecHelper;
  const LArFCAL_Base_ID*      m_fcalHelper;
  const LArMiniFCAL_ID*       m_minifcalHelper;
  const Tile_Base_ID*         m_tileHelper;
  std::array<const CaloIDHelper*, NSUBCALO> m_helpers;
 
  size_type                       m_cell_hash_max;
  size_type                       m_region_hash_max;
  std::array<size_type, NSUBCALO> m_cell_min;
  std::array<size_type, NSUBCALO> m_cell_max;
  std::array<size_type, NSUBCALO> m_reg_min;
  std::array<size_type, NSUBCALO> m_reg_max;
  std::vector<Identifier>         m_cell_vec;
  std::vector<Identifier>         m_region_vec;
 
private:
  // Avoid coverity warnings.
  CaloCell_Base_ID (const CaloCell_Base_ID&);
  CaloCell_Base_ID& operator= (const CaloCell_Base_ID&);
 
  CaloNeighbours*               m_caloNeighbours;
 
  unsigned                      m_supercell;
};
 
 
 
#include "CaloIdentifier/CaloCell_Base_ID.icc"
 
 
CLASS_DEF( CaloCell_Base_ID , 257140327 , 1 )
 
 
#endif // not CALOIDENTIFIER_CALOCELL_BASE_ID_H