Tool_DecayModeDeterminator.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "PanTauAlgs/Tool_DecayModeDeterminator.h"
#include "PanTauAlgs/PanTauSeed.h"
#include "PanTauAlgs/HelperFunctions.h"
 
 
PanTau::Tool_DecayModeDeterminator::Tool_DecayModeDeterminator(const std::string& name) :
  asg::AsgTool(name)
{}
 
 
PanTau::Tool_DecayModeDeterminator::~Tool_DecayModeDeterminator() = default;
 
 
StatusCode PanTau::Tool_DecayModeDeterminator::initialize() {
 
  m_init=true;
 
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_InformationStore, m_Tool_InformationStoreName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_1p0n_vs_1p1n, m_Tool_ModeDiscriminator_1p0n_vs_1p1nName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_1p1n_vs_1pXn, m_Tool_ModeDiscriminator_1p1n_vs_1pXnName) );
  ATH_CHECK( HelperFunctions::bindToolHandle(m_Tool_ModeDiscriminator_3p0n_vs_3pXn, m_Tool_ModeDiscriminator_3p0n_vs_3pXnName) );
 
  //get the discri tools
  ATH_CHECK(m_Tool_ModeDiscriminator_1p0n_vs_1p1n.retrieve());
  ATH_CHECK(m_Tool_ModeDiscriminator_1p1n_vs_1pXn.retrieve());
  ATH_CHECK(m_Tool_ModeDiscriminator_3p0n_vs_3pXn.retrieve());
    
  //get the variable prefix
  ATH_CHECK( m_Tool_InformationStore->getInfo_String("FeatureExtractor_VarTypeName_varTypeName_Basic",        m_varTypeName_Prefix_Basic) );
 
  //get the BDT cut values
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R10X_CellBased",        m_BDTCutValue_R10X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R11X_CellBased",        m_BDTCutValue_R11X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R110_CellBased",        m_BDTCutValue_R110_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R1XX_CellBased",        m_BDTCutValue_R1XX_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R30X_CellBased",        m_BDTCutValue_R30X_CellBased) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("DecayModeDeterminator_BDTCutValue_R3XX_CellBased",        m_BDTCutValue_R3XX_CellBased) );
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode PanTau::Tool_DecayModeDeterminator::execute(PanTau::PanTauSeed* inSeed) const {
    
  PanTau::TauFeature* features    = inSeed->getFeatures();
    
  //check for invalid input seed
  bool    noValidInput        = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoValidInputTau);
  bool    noAnyConstituents   = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoConstituentsAtAll);
  bool    noSelConstituents   = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_NoSelectedConstituents);
  bool    badPt               = inSeed->isOfTechnicalQuality(PanTau::PanTauSeed::t_BadPtValue);
  bool    invalidForDecayMode = (noValidInput || noAnyConstituents || noSelConstituents || badPt);
 
  int decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtModeNotSet;
  xAOD::TauJet* tauJet = inSeed->getTauJet();
 
  if(invalidForDecayMode) {
    ATH_MSG_DEBUG("Seed has no constituents assigned and/or input seed has no substructure info - use NotSet mode for this");
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTau", xAOD::TauJetParameters::Mode_NotSet);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTauExtended", PanTau::PanTauSeed::t_ExtModeNotSet);
    tauJet->setPanTauDetail(xAOD::TauJetParameters::PanTauDetails::PanTau_DecayModeExtended, decayMode_PanTauExtended);
    return StatusCode::SUCCESS;
  }
    
  //get the mode as it was determined by the subalgorithm
  int decayMode_SubAlg = inSeed->getDecayModeBySubAlg();
  int decayMode_PanTau = xAOD::TauJetParameters::Mode_NotSet;
 
  //and calc the number of additional neutrals, not tagged as pi0
  int nPi0Neut_SubAlg     = inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Pi0Neut);
  int nNeutrals_SubAlg    = inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Neutral);
  int AdditionalNeutrals = nNeutrals_SubAlg - nPi0Neut_SubAlg;
    
  //based on the subAlg decay mode, pass to corresponding PanTau BDT...
  double          bdtResponse = -5;
  DecayModeTest   bdtTest     = t_UnknownTest;
  // 1p0n mode
  if(decayMode_SubAlg == xAOD::TauJetParameters::Mode_1p0n) {
               
    //1 prong, and no other objects at all -> use 1p0n
    if(AdditionalNeutrals == 0) {
      decayMode_PanTau = xAOD::TauJetParameters::Mode_1p0n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode100;
      bdtResponse = -3.;
            
      //if there are neutrals which are not pi0-tagged, check BDT to maybe set 1p1n
    }
    else {
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p0n_vs_1p1n->getResponse(inSeed, isOK);
      bdtTest     = t_1p0n_vs_1p1n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode10X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING: problems getting bdt response for 1p0n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R10X_CellBased) ? xAOD::TauJetParameters::Mode_1p0n : xAOD::TauJetParameters::Mode_1p1n;
      }
    }   
  }//end 1p0n    
    
  //1p1n mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_1p1n) {        
    //1prong, 1pi0 and no other neutrals. check 1p0n-vs-1p1n
    if(AdditionalNeutrals == 0) {
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p0n_vs_1p1n->getResponse(inSeed, isOK);
      bdtTest     = t_1p0n_vs_1p1n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode110;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + 0-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse <= m_BDTCutValue_R110_CellBased) ? xAOD::TauJetParameters::Mode_1p1n : xAOD::TauJetParameters::Mode_1p0n;
      }      
      //1prong, 1pi0 and additional neutrals. check 1p1n vs 1pXn
    } 
    else {
      //NOTE: May investigate chain of decisions here: first check 1p0n-1p1n, and then (in case of 1p1n) 1p1n-1pXn
      bool    isOK        = false;
      bdtResponse = m_Tool_ModeDiscriminator_1p1n_vs_1pXn->getResponse(inSeed, isOK);
      bdtTest     = t_1p1n_vs_1pXn;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode11X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R11X_CellBased) ? xAOD::TauJetParameters::Mode_1p1n: xAOD::TauJetParameters::Mode_1pXn;     
      }
    }      
  }//end 1p1n
        
  //1pXn mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_1pXn) {
    //1prong, Xpi0. check 1p1n-vs-1pXn
    bool    isOK        = false;
    bdtResponse = m_Tool_ModeDiscriminator_1p1n_vs_1pXn->getResponse(inSeed, isOK);
    bdtTest     = t_1p1n_vs_1pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode1XX;
    if(!isOK) {
      ATH_MSG_WARNING("WARNING problems getting bdt response for 1p1n + X-neutrals. use subAlg mode");
      decayMode_PanTau = decayMode_SubAlg;
    } else {
      decayMode_PanTau = (bdtResponse > m_BDTCutValue_R1XX_CellBased) ? xAOD::TauJetParameters::Mode_1p1n : xAOD::TauJetParameters::Mode_1pXn;
    }        
  }//end 1pXn      
    
  //3p0n mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_3p0n) {        
    //no additional neutrals. 
    if(AdditionalNeutrals == 0) {
      decayMode_PanTau = xAOD::TauJetParameters::Mode_3p0n;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode300;
      bdtResponse = -2.5;            
      //additional neutrals
    } 
    else {            
      bool isOK = false;
      bdtResponse = m_Tool_ModeDiscriminator_3p0n_vs_3pXn->getResponse(inSeed, isOK);
      bdtTest = t_3p0n_vs_3pXn;
      decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode30X;
      if(!isOK) {
    ATH_MSG_WARNING("WARNING problems getting bdt response for 3p0n + X-neutrals. use subAlg mode");
    decayMode_PanTau = decayMode_SubAlg;
      }
      else {
        decayMode_PanTau = (bdtResponse > m_BDTCutValue_R30X_CellBased) ? xAOD::TauJetParameters::Mode_3p0n : xAOD::TauJetParameters::Mode_3pXn;
      }
    }        
  }//end 3p0n
 
  //3pXn mode
  else if (decayMode_SubAlg == xAOD::TauJetParameters::Mode_3pXn) {       
    //3prong, Xpi0. check 3p0n-vs-3pXn
    bool    isOK        = false;
    bdtResponse = m_Tool_ModeDiscriminator_3p0n_vs_3pXn->getResponse(inSeed, isOK);
    bdtTest     = t_3p0n_vs_3pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode3XX;
    if(!isOK) {
      ATH_MSG_WARNING("WARNING problems getting bdt response for 3p0n + X-neutrals. use subAlg mode");
      decayMode_PanTau = decayMode_SubAlg;
    }
    else {
      decayMode_PanTau = (bdtResponse >  m_BDTCutValue_R3XX_CellBased) ? xAOD::TauJetParameters::Mode_3p0n: xAOD::TauJetParameters::Mode_3pXn;
    }
  } //end 3pXn          
    
  //it's none of 1p0n, 1p1n, 1pXn, 3p0n, 3pXn -> set other mode
  else {
    decayMode_PanTau = xAOD::TauJetParameters::Mode_Other;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtModeOther;
    bdtResponse = -4;
    bdtTest     = t_UnknownTest;
  }
    
  // this overrides Pantau BDT 1p1n decision in the following case:
  // if cell based counted 1 charged, 1 pi0neut, and number of hits in EM1 for the pi0neut is 3 or larger, set 1pXn;
  if(inSeed->getNumberOfConstituentsOfType(PanTau::TauConstituent::t_Charged) == 1 && nPi0Neut_SubAlg == 1) {
    //check for shots in EM1
    bool isOK = false;
    PanTau::TauConstituent* pi0Neut = inSeed->getConstituentsOfType(PanTau::TauConstituent::t_Pi0Neut, isOK).at(0);
    if(isOK) {
      double nPhotons = 0.;
      std::vector<PanTau::TauConstituent*> shots = pi0Neut->getShots();
 
      for(unsigned int iShot=0; iShot<shots.size(); iShot++) {
    nPhotons = nPhotons + static_cast<double>(shots.at(iShot)->getNPhotonsInShot());
      }
 
      if(nPhotons > 2.) {
    decayMode_SubAlg = xAOD::TauJetParameters::Mode_1pXn;
    decayMode_PanTau = xAOD::TauJetParameters::Mode_1pXn;
    decayMode_PanTauExtended = PanTau::PanTauSeed::t_ExtMode11shots;
    inSeed->setModeHackedByCellBased(true);
    bdtResponse = -2.;
      }            
      //end check for pi0 neutrals were found
    }
    else {
      ATH_MSG_WARNING("Could not find expected CellBased neutral -> don't check for photons in cluster");
    }
  } //end hack check for 1p1n
  
  //update mode of seed and store in features
  inSeed->setDecayModeByPanTau(decayMode_PanTau);
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode", static_cast<double>(decayMode_SubAlg));
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTau", static_cast<double>(decayMode_PanTau));
  features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_RecoMode_PanTauExtended", static_cast<double>(decayMode_PanTauExtended));
 
  tauJet->setPanTauDetail(xAOD::TauJetParameters::PanTauDetails::PanTau_DecayModeExtended, decayMode_PanTauExtended);
    
  if(bdtTest == t_1p0n_vs_1p1n) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", bdtResponse);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
  if(bdtTest == t_1p1n_vs_1pXn) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", bdtResponse);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
  if(bdtTest == t_3p0n_vs_3pXn) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", bdtResponse);
  }
  if(bdtTest == t_UnknownTest) {
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p0n_vs_1p1n", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_1p1n_vs_1pXn", -5.);
    features->addFeature("CellBased_" + m_varTypeName_Prefix_Basic + "_BDTValue_3p0n_vs_3pXn", -5.);
  }
 
  return StatusCode::SUCCESS;    
}