TruthParticle_v1.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAODTRUTH_VERSIONS_TRUTHPARTICLE_V1_H
#define XAODTRUTH_VERSIONS_TRUTHPARTICLE_V1_H
 
// EDM include(s):
#include "AthLinks/ElementLink.h"
 
// xAOD include(s):
#include "xAODBase/IParticle.h"
#include "xAODBase/ObjectType.h"
 
// Local include(s):
#include "xAODTruth/TruthVertexContainerFwd.h"
 
// ROOT include(s):
#include "Math/Vector4D.h"
#include "xAODTruth/TruthParticleContainerFwd.h"
template struct DataVector_detail::DVLEltBaseInit< xAOD::TruthParticle_v1>;
 
namespace xAOD {

   class TruthParticle_v1 : public IParticle {
 
   public:
      TruthParticle_v1();


      void setPdgId( int pid );
      int pdgId() const;

      inline int pdg_id() const  { return pdgId();}
      int absPdgId() const;

      int uid() const;
      void setUid( int value );

      int status() const;
      void setStatus( int value );



      bool hasProdVtx() const;
      const TruthVertex_v1* prodVtx() const;

      inline const TruthVertex_v1* production_vertex() const { return prodVtx();}

      const ElementLink< TruthVertexContainer >& prodVtxLink() const;
      void setProdVtxLink( const ElementLink< TruthVertexContainer >& link );

      bool hasDecayVtx() const;
      const TruthVertex_v1* decayVtx() const;

      inline const TruthVertex_v1* end_vertex() const { return decayVtx();}

      const ElementLink< TruthVertexContainer >& decayVtxLink() const;
      void setDecayVtxLink( const ElementLink< TruthVertexContainer >& link );



      size_t nParents() const;

      const TruthParticle_v1* parent( size_t i) const;
      
      [[deprecated("Please select a specific parent index in your code!")]]
      const TruthParticle_v1* parent() const {
         return parent(0);
      }

      size_t nChildren() const;

      const TruthParticle_v1* child( size_t i) const;





      virtual double pt() const override final;
      virtual double eta() const override final;
      virtual double phi() const override final;
      virtual double m() const override final;
      virtual double e() const override final;
      virtual double rapidity() const override final;

      typedef IParticle::FourMom_t FourMom_t;

      virtual FourMom_t p4() const override final;

      typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > GenVecFourMom_t;

      GenVecFourMom_t genvecP4() const;

      virtual Type::ObjectType type() const override final;



      double abseta() const;
      double absrapidity() const;

      float px() const;
      void setPx( float value );

      float py() const;
      void setPy( float value );

      float pz() const;
      void setPz( float value );

      void setE( float value );

      void setM( float value );



      double charge() const;
      int threeCharge() const;

      bool isCharged() const;
      bool isNeutral() const;

      bool isPhoton() const;
      bool isLepton() const;
      bool isChLepton() const;
      bool isElectron() const;
      bool isMuon() const;
      bool isTau() const;
      bool isNeutrino() const;

      bool isHadron() const;
      bool isMeson() const;
      bool isBaryon() const;

      bool hasStrange() const;
      bool hasCharm() const;
      bool hasBottom() const;

      bool isLightMeson() const;
      bool isLightBaryon() const;
      bool isLightHadron() const;

      bool isHeavyMeson() const;
      bool isHeavyBaryon() const;
      bool isHeavyHadron() const;

      bool isBottomMeson() const;
      bool isBottomBaryon() const;
      bool isBottomHadron() const;

      bool isCharmMeson() const;
      bool isCharmBaryon() const;
      bool isCharmHadron() const;

      bool isStrangeMeson() const;
      bool isStrangeBaryon() const;
      bool isStrangeHadron() const;

      bool isQuark() const;
      bool isParton() const;
      bool isTop() const;
      bool isW() const;
      bool isZ() const;
      bool isHiggs() const;
      bool isResonance() const;
      bool isGenSpecific() const;
      bool isBSM() const;
      bool isGenStable() const;
      bool isStable() const;
      bool isSimulationParticle() const;



      enum PolParam {
         polarizationPhi   = 0, 
         polarizationTheta = 1  
      };

      bool polarizationParameter( float& value, PolParam parameter ) const;

      bool setPolarizationParameter( float value, PolParam parameter );

      float polarizationParameter( PolParam parameter ) const;

      struct Polarization {

         Polarization()
         : phi( -1.0 ), theta( -1.0 ) {}

         bool valid() const {
            return ( ( phi > 0.0 ) && ( theta > 0.0 ) );
         }
 
         float phi;   
         float theta; 
 
      }; // struct Polarization

      Polarization polarization() const;


      void toPersistent();
 
   }; // class TruthParticle_v1
 
  inline std::ostream& operator<<(std::ostream& os, const TruthParticle_v1* p) {
    if (!p) { os << "Prt: Empty particle" << std::endl; return os;}
    os << "Prt: uid=";
    os << p->uid() << " pdg_id=";
    os << p->pdg_id() << " (px,py,pz,e)=";
    os << p->px() << ",";
    os << p->py() << ",";
    os << p->pz() << ",";
    os << p->e() << ";(pt,eta,phi)=";
    os << p->pt() << ",";
    os << p->eta() << ",";
    os << p->phi() << "; status=";
    os << p->status();
    /* os << std::endl; AV:Not clear if we need a new line here */
    return os;
  }
} // namespace xAOD
 
#endif // XAODTRUTH_VERSIONS_TRUTHPARTICLE_V1_H