PanTauSeed.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "PanTauAlgs/PanTauSeed.h"
#include "PanTauAlgs/TauConstituent.h"
 
// default constructor
PanTau::PanTauSeed::PanTauSeed()
  :
  IParticle(),
  m_p4(),
  m_IsValidSeed(false),
  m_TechnicalQuality(),
  m_TauJet(nullptr),
  m_Constituents(),
  m_TypeHLVs(),
  m_ConstituentsList_Core(),
  m_ConstituentsList_AllSelected(),
  m_ConstituentsList_All(),
  m_DecayMode_BySubAlg(0),
  m_DecayMode_ByPanTau(0),
  m_decayModeHack_CellBasedShots(false),
  m_Features(nullptr)
{
}
 
 
// destructor
PanTau::PanTauSeed::~PanTauSeed()
{
  if(m_Features != nullptr) delete m_Features;
 
  //delete the constituents                                                                                                                                                                                                                      
  for(unsigned int iConst=0; iConst<m_ConstituentsList_All.size(); iConst++) {
    PanTau::TauConstituent* curConst = m_ConstituentsList_All[iConst];
    if(curConst != nullptr) delete curConst;
  }
  m_ConstituentsList_All.clear();
  m_ConstituentsList_AllSelected.clear();
  m_ConstituentsList_Core.clear();
 
  // also clear the constituent matrix
  // dont delete the entries as they point to the (at this point already deleted) constituents in m_ConstituentsList
  for(unsigned int iType=0; iType<m_Constituents.size(); iType++) {
    std::vector<PanTau::TauConstituent*> curConsts = m_Constituents[iType];
    curConsts.clear();
  }
  m_Constituents.clear();
}
 
 
//copy constructor
PanTau::PanTauSeed::PanTauSeed(const PanTau::PanTauSeed& rhs)
  :
  IParticle(rhs),
  m_p4(rhs.m_p4),
  m_IsValidSeed(rhs.m_IsValidSeed),
  m_TechnicalQuality(rhs.m_TechnicalQuality),
  m_TauJet(rhs.m_TauJet),
  m_Constituents(rhs.m_Constituents),
  m_TypeHLVs(rhs.m_TypeHLVs),
  m_ConstituentsList_Core(rhs.m_ConstituentsList_Core),
  m_ConstituentsList_AllSelected(rhs.m_ConstituentsList_AllSelected),
  m_ConstituentsList_All(rhs.m_ConstituentsList_All),
  m_DecayMode_BySubAlg(rhs.m_DecayMode_BySubAlg),
  m_DecayMode_ByPanTau(rhs.m_DecayMode_ByPanTau),
  m_decayModeHack_CellBasedShots(rhs.m_decayModeHack_CellBasedShots),
 
  m_Features( (rhs.m_Features ? new PanTau::TauFeature(*rhs.m_Features) : nullptr) )
{
}
 
 
PanTau::PanTauSeed& PanTau::PanTauSeed::operator=(const PanTau::PanTauSeed& seed)
{
  if (this != &seed){
 
    if (!this->container() && !this->hasStore() ) {      
      makePrivateStore();
    }
    this->IParticle::operator=( seed );
    this->m_p4 = seed.m_p4;
    m_IsValidSeed           = seed.m_IsValidSeed;
    m_TechnicalQuality      = seed.m_TechnicalQuality;
    m_TauJet                = seed.m_TauJet;
    m_Constituents          = seed.m_Constituents;
    m_TypeHLVs              = seed.m_TypeHLVs;
    m_ConstituentsList_Core = seed.m_ConstituentsList_Core;
    m_ConstituentsList_AllSelected  = seed.m_ConstituentsList_AllSelected;
    m_ConstituentsList_All          = seed.m_ConstituentsList_All;
    m_decayModeHack_CellBasedShots  = seed.m_decayModeHack_CellBasedShots;
 
    if(m_Features) delete m_Features;
    m_Features              = (seed.m_Features ? new PanTau::TauFeature(*seed.m_Features) : nullptr);
  }
  return *this;
}
 
 
double PanTau::PanTauSeed::pt() const {
  // static Accessor< float > acc( "pt" );
  // return acc( *this );
  return p4().Pt();
}
 
