ITruthIncident.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_EVENT_ITRUTHINCIDENT_H
#define ISF_EVENT_ITRUTHINCIDENT_H 1
 
// DetectorDescription
#include "AtlasDetDescr/AtlasRegion.h"
 
// Barcode includes
#include "TruthUtils/MagicNumbers.h"
 
// forward declarations
#include "AtlasHepMC/GenParticle_fwd.h"
#include "AtlasHepMC/SimpleVector.h"
 
namespace ISF {

  typedef enum InteractionClass_t {
    STD_VTX = 0,
    QS_SURV_VTX = 1,
    QS_DEST_VTX = 2,
    QS_PREDEF_VTX = 3,
    UNKNOWN_VTX
  } InteractionClass_t;

  class ITruthIncident {
  public:
    ITruthIncident(AtlasDetDescr::AtlasRegion geoID, unsigned short numChildren): m_geoID(geoID),
                                                                                  m_numChildren(numChildren),
                                                                                  m_passWholeVertex(true),
                                                                                  m_childPassedFilters(numChildren,false) { };

    AtlasDetDescr::AtlasRegion geoID() { return m_geoID; };

    virtual const HepMC::FourVector&  position() const = 0;

    virtual int                       physicsProcessCategory() const = 0;
    virtual int physicsProcessCode() const = 0;

    virtual double                    parentP2() const = 0;
    virtual double                    parentPt2() const = 0;
    virtual double                    parentEkin() const = 0;
    virtual int                       parentPdgCode() const = 0;
    virtual HepMC::GenParticlePtr      parentParticle() = 0;
    virtual int      parentStatus() = 0;
    virtual int  parentBarcode() = 0; // TODO Remove this method
    virtual int  parentUniqueID() = 0;
    virtual bool                      parentSurvivesIncident() const = 0;
    virtual HepMC::GenParticlePtr     parentParticleAfterIncident(int newBC) = 0;

    inline unsigned short             numberOfChildren() const;
    virtual double                    childP2(unsigned short index) const = 0;
    virtual double                    childPt2(unsigned short index) const = 0;
    virtual double                    childEkin(unsigned short index) const = 0;
    virtual int                       childPdgCode(unsigned short index) const = 0;
    virtual int  childBarcode(unsigned short index) const = 0;
    inline bool                       childrenP2Pass(double p2cut);
    inline bool                       childrenPt2Pass(double pt2cut);
    inline bool                       childrenEkinPass(double ekincut);
    virtual HepMC::GenParticlePtr     childParticle(unsigned short index,
                                                    int bc = HepMC::UNDEFINED_ID) = 0;
    inline void                       setChildPassedFilters(unsigned short index);
    inline bool                       childPassedFilters(unsigned short index) const;
    inline void                       setPassWholeVertices(bool passWholeVertex);

    virtual ISF::InteractionClass_t interactionClassification() const {return ISF::STD_VTX;};
  private:
    AtlasDetDescr::AtlasRegion        m_geoID; 
  protected:
    int                               m_numChildren;
    bool                              m_passWholeVertex;
    std::vector<bool>                 m_childPassedFilters;
 
  };
 
  //
  // inline methods :
  //
 
  unsigned short ISF::ITruthIncident::numberOfChildren() const {
    return m_numChildren;
  }
 
  // default loops to check a given cut for all child particles
 
  // loop over children to find out whether the momentum cut is passed or not
  bool ISF::ITruthIncident::childrenP2Pass(double p2cut) {
    bool pass = false; // true if cut passed
    // as soon as at a particle passes the cut -> end loop and return true
    for ( unsigned short i=0; !(pass && m_passWholeVertex) && (i<m_numChildren); ++i) {
      bool thispassed = (childP2(i) >= p2cut);
      if(thispassed) { setChildPassedFilters(i); }
      pass |= thispassed;
    }
    return pass;
  }
 
  // loop over children to find out whether the transverse momentum cut is passed or not
  bool ISF::ITruthIncident::childrenPt2Pass(double pt2cut) {
    bool pass = false; // true if cut passed
    // as soon as at a particle passes the cut -> end loop and return true
    for ( unsigned short i=0; !(pass && m_passWholeVertex) && (i<m_numChildren); ++i) {
      bool thispassed = (childPt2(i) >= pt2cut);
      if(thispassed) { setChildPassedFilters(i); }
      pass |= thispassed;
    }
    return pass;
  }
 
  // loop over children to find out whether the transverse momentum cut is passed or not
  bool ISF::ITruthIncident::childrenEkinPass(double ekincut) {
    bool pass = false; // true if cut passed
    // as soon as at a particle passes the cut -> end loop and return true
    for ( unsigned short i=0; !(pass && m_passWholeVertex) && (i<m_numChildren); ++i) {
      bool thispassed = (childEkin(i) >= ekincut);
      if(thispassed) { setChildPassedFilters(i); }
      pass |= thispassed;
    }
    return pass;
  }
 
  void ISF::ITruthIncident::setChildPassedFilters(unsigned short index) {
    m_childPassedFilters[index] = true;
    return;
  }
 
  bool ISF::ITruthIncident::childPassedFilters(unsigned short index) const {
    return m_childPassedFilters[index];
  }
 
  void ISF::ITruthIncident::setPassWholeVertices(bool passWholeVertex) {
    m_passWholeVertex=passWholeVertex;
  }
 
}
 
#endif //> !ISF_EVENT_ITRUTHINCIDENT_H