TrigEgammaFastCaloHypoTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include <algorithm>
#include <format>
#include "TrigCompositeUtils/HLTIdentifier.h"
#include "TrigCompositeUtils/Combinators.h"
#include "AthenaMonitoringKernel/Monitored.h"
#include "GaudiKernel/SystemOfUnits.h"
#include "TrigEgammaFastCaloHypoTool.h"
 
 
using namespace TrigCompositeUtils;
 
 
TrigEgammaFastCaloHypoTool::TrigEgammaFastCaloHypoTool( const std::string& type, 
            const std::string& name, 
            const IInterface* parent ) 
  : base_class( type, name, parent ),
    m_decisionId( HLT::Identifier::fromToolName( name ) )
{ }
 
 
TrigEgammaFastCaloHypoTool::~TrigEgammaFastCaloHypoTool(){}
 
 
 
StatusCode TrigEgammaFastCaloHypoTool::initialize()  {
 
 
  ATH_MSG_DEBUG( "UseRinger      = " << m_useRinger);
  ATH_MSG_DEBUG( "AcceptAll      = " << std::format("{}", m_acceptAll.value()) );
  ATH_MSG_DEBUG( "EtaBins        = " << m_etabin      );
  ATH_MSG_DEBUG( "ETthr          = " << m_eTthr    << "( lo )/" << m_eT2thr    << "( hi )" );  
  ATH_MSG_DEBUG( "HADETthr       = " << m_hadeTthr << "( lo )/" << m_hadeT2thr << "( hi )" );
  ATH_MSG_DEBUG( "CARCOREthr     = " << m_carcorethr  );
  ATH_MSG_DEBUG( "CAERATIOthr    = " << m_caeratiothr );
  ATH_MSG_DEBUG( "dPHICLUSTERthr = " << m_dphicluster );
  ATH_MSG_DEBUG( "dETACLUSTERthr = " << m_detacluster );
  ATH_MSG_DEBUG( "WETA2thr       = " << m_WETA2thr    );
  ATH_MSG_DEBUG( "WSTOTthr       = " << m_WSTOTthr    );
  ATH_MSG_DEBUG( "F3thr          = " << m_F3thr       );
  
  if ( m_etabin.empty() ) {
    ATH_MSG_ERROR( "There are no cuts set (EtaBins property is an empty list)" );
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK( m_eTthr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_eT2thr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_hadeTthr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_hadeT2thr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_carcorethr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_caeratiothr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_WETA2thr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_WSTOTthr.size() == m_etabin.size()-1 );
  ATH_CHECK( m_F3thr.size() == m_etabin.size()-1 );
 
  ATH_MSG_DEBUG( "Tool configured for chain/id: " << m_decisionId );
 
  if ( not m_monTool.name().empty() ) {
    CHECK( m_monTool.retrieve() );
  }
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode TrigEgammaFastCaloHypoTool::decide( std::vector<FastClusterInfo>& input )  const 
{
  for ( auto& i: input ) {
    if ( passed ( m_decisionId.numeric(), i.previousDecisionIDs ) ) {
      if ( decide( i ) ) {
          addDecisionID( m_decisionId, i.decision );
      }
    }
  }
  return StatusCode::SUCCESS;
}
 
 
bool TrigEgammaFastCaloHypoTool::decide( const ITrigEgammaFastCaloHypoTool::FastClusterInfo& input ) const 
{
  return m_useRinger ? decide_ringer( input ) : decide_cutbased( input );
}
 
 
 
bool TrigEgammaFastCaloHypoTool::decide_cutbased( const ITrigEgammaFastCaloHypoTool::FastClusterInfo& input ) const 
{
  
  bool pass = false;
 
  auto mon_dEta         = Monitored::Scalar( "dEta",   -1.0 ); 
  auto mon_dPhi         = Monitored::Scalar( "dPhi",   -1.0 );
  auto mon_eT_T2Calo    = Monitored::Scalar( "Et_em",  -1.0 );
  auto mon_hadET_T2Calo = Monitored::Scalar( "Et_had", -1.0 );
  auto mon_rCore        = Monitored::Scalar( "RCore",  -1.0 );
  auto mon_energyRatio  = Monitored::Scalar( "Eratio", -1.0 );
  auto mon_etaBin       = Monitored::Scalar( "EtaBin", -1.0 );
  auto mon_Eta          = Monitored::Scalar( "Eta",    -99. ); 
  auto mon_Phi          = Monitored::Scalar( "Phi",    -99. );
  auto mon_F1           = Monitored::Scalar( "F1",     -1.0 );  
  auto mon_Weta2        = Monitored::Scalar( "Weta2",  -1.0 );
  auto mon_Wstot        = Monitored::Scalar( "Wstot",  -1.0 );
  auto mon_F3           = Monitored::Scalar( "F3",     -1.0 );
  auto PassedCuts       = Monitored::Scalar<int>( "CutCounter", -1 );  
  auto monitorIt        = Monitored::Group( m_monTool, 
                                        mon_dEta, mon_dPhi, mon_eT_T2Calo, mon_hadET_T2Calo,
                                                  mon_rCore, mon_energyRatio, mon_etaBin, mon_Eta,
                                                  mon_Phi, mon_F1, mon_Weta2, mon_Wstot, mon_F3, PassedCuts );
  // when leaving scope it will ship data to monTool
  PassedCuts = PassedCuts + 1; //got called (data in place)
 
  float dEta(0), dPhi(0), eT_T2Calo(0), rCore(0), hadET_T2Calo(0), energyRatio(0), eta(0), phi(0), F1(0), Weta2(0), Wstot(0), F3(0);
 
  if ( m_acceptAll ) {
    pass = true;
    ATH_MSG_DEBUG( "AcceptAll property is set: taking all events" );
  } else {
    pass = false;
    ATH_MSG_DEBUG( "AcceptAll property not set: applying selection" );
  }
 
  auto roiDescriptor = input.roi;
  
  if ( fabs( roiDescriptor->eta() ) > 2.6 ) {
    ATH_MSG_DEBUG( "REJECT The cluster had eta coordinates beyond the EM fiducial volume : " << roiDescriptor->eta() << "; stop the chain now" );
    pass=false; // special case       
    return pass;
  } 
 
  ATH_MSG_DEBUG( "; RoI ID = " << roiDescriptor->roiId()
                  << ": Eta = " << roiDescriptor->eta()
                    << ", Phi = " << roiDescriptor->phi() );
  
  // fill local variables for RoI reference position
  double etaRef = roiDescriptor->eta();
  double phiRef = roiDescriptor->phi();
  // correct phi the to right range ( probably not needed anymore )   
  if ( fabs( phiRef ) > M_PI ) phiRef -= 2*M_PI; // correct phi if outside range
  
  auto pClus = input.cluster;
  float absEta = fabs( pClus->eta() );
  
  eta = pClus->eta();
  phi = pClus->phi();
  const int cutIndex = findCutIndex( absEta );
  
  // find if electron is in calorimeter crack
  bool inCrack = ( absEta > 2.37 || ( absEta > 1.37 && absEta < 1.52 ) );
  dEta =  pClus->eta() - etaRef;
  
  //  Deal with angle diferences greater than Pi
  dPhi =  fabs( pClus->phi() - phiRef );
  dPhi = ( dPhi < M_PI ? dPhi : 2*M_PI - dPhi ); // TB why only <
  
  // calculate cluster quantities // definition taken from TrigElectron constructor     
  if ( pClus->emaxs1() + pClus->e2tsts1() > 0 ) 
  energyRatio = ( pClus->emaxs1() - pClus->e2tsts1() ) / ( pClus->emaxs1() + pClus->e2tsts1() );
  
  // ( VD ) here the definition is a bit different to account for the cut of e277 @ EF 
  if ( pClus->e277()!= 0. ) rCore = pClus->e237() / pClus->e277();
  
  //fraction of energy deposited in 1st sampling
  if ( fabs( pClus->energy() ) > 0.00001 ) F1 = ( pClus->energy( CaloSampling::EMB1 )+pClus->energy( CaloSampling::EME1 ) )/pClus->energy();
  eT_T2Calo  = pClus->et();
  if ( eT_T2Calo!=0 && pClus->eta()!=0 ) hadET_T2Calo = pClus->ehad1()/cosh( fabs( pClus->eta() ) )/eT_T2Calo;
  
  //extract Weta2 varable
  Weta2 = pClus->weta2();
  
  //extract Wstot varable
  Wstot = pClus->wstot();
 
  //extract F3 ( backenergy i EM calorimeter
  float e0 = pClus->energy( CaloSampling::PreSamplerB ) + pClus->energy( CaloSampling::PreSamplerE );
  float e1 = pClus->energy( CaloSampling::EMB1 ) + pClus->energy( CaloSampling::EME1 );
  float e2 = pClus->energy( CaloSampling::EMB2 ) + pClus->energy( CaloSampling::EME2 );
  float e3 = pClus->energy( CaloSampling::EMB3 ) + pClus->energy( CaloSampling::EME3 );
  float eallsamples = e0+e1+e2+e3;
  F3 = fabs( eallsamples )>0. ? e3/eallsamples : 0.; 
 
  // apply cuts: DeltaEta( clus-ROI )
  ATH_MSG_DEBUG( "TrigEMCluster: eta="  << pClus->eta()
                    << " roi eta=" << etaRef << " DeltaEta=" << dEta
                    << " cut: <"   << m_detacluster          );
  
  if ( fabs( pClus->eta() - etaRef ) > m_detacluster ) {
       ATH_MSG_DEBUG("REJECT Cluster dEta cut failed");
       return pass;
    }
  mon_dEta         = dEta; 
  mon_Eta          = eta;
  PassedCuts = PassedCuts + 1; //Deta
  
  // DeltaPhi( clus-ROI )
  ATH_MSG_DEBUG( ": phi="  << pClus->phi()
                     << " roi phi="<< phiRef    << " DeltaPhi="<< dPhi
                   << " cut: <"  << m_dphicluster );
  
  if( dPhi > m_dphicluster ) {
    ATH_MSG_DEBUG("REJECT Clsuter dPhi cut failed");
    return pass;
  }
  mon_dPhi         = dPhi;
  mon_Phi          = phi;
  PassedCuts = PassedCuts + 1; //DPhi
 
  // eta range
  if ( cutIndex == -1 ) {  // VD
    ATH_MSG_DEBUG( "Cluster eta: " << absEta << " outside eta range " << m_etabin[m_etabin.size()-1] );
    return pass;
  } 
  else { 
    ATH_MSG_DEBUG( "eta bin used for cuts " << cutIndex );
  }
  mon_etaBin = m_etabin[cutIndex];
  PassedCuts = PassedCuts + 1; // passed eta cut
  
  // Rcore
  ATH_MSG_DEBUG ( "TrigEMCluster: Rcore=" << rCore 
                    << " cut: >"  << m_carcorethr[cutIndex] );
  if ( rCore < m_carcorethr[cutIndex] ) {
    ATH_MSG_DEBUG("REJECT rCore cut failed");
    return pass;
  }
  mon_rCore = rCore;
  PassedCuts = PassedCuts + 1; //Rcore
 
  // Eratio
  ATH_MSG_DEBUG( " cut: >"  << m_caeratiothr[cutIndex] );   
  if ( inCrack || F1 < m_F1thr[0] ) {
    ATH_MSG_DEBUG ( "TrigEMCluster: InCrack= " << inCrack << " F1=" << F1 );
  } 
  else {
    if ( energyRatio < m_caeratiothr[cutIndex] ) {
      ATH_MSG_DEBUG("REJECT e ratio cut failed");
      return pass;
    }
  }
  PassedCuts = PassedCuts + 1; //Eratio
  if( inCrack ) energyRatio = -1; //Set default value in crack for monitoring.
  mon_energyRatio  = energyRatio;
 
  // ET_em
  ATH_MSG_DEBUG( "TrigEMCluster: ET_em=" << eT_T2Calo << " cut: >"  << m_eTthr[cutIndex] );
  if ( eT_T2Calo < m_eTthr[cutIndex] ) {
    ATH_MSG_DEBUG("REJECT et cut failed");
    return pass;
  }
  mon_eT_T2Calo    = eT_T2Calo;
  PassedCuts = PassedCuts + 1; // ET_em
 
  float hadET_cut = 0.0;  
  // find which ET_had to apply : this depends on the ET_em and the eta bin
  if ( eT_T2Calo >  m_eT2thr[cutIndex] ) {
    hadET_cut = m_hadeT2thr[cutIndex] ;
    ATH_MSG_DEBUG ( "ET_em>"     << m_eT2thr[cutIndex] << ": use high ET_had cut: <" << hadET_cut );
  } 
  else {
    hadET_cut = m_hadeTthr[cutIndex];
    ATH_MSG_DEBUG ( "ET_em<"    << m_eT2thr[cutIndex] << ": use low ET_had cut: <" << hadET_cut );
  }
  
  // ET_had
  ATH_MSG_DEBUG ( "TrigEMCluster: ET_had=" << hadET_T2Calo << " cut: <" << hadET_cut );
  if ( hadET_T2Calo > hadET_cut ) {
    ATH_MSG_DEBUG("REJECT et had cut failed");
    return pass;
  }
  mon_hadET_T2Calo = hadET_T2Calo;
  PassedCuts = PassedCuts + 1; //ET_had
  
  // F1
  ATH_MSG_DEBUG ( "TrigEMCluster: F1=" << F1 << " cut: >"  << m_F1thr[0] );
  mon_F1 = F1; 
  PassedCuts = PassedCuts + 1; //F1
 
  //Weta2
  ATH_MSG_DEBUG ( "TrigEMCluster: Weta2=" << Weta2 << " cut: <"  << m_WETA2thr[cutIndex] ); 
  if ( Weta2 > m_WETA2thr[cutIndex] ) {
    ATH_MSG_DEBUG("REJECT weta 2 cut failed");
    return pass;
  }
  mon_Weta2 = Weta2;
  PassedCuts = PassedCuts + 1; //Weta2
 
  //Wstot
  ATH_MSG_DEBUG ( "TrigEMCluster: Wstot=" <<Wstot << " cut: <"  << m_WSTOTthr[cutIndex] ); 
  if ( Wstot >= m_WSTOTthr[cutIndex] ) {
    ATH_MSG_DEBUG("REJECT wstot cut failed");
    return pass;
  }
  mon_Wstot = Wstot;
  PassedCuts = PassedCuts + 1; //Wstot
 
  //F3
  ATH_MSG_DEBUG( "TrigEMCluster: F3=" << F3 << " cut: <"  << m_F3thr[cutIndex] ); 
  if ( F3 > m_F3thr[cutIndex] ) {
    ATH_MSG_DEBUG("REJECT F3 cut failed");
    return pass;
  }
  mon_F3 = F3;
  PassedCuts = PassedCuts + 1; //F3
 
  // got this far => passed!
  pass = true;
 
  // Reach this point successfully  
  ATH_MSG_DEBUG( "pass = " << pass );
 
 
 
  return pass;
 
}
 
 
 
bool TrigEgammaFastCaloHypoTool::decide_ringer ( const ITrigEgammaFastCaloHypoTool::FastClusterInfo& input) const
{
 
  auto mon_et          = Monitored::Scalar("Et",-100);
  auto mon_eta         = Monitored::Scalar("Eta",-100);
  auto mon_phi         = Monitored::Scalar("Phi",-100); 
  auto mon_NNOutput    = Monitored::Scalar("NNOutput",-100);
 
  auto mon = Monitored::Group(m_monTool,mon_et,mon_eta,mon_phi,mon_NNOutput);
 
  float et(0), eta(0), phi(0), NNOutput(0);
   
  if ( m_acceptAll ) {
    ATH_MSG_DEBUG( "AcceptAll property is set: taking all events" );
    return true;
  } else {
    ATH_MSG_DEBUG( "AcceptAll property not set: applying selection" );
  }
  
  auto ringerShape = input.ringerShape;
  const xAOD::TrigEMCluster *emCluster = nullptr;
 
  if(ringerShape){
    emCluster = ringerShape->emCluster();
    if(!emCluster){
      ATH_MSG_DEBUG("There is no link to xAOD::TrigEMCluster into the Ringer object.");
      return false;
    }
  }
  else{
    ATH_MSG_WARNING( "There is no xAOD::TrigRingerRings link into the rnnOutput object.");
    return false;
  }
 
 
  et = emCluster->et();
  eta = emCluster->eta();
  phi = emCluster->phi();
 
  if(et < m_emEtCut){
    ATH_MSG_DEBUG( "Event reproved by Et threshold. Et = " << et << ", EtCut = " << m_emEtCut/Gaudi::Units::GeV);
    return false;
  }
  mon_et  = et;
  mon_eta = eta;
  mon_phi = phi;
 
  bool pass = false;
  if( input.pidDecorator.count(m_pidName)){
    NNOutput = input.valueDecorator.at(m_pidName+"NNOutput");
    pass = input.pidDecorator.at(m_pidName);
    ATH_MSG_DEBUG( "ET Cut " << m_emEtCut <<" Get the decision for " << m_pidName << ": " << (pass?"Yes":"No") );
  }else{
    ATH_MSG_DEBUG( "Pid name " << m_pidName << " not found into the decorator. Probably this decision was not computed by the hypo alg." );
  }
  mon_NNOutput = NNOutput;
 
  return pass;
}
 
 
int TrigEgammaFastCaloHypoTool::findCutIndex( float eta ) const 
{
  const float absEta = std::abs(eta);
  auto binIterator = std::adjacent_find( m_etabin.begin(), m_etabin.end(), [=](float left, float right){ return left < absEta and absEta < right; }  );
  if ( binIterator == m_etabin.end() ) {
    return -1;
  }
  return  binIterator - m_etabin.begin();
}