CaloDetDescriptor.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef CALODETDESCR_CALODETDESCRIPTOR_H
#define CALODETDESCR_CALODETDESCRIPTOR_H
 
#include "CaloIdentifier/CaloCell_ID.h"
#include "Identifier/Identifiable.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
class Identifier;
class AtlasDetectorID;

class CaloDetDescriptor : public Identifiable
{
 public:
  CaloDetDescriptor(const Identifier& id, 
            const AtlasDetectorID* helper,
            const CaloCell_Base_ID* calo_helper,
            CaloCell_ID::CaloSample sample=CaloCell_ID::Unknown, 
            int layer=CaloCell_ID::NOT_VALID);

  virtual ~CaloDetDescriptor();

  virtual void print() const;

  void dump(std::ostream& os) const;

  void set_n_calo_depth(int n_calo_depth);

  void set_depth_in(std::vector<double>& calo_depth);

  void set_depth_out(std::vector<double>& calo_depth);

  bool is_lar_em() const;                    
  bool is_lar_em_barrel() const;             
  bool is_lar_em_endcap() const;             
  bool is_lar_em_endcap_inner() const;       
  bool is_lar_em_endcap_outer() const;       
  bool is_lar_hec() const;                   
  bool is_lar_fcal() const;                  
  bool is_tile() const;                      
  
  CaloCell_ID::CaloSample getSampling(IdentifierHash onecalo_hash) const;

  CaloCell_ID::CaloSample getSampling() const
    { return m_calo_sampl ; 
    }

  CaloCell_ID::SUBCALO getSubCalo() const;

  Identifier identify() const override final;
  IdentifierHash identifyHash() const  override final;
  IdentifierHash calo_hash() const;
  IdentifierHash subcalo_hash() const;       

  const CaloCell_Base_ID* get_calo_helper() const;   
  
  int layer() const;                         
  
  IdentifierHash caloCellMin() const;
 

  int    calo_sign() const;                  

  double calo_z_min() const;                 
  double calo_z_max() const;
  double calo_eta_min() const;               
  double calo_eta_max() const;
  double calo_phi_min() const;               
  double calo_phi_max() const;               
  double calo_r_min() const;                 
  double calo_r_max() const;                 

  int  n_calo_depth() const;
  void get_depth_in(std::vector<double>& calo_depth) const;
  void get_depth_out(std::vector<double>& calo_depth) const;

  double  deta() const;                   
  double  dphi() const;                   
  int     n_eta() const;                   
  int     n_phi() const;                  
 
  // ------- Return parameters needed for Trk::Surface --------

  bool get_cylinder_surface (Amg::Transform3D& htrans,
                 double& radius, 
                 double& hphi, 
                 double& hlength, 
                 double& depth) const;

  bool get_disk_surface (Amg::Transform3D& htrans,
             double& z,
             double& rmin, 
             double& rmax, 
             double& hphisec, 
             double& depth) const; 

  bool is_in (double eta_min,                        
          double eta_max,
          double phi_min, 
          double phi_max) const;

  int eta_channel(double eta) const;
  int phi_channel(double phi) const;

  int eta_channel_raw(double eta) const;
  int phi_channel_raw(double phi) const;
 

  double reg_min() const;
  double reg_max() const;
  double lar_eta_min() const;
  double lar_phi_min() const;

  void setCaloEtaMin(double eta_min);
  void setCaloEtaMax(double eta_max);
  void setCaloPhiMin(double phi_min);
  void setCaloPhiMax(double phi_max);
  void setCaloZMin(double z_min);
  void setCaloZMax(double z_max);
  void setCaloRMin(double r_min);
  void setCaloRMax(double r_max);

  void setLArRegMin(double reg_min);
  void setLArRegMax(double reg_max);
  void setLArPhiMin(double phi_min);
  void setLArEtaMin(double eta_min);

  void set_eta_phi_granularity(int neta, 
                   double deta,
                   int nphi, 
                   double dphi);

  const Amg::Transform3D& transform() const;

  void set_transform (const Amg::Transform3D& transform);
 
 private:
  const AtlasDetectorID* m_helper;
  const CaloCell_Base_ID* m_calo_helper;
  Identifier m_id;

  bool m_is_lar_em; 
  bool m_is_lar_em_barrel; 
  bool m_is_lar_em_endcap; 
  bool m_is_lar_em_endcap_inner; 
  bool m_is_lar_em_endcap_outer; 
  bool m_is_lar_hec;
  bool m_is_lar_fcal; 
 bool m_is_tile; 

  int m_calo_sign;
  int m_layer;
  
  CaloCell_ID::CaloSample m_calo_sampl;

  CaloCell_ID::SUBCALO m_calo_num;

  IdentifierHash m_calocell_min;

  double m_lar_deta;
  double m_lar_dphi;
  int    m_lar_n_eta;
  int    m_lar_n_phi;
 
 protected: 
  // values to be defined in the derived classes
 
  // 'ideal' geometry
  double m_calo_eta_min;
  double m_calo_eta_max;
  double m_calo_phi_min;
  double m_calo_phi_max;
  double m_calo_r_min;
  double m_calo_r_max;
  double m_calo_z_min;
  double m_calo_z_max;

  int m_n_calo_depth;
  std::vector <double> m_calo_depth_in;
  std::vector <double> m_calo_depth_out;

  Amg::Transform3D m_transform;

  double m_lar_reg_min;
  double m_lar_reg_max;
  double m_lar_phi_min;
  double m_lar_eta_min;
  int m_etachan_min;
};
 
inline bool CaloDetDescriptor::is_lar_em() const
{   
  return m_is_lar_em; 
}
 