double PanTau::PanTauSeed::eta() const {
  // static Accessor<float > acc( "eta" );
  // return acc( *this );
  return p4().Eta();
}
 
double PanTau::PanTauSeed::phi() const {
  // static Accessor< float > acc( "phi" );
  // return acc( *this );
  return p4().Phi();
}
 
double PanTau::PanTauSeed::m() const {
  // static Accessor< float> acc( "m" );
  // return acc( *this );
  return p4().M();
}
 
double PanTau::PanTauSeed::e() const{
  return p4().E(); 
}
 
double PanTau::PanTauSeed::rapidity() const {
  return p4().Rapidity(); 
}
 
PanTau::PanTauSeed::FourMom_t PanTau::PanTauSeed::p4() const {
  return m_p4;
}
 
void PanTau::PanTauSeed::setP4(float pt, float eta, float phi, float m){
  static const Accessor< float > acc1( "pt" );
  acc1( *this ) = pt;
  static const Accessor< float > acc2( "eta" );
  acc2( *this ) = eta;
  static const Accessor< float > acc3( "phi" );
  acc3( *this ) = phi;
  static const Accessor< float > acc4( "m" );
  acc4( *this ) = m;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt, eta, phi, m);
}
 
void PanTau::PanTauSeed::setPt(float pt){
  static const Accessor< float > acc( "pt" );
  acc( *this ) = pt;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt, eta(), phi(), m());
}
 
void PanTau::PanTauSeed::setEta(float eta){
  static const Accessor< float > acc( "eta" );
  acc( *this ) = eta;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta, phi(), m());
}
 
void PanTau::PanTauSeed::setPhi(float phi){
  static const Accessor< float > acc( "phi" );
  acc( *this ) = phi;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta(), phi, m());
}
 
void PanTau::PanTauSeed::setM(float m){
  static const Accessor< float > acc( "m" );
  acc( *this ) = m;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta(), phi(), m);
}
 
 
xAOD::Type::ObjectType PanTau::PanTauSeed::type() const {
  return xAOD::Type::Tau;
}
 
 
 
PanTau::PanTauSeed::PanTauSeed( xAOD::TauJet*                           tauJet,
                const std::vector<PanTau::TauConstituent*>&    tauConstituents,
                const std::vector<PanTau::TauConstituent*>&    tauConstituentsAll,
                const std::vector<int>&                 pantauSeed_TechnicalQuality
                )
  :
  IParticle()
{
 
  // *This may be a bug!!! change to Set*Pt*EtaPhiM?? ***
  // PanTau::SetP4EEtaPhiM( m_p4, tauJet->ptIntermediateAxis() * cosh( tauJet->etaIntermediateAxis() ), tauJet->etaIntermediateAxis(), tauJet->phiIntermediateAxis(), tauJet->mIntermediateAxis() );
  m_p4.SetPtEtaPhiM(tauJet->ptIntermediateAxis(), tauJet->etaIntermediateAxis(), tauJet->phiIntermediateAxis(), tauJet->mIntermediateAxis() );
  m_IsValidSeed           = true;
  m_TechnicalQuality      = pantauSeed_TechnicalQuality;
  m_TauJet                = tauJet;
  m_decayModeHack_CellBasedShots = false;
  m_Features              = new PanTau::TauFeature;
 
  //save a copy of the flat constituents list and also split into core/wide constituents                                                                                                                                                         
  m_ConstituentsList_All = tauConstituentsAll;
  m_ConstituentsList_AllSelected = tauConstituents; //all types are in here, this is the complete list                                                                                                                                           
  for(unsigned int iConst=0; iConst<tauConstituents.size(); iConst++) {
    bool isCoreChrg = tauConstituents[iConst]->isOfType(PanTau::TauConstituent::t_Charged);
    bool isCoreNeut = tauConstituents[iConst]->isOfType(PanTau::TauConstituent::t_Neutral);
    bool isCorePi0  = tauConstituents[iConst]->isOfType(PanTau::TauConstituent::t_Pi0Neut);
 
    if(isCoreChrg || isCoreNeut || isCorePi0) m_ConstituentsList_Core.push_back(tauConstituents[iConst]); // Core only contains the currently used objects                                                             
 
  }
 
  //create the constituents lists                                                                                                                                                                                                                
  for(int iType=0; iType<PanTau::TauConstituent::t_nTypes; iType++) {
    m_Constituents.emplace_back(0 );
    m_TypeHLVs.emplace_back(0,0,0,0 );
  }
 
  //assign tauConstituents                                                                                                                                                                                                                       
  TLorentzVector hlv_SumConstituents_Core = TLorentzVector(0,0,0,0);
 
  int nCharged = 0;
  int nPi0Neut = 0;
 
  for(unsigned int iConst=0; iConst<tauConstituents.size(); iConst++) {
    PanTau::TauConstituent* curConst = tauConstituents.at(iConst);
    std::vector<int>        curTypes = curConst->getTypeFlags();
 
    for(unsigned int curType=0; curType<curTypes.size(); curType++) {
      if(curTypes.at(curType) == 0) continue;
 
      if(curType == static_cast<int>(PanTau::TauConstituent::t_Charged)) nCharged++;
      if(curType == static_cast<int>(PanTau::TauConstituent::t_Pi0Neut)) nPi0Neut++;
 
      if((unsigned int)curType >= m_Constituents.size()) {
    continue;
      }
 
      //fill into sorted lists                                                                                                                                                                                                               
      m_Constituents.at(curType).push_back(curConst);
      m_TypeHLVs.at(curType) += curConst->p4();
 
    }//end loop over types                                                                                                                                                                                                                     
 
    //add all charged and neutral constituents (i.e. from core region) to core proto momentum                                                                                                                                                  
    if(curConst->isOfType(PanTau::TauConstituent::t_Charged)) {hlv_SumConstituents_Core += curConst->p4(); continue;}
    if(curConst->isOfType(PanTau::TauConstituent::t_Pi0Neut)) {hlv_SumConstituents_Core += curConst->p4(); continue;}
 
  }//end loop over constituents                                                                                                                                                                                                                  
  m_ProtoMomentum_Core = hlv_SumConstituents_Core;
 
  //set mode as obtained from subalg                                                                                                                                                                                                             
  m_DecayMode_BySubAlg = PanTau::PanTauSeed::getDecayMode(nCharged, nPi0Neut);
  m_DecayMode_ByPanTau = xAOD::TauJetParameters::Mode_Error;
 
  if(isOfTechnicalQuality(PanTau::PanTauSeed::t_NoValidInputTau)) {
    m_DecayMode_ByPanTau = xAOD::TauJetParameters::Mode_NotSet;
  }
 
}
 
 
PanTau::PanTauSeed::PanTauSeed(xAOD::TauJet* tauJet,
                   const std::vector<int>& pantauSeed_TechnicalQuality)               
  :
  IParticle(),
  m_Constituents(),
  m_TypeHLVs(),
  m_ConstituentsList_AllSelected(),
  m_ConstituentsList_All(),
  m_DecayMode_BySubAlg(0),
  m_DecayMode_ByPanTau(0),
  m_decayModeHack_CellBasedShots(false)
{
  // *This may be a bug!!! change to Set*Pt*EtaPhiM?? ***
  //  PanTau::SetP4EEtaPhiM( m_p4, tauJet->ptIntermediateAxis() * cosh( tauJet->etaIntermediateAxis() ), tauJet->etaIntermediateAxis(), tauJet->phiIntermediateAxis(), tauJet->mIntermediateAxis() );
  m_p4.SetPtEtaPhiM(tauJet->ptIntermediateAxis(), tauJet->etaIntermediateAxis(), tauJet->phiIntermediateAxis(), tauJet->mIntermediateAxis() );
  m_IsValidSeed           = false;
  m_TechnicalQuality      = pantauSeed_TechnicalQuality;
  m_TauJet                = tauJet;
  m_Features              = new PanTau::TauFeature;
}
 
 
int PanTau::PanTauSeed::getDecayMode(int nCharged, int nNeutral) {
 
  int decayMode;
 
  // 1 Prong modes
  if(nCharged == 1 && nNeutral == 0) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_1p0n);
  else if(nCharged == 1 && nNeutral == 1) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_1p1n);
  else if(nCharged == 1 && nNeutral >  1) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_1pXn);
  // 3 prong modes
  else if(nCharged == 3 && nNeutral == 0) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_3p0n);
  else if(nCharged == 3 && nNeutral >  0) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_3pXn);
  // other mode
  else if(nCharged == 2) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_Other);
  else if(nCharged == 4) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_Other);
  else if(nCharged == 5) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_Other);
  else if(nCharged == 0) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_NotSet);
  else if(nCharged >= 6) decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_NotSet);
  else decayMode = static_cast<int>(xAOD::TauJetParameters::Mode_Error);
 
  return decayMode;
}
 
 
std::string PanTau::PanTauSeed::getDecayModeName(int decayMode) {
 
  xAOD::TauJetParameters::DecayMode mode = (xAOD::TauJetParameters::DecayMode)decayMode;
 
  if(mode == xAOD::TauJetParameters::Mode_1p0n) return "1p0n";
  if(mode == xAOD::TauJetParameters::Mode_1p1n) return "1p1n";
  if(mode == xAOD::TauJetParameters::Mode_1pXn) return "1pXn";
  if(mode == xAOD::TauJetParameters::Mode_3p0n) return "3p0n";
  if(mode == xAOD::TauJetParameters::Mode_3pXn) return "3pXn";
  if(mode == xAOD::TauJetParameters::Mode_Other) return "Other";
  if(mode == xAOD::TauJetParameters::Mode_Error) return "Error";
  if(mode == xAOD::TauJetParameters::Mode_NotSet) return "NotSet";
  return "InvalidMode!!!";
}
 
 
bool PanTau::PanTauSeed::isOfTechnicalQuality(int pantauSeed_TechnicalQuality) const {
  if(pantauSeed_TechnicalQuality > PanTau::PanTauSeed::t_nTechnicalQualities) {
    return false;
  }
  if(m_TechnicalQuality[pantauSeed_TechnicalQuality] == 1) return true;
  return false;
}
 
 
std::vector<PanTau::TauConstituent*> PanTau::PanTauSeed::getConstituentsOfType(int tauConstituent_Type, bool& foundit) {
  if(tauConstituent_Type > PanTau::TauConstituent::t_nTypes) {
    foundit = false;
    return std::vector<TauConstituent*>(0);
  }
  foundit = true;
  if(tauConstituent_Type == static_cast<int>(PanTau::TauConstituent::t_NoType)) return m_ConstituentsList_AllSelected;
  return m_Constituents.at(tauConstituent_Type);
}
 
 
int PanTau::PanTauSeed::getNumberOfConstituentsOfType(int tauConstituent_Type) {
  bool isOK = false;
  std::vector<PanTau::TauConstituent*> consts = this->getConstituentsOfType(tauConstituent_Type, isOK);
  if(isOK) {
    return static_cast<int>(consts.size());
  }
  return -1;
}
 
 
TLorentzVector PanTau::PanTauSeed::getSubsystemHLV(int tauConstituent_Type, bool& foundit) {
  if(tauConstituent_Type > PanTau::TauConstituent::t_nTypes) {
    foundit = false;
    return {0,0,0,0};
  }
  foundit = true;
  return m_TypeHLVs.at(tauConstituent_Type);
}