EFexEMClusterTool.h

Go to the documentation of this file.

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

 
#ifndef LVL1__EFEXEMCLUSTERTOOL
#define LVL1__EFEXEMCLUSTERTOOL
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "CaloEvent/CaloConstCellContainer.h"
#include "xAODTrigL1Calo/TriggerTowerContainer.h"
#include "CaloIdentifier/CaloCell_SuperCell_ID.h"
#include "TileEvent/TileCellContainer.h"
 
 
#include <string>
#include <vector>
 
 
namespace LVL1
{
   class EFexEMClusterTool : public AthAlgTool
   {
   public:
 
      struct AlgResult {
         float eta{0}; // cluster eta
         float phi{0}; // cluster phi
         float clusterET{0}; // cluster transverse energy
         float rEta{0}; // R_eta
         float rHad{0}; // R_had
         float l1Width{0}; // Wstot
         float hadET{0}; // hadronic ET
         float l2ClusterET33{0}; // cluster ET (3x3)
         float l2ClusterET37{0}; // cluster ET (3x7)
         float rEtaL12{0}; // R_eta (layers 1+2)
         bool passClusterEnergy{false}; // passes energy cut of baseline selection
         bool passRHad{false}; // passes R_had cut of baseline selection
         bool passREta{false}; // passes R_eta cut of baseline selection
         bool passWstot{false}; // passes Wstot cut of baseline selection
      };
 
      EFexEMClusterTool(const std::string& type, const std::string& name, const IInterface* parent);

      std::vector<AlgResult> clusterAlg( bool applyBaselineCuts,
                                         const CaloConstCellContainer* scells, const xAOD::TriggerTowerContainer* TTs,
                                         const CaloCell_SuperCell_ID* idHelper, const TileID* m_tileIDHelper,
                                         const CaloConstCellContainer* tileCellCon ) const;
 
   private:
      std::vector<AlgResult> looseAlg( const CaloConstCellContainer* SCs, const xAOD::TriggerTowerContainer* TTs, 
                                       const CaloCell_SuperCell_ID* idHelper, const TileID* m_tileIDHelper,
                                       const CaloConstCellContainer* tileCellCon) const;
 
 
      /* calculate the ET of an input cell */
      float CaloCellET(const CaloCell* const &inputCell, float digitScale, float digitThreshold) const;

      bool localMax( const CaloConstCellContainer* &inputContainer, const CaloCell* inputCell, 
                     const CaloCell_SuperCell_ID* &idHelper, float digitScale, float digitThreshold) const;

      bool localMax( const CaloConstCellContainer* &inputContainer, const CaloCell* inputCell,
                     int numOthers, const CaloCell_SuperCell_ID* &idHelper, float digitScale, float digitThreshold) const;

      bool SameTT( const CaloCell* inputCell1, const CaloCell* inputCell2, const CaloCell_SuperCell_ID* &idHelper) const;

      double EMClusET( const CaloCell* centreCell, int etaWidth, int phiWidth,
                       const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale, float digitThresh) const;

      double REta( const CaloCell* centreCell, int etaWidth1, int phiWidth1, int etaWidth2, int phiWidth2,
                   const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale, float digitThresh) const;

      double RHad( const CaloCell* centreCell, int etaWidth, int phiWidth,
                   const CaloConstCellContainer* scells, const xAOD::TriggerTowerContainer* &TTContainer,
                   const CaloCell_SuperCell_ID* idHelper, float digitScale , float digitThresh, float &HadronicET) const;

      double RHadTile( const CaloCell* centreCell, int etaWidth, int phiWidth,
                       const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale, float digitThresh,
                       const TileID* m_tileIDHelper, const CaloConstCellContainer* tileCellCon, float tileNoiseThresh, float &HadronicET) const;

      double L2clusET( const CaloCell* centreCell, int etaWidth, int phiWidth,
                       const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale , float digitThresh) const;

      double REtaL12( const CaloCell* centreCell, int etaWidth1, int phiWidth1, int etaWidth2, int phiWidth2, 
                      const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale, float digitThresh) const;

      double L1Width( const CaloCell* centreCell, int etaWidth, int phiWidth,
                      const CaloConstCellContainer* scells, const CaloCell_SuperCell_ID* idHelper, float digitScale , float digitThresh) const;

      double TT_phi(const xAOD::TriggerTower* &inputTower) const;

      double dR(double eta1, double phi1, double eta2, double phi2) const;

      const xAOD::TriggerTower* matchingHCAL_TT( const CaloCell* &inputCell, const xAOD::TriggerTowerContainer* &TTContainer) const;

      std::vector<const CaloCell*> TDR_Clus( const CaloCell* centreCell, int etaWidth, int phiWidth, const CaloConstCellContainer* scells,
                                             const CaloCell_SuperCell_ID* idHelper, float digitScale, float digitThresh) const;

      double sumVectorET( const std::vector<const CaloCell*> &inputVector, float digitScale = 0.,float digitThreshold = 0.) const;

      bool checkDig(float EM_ET, float digitScale,float digitThresh) const;

      std::vector<const CaloCell*> L2cluster( const CaloCell* centreCell, int etaWidth, int phiWidth, const CaloConstCellContainer* scells,
                                              const CaloCell_SuperCell_ID* idHelper, float digitScale , float digitThresh ) const;

      double TT_ET(const xAOD::TriggerTower* &inputTower) const;

      double HadronicET( const std::vector<const CaloCell*> & inputVector, const CaloConstCellContainer* scells,
                         const xAOD::TriggerTowerContainer* &TTContainer, const CaloCell_SuperCell_ID* idHelper,
                         float digitScale, float digitThresh) const;

      void fromLayer2toLayer1( const CaloConstCellContainer* &inputContainer, const CaloCell* inputCell,
                               std::vector<const CaloCell*> &outputVector, const CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* fromLayer2toPS(const CaloConstCellContainer* &inputContainer, const CaloCell* inputCell, 
                                     const CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* fromLayer2toLayer3(const CaloConstCellContainer* &inputContainer, const CaloCell* inputCell,
                                         const CaloCell_SuperCell_ID* &idHelper) const;

      void addOnce(const CaloCell* inputCell, std::vector<const CaloCell*> &outputVector) const;

      std::vector<double> EnergyPerTileLayer(const std::vector<const CaloCell*> & inputSCVector, const CaloConstCellContainer* CellCon,
                                             const TileID* tileIDHelper, bool isOW, float tileNoiseThresh) const;

      const CaloCell* matchingHCAL_LAr(const CaloCell* &inputCell, const CaloConstCellContainer* &SCContainer,
                                       const  CaloCell_SuperCell_ID* &idHelper) const;

      void checkTileCell(const TileCell* &inputCell, std::vector<const TileCell*> &tileCellVector, bool &isAlreadyThere) const;

      double tileCellEnergyCalib(float eIn, float etaIn, float tileNoiseThresh) const;

      int detRelPos(const float inEta) const;

      const CaloCell* returnCellFromCont(Identifier inputID, const CaloConstCellContainer* &cellContainer, const CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* NextEtaCell( const CaloCell* inputCell, bool upwards, const CaloConstCellContainer* &cellContainer, const  CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* NextEtaCell_Barrel (const CaloCell* inputCell, bool upwards, const CaloConstCellContainer* &cellContainer, const  CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* NextEtaCell_OW (const CaloCell* inputCell, bool upwards, const CaloConstCellContainer* &cellContainer, const  CaloCell_SuperCell_ID* &idHelper) const;

      const CaloCell* NextEtaCell_IW(const CaloCell* inputCell, bool upwards, const CaloConstCellContainer* &cellContainer, const  CaloCell_SuperCell_ID* &idHelper) const;

      int restrictPhiIndex(int input_index, bool is64) const;

      const CaloCell* NextPhiCell ( const CaloCell* inputCell, bool upwards, 
                                    const CaloConstCellContainer* &cellContainer, const  CaloCell_SuperCell_ID* &idHelper) const;
 
 
 
 

      bool m_useProvenance;   
      int m_qualBitMask;      
 
      // baseline selection properties
      float m_clustET_thresh;        
      float m_clustET_NoIso_thresh;  
      float m_REta_thresh;           
      float m_RHad_thresh;           
      float m_L1Width_thresh;        
      float m_eta_dropL1Width;       
 
      // loose selection properties
      bool m_use_REtaL12 = false;                
      bool m_use_tileCells;              
      float m_nominalDigitization;       
      float m_nominalNoise_thresh;       
      float m_tileNoise_tresh;           
      int m_phiWidth_TDRCluster;         
      int m_etaWidth_TDRCluster;         
      int m_etaWidth_wstotIsolation;     
      int m_phiWidth_wstotIsolation;     
      int m_etaEMWidth_RHadIsolation;    
      int m_phiEMWidth_RHadIsolation;    
      int m_etaWidth_REtaIsolation_den;  
      int m_phiWidth_REtaIsolation_den;  
      int m_etaWidth_REtaIsolation_num;  
      int m_phiWidth_REtaIsolation_num;  
      int m_etaHadWidth_RHadIsolation;   
      int m_phiHadWidth_RHadIsolation;   
      float m_clustET_looseAlg_thresh;   
 
   };
}
 
#endif