inline bool CaloDetDescriptor::is_lar_em_barrel() const
{   
  return m_is_lar_em_barrel; 
}
 
inline bool CaloDetDescriptor::is_lar_em_endcap() const
{   
  return m_is_lar_em_endcap; 
}
 
inline bool CaloDetDescriptor::is_lar_em_endcap_inner() const
{   
  return m_is_lar_em_endcap_inner; 
}
 
inline bool CaloDetDescriptor::is_lar_em_endcap_outer() const
{   
  return m_is_lar_em_endcap_outer; 
}
 
inline bool CaloDetDescriptor::is_lar_hec() const
{   
  return m_is_lar_hec; 
}
 
inline bool CaloDetDescriptor::is_lar_fcal() const
{   
  return m_is_lar_fcal; 
}
 
inline bool CaloDetDescriptor::is_tile() const
{   
  return m_is_tile; 
}
 
inline Identifier CaloDetDescriptor::identify() const 
{ 
  return m_id; 
}
 
inline IdentifierHash CaloDetDescriptor::identifyHash() const
{ 
  int num;
  return m_calo_helper->subcalo_region_hash(m_id, num);
}
 
inline IdentifierHash CaloDetDescriptor::calo_hash() const
{ 
  return m_calo_helper->calo_region_hash(m_id); 
}
 
inline IdentifierHash CaloDetDescriptor::subcalo_hash() const
{ 
  int num;
  return m_calo_helper->subcalo_region_hash(m_id, num);
}
 
inline const CaloCell_Base_ID* CaloDetDescriptor::get_calo_helper() const  
{ 
  return m_calo_helper;
}
 
inline int CaloDetDescriptor::layer() const
{ 
  return m_layer; 
}
 
inline CaloCell_Base_ID::SUBCALO CaloDetDescriptor::getSubCalo()  const
{
  return m_calo_num;
}
 
inline IdentifierHash CaloDetDescriptor::caloCellMin() const
{
  return m_calocell_min;
}
 
inline int CaloDetDescriptor::calo_sign() const
{ 
  return m_calo_sign; 
}
 
inline double CaloDetDescriptor::calo_z_min() const
{ 
  return m_calo_z_min; 
}
 
inline double CaloDetDescriptor::calo_z_max() const
{ 
  return m_calo_z_max; 
}
 
inline double CaloDetDescriptor::calo_eta_min() const
{ 
  return m_calo_eta_min; 
}
 
inline double CaloDetDescriptor::calo_eta_max() const
{ 
  return m_calo_eta_max; 
}
 
inline double CaloDetDescriptor::calo_phi_min() const
{ 
  return m_calo_phi_min; 
}
 
inline double CaloDetDescriptor::calo_phi_max() const
{ 
  return m_calo_phi_max; 
}
 
inline double CaloDetDescriptor::calo_r_min() const
{ 
  return m_calo_r_min; 
}
 
inline double CaloDetDescriptor::calo_r_max() const
{ 
  return m_calo_r_max; 
}
 
inline double CaloDetDescriptor::deta() const
{ 
  return m_lar_deta;
}
 
inline double CaloDetDescriptor::dphi() const
{ 
  return m_lar_dphi;
}
 
inline int CaloDetDescriptor::n_eta() const
{ 
  return m_lar_n_eta;
}
 
inline int CaloDetDescriptor::n_phi() const
{ 
  return m_lar_n_phi;
}
 
inline double CaloDetDescriptor::reg_min() const
{  
  return m_lar_reg_min; 
}
 
inline double CaloDetDescriptor::reg_max() const
{  
  return m_lar_reg_max; 
}
 
inline double CaloDetDescriptor::lar_eta_min() const
{  
  return m_lar_eta_min; 
}
 
inline double CaloDetDescriptor::lar_phi_min() const
{  
  return m_lar_phi_min; 
}
 
inline void CaloDetDescriptor::setCaloEtaMin(double eta_min)
{
  m_calo_eta_min = eta_min;
}
 
inline void CaloDetDescriptor::setCaloEtaMax(double eta_max)
{
  m_calo_eta_max = eta_max;
}
 
inline void CaloDetDescriptor::setCaloPhiMin(double phi_min)
{
  m_calo_phi_min = phi_min;
}
 
inline void CaloDetDescriptor::setCaloPhiMax(double phi_max)
{
  m_calo_phi_max = phi_max;
}
 
inline void CaloDetDescriptor::setCaloZMin(double z_min)
{
  m_calo_z_min = z_min;
}
 
inline void CaloDetDescriptor::setCaloZMax(double z_max)
{
  m_calo_z_max = z_max;
}
 
inline void CaloDetDescriptor::setCaloRMin(double r_min)
{
  m_calo_r_min = r_min;
}
 
inline void CaloDetDescriptor::setCaloRMax(double r_max)
{
  m_calo_r_max = r_max;
}
 
inline void CaloDetDescriptor::setLArRegMin(double reg_min)
{
  m_lar_reg_min = reg_min;
}
 
inline void CaloDetDescriptor::setLArRegMax(double reg_max)
{
  m_lar_reg_max = reg_max;
}
 
inline void CaloDetDescriptor::setLArPhiMin(double phi_min)
{
  m_lar_phi_min = phi_min;
}
 
inline void CaloDetDescriptor::setLArEtaMin(double eta_min)
{
  m_lar_eta_min = eta_min;
}
 
inline
const Amg::Transform3D& CaloDetDescriptor::transform() const
{
  return m_transform;
}
 
 
inline
void CaloDetDescriptor::set_transform (const Amg::Transform3D& transform)
{
  m_transform = transform;
}
 
 
#endif