Particle.hh

// -*- C++ -*-
#ifndef RIVET_Particle_HH
#define RIVET_Particle_HH

#include "Rivet/Particle.fhh"
#include "Rivet/ParticleBase.hh"
#include "Rivet/Config/RivetCommon.hh"
#include "Rivet/Tools/Cuts.hh"
#include "Rivet/Tools/Utils.hh"
#include "Rivet/Math/LorentzTrans.hh"
// NOTE: Rivet/Tools/ParticleUtils.hh included at the end
#include "fastjet/PseudoJet.hh"

namespace Rivet {


  class Particle : public ParticleBase {
  public:



    Particle()
      : ParticleBase(),
        _original(nullptr), _id(PID::ANY), _isDirect{false,false}
    {   }

    Particle(PdgId pid, const FourMomentum& mom, const FourVector& pos=FourVector())
      : ParticleBase(),
        _original(nullptr), _id(pid),
        _momentum(mom), _origin(pos),
        _isDirect{false,false}
    {   }

    Particle(const GenParticle* gp)
      : ParticleBase(),
        _original(gp), _id(gp->pdg_id()),
        _momentum(gp->momentum()),
        _isDirect{false,false}
    {
      const GenVertex* vprod = gp->production_vertex();
      if (vprod != nullptr) {
        setOrigin(vprod->position().t(), vprod->position().x(), vprod->position().y(), vprod->position().z());
      }
    }

    Particle(const GenParticle& gp)
      : Particle(&gp)
    {   }





    const FourMomentum& momentum() const {
      return _momentum;
    }

    Particle& setMomentum(const FourMomentum& momentum) {
      _momentum = momentum;
      return *this;
    }

    Particle& setMomentum(double E, double px, double py, double pz) {
      _momentum = FourMomentum(E, px, py, pz);
      return *this;
    }

    Particle& transformBy(const LorentzTransform& lt);

    //@




    const FourVector& origin() const {
      return _origin;
    }
    Particle& setOrigin(const FourVector& position) {
      _origin = position;
      return *this;
    }
    Particle& setOrigin(double t, double x, double y, double z) {
      _origin = FourMomentum(t, x, y, z);
      return *this;
    }





    virtual fastjet::PseudoJet pseudojet() const {
      return fastjet::PseudoJet(mom().px(), mom().py(), mom().pz(), mom().E());
    }

    operator PseudoJet () const { return pseudojet(); }


    const GenParticle* genParticle() const {
      return _original;
    }

    operator const GenParticle* () const { return genParticle(); }





    PdgId pid() const { return _id; }
    PdgId abspid() const { return std::abs(_id); }
    PdgId pdgId() const { return _id; }





    double charge() const { return PID::charge(pid()); }

    double abscharge() const { return PID::abscharge(pid()); }

    int charge3() const { return PID::charge3(pid()); }

    int threeCharge() const { return PID::threeCharge(pid()); }

    int abscharge3() const { return PID::abscharge3(pid()); }

    bool isCharged() const { return charge3() != 0; }





    bool isHadron() const { return PID::isHadron(pid()); }

    bool isMeson() const { return PID::isMeson(pid()); }

    bool isBaryon() const { return PID::isBaryon(pid()); }

    bool isLepton() const { return PID::isLepton(pid()); }

    bool isChargedLepton() const { return PID::isChargedLepton(pid()); }

    bool isNeutrino() const { return PID::isNeutrino(pid()); }

    bool hasBottom() const { return PID::hasBottom(pid()); }

    bool hasCharm() const { return PID::hasCharm(pid()); }

    // /// Does this (hadron) contain an s quark?
    // bool hasStrange() const { return PID::hasStrange(pid()); }

    bool isVisible() const;

    bool isParton() const { return PID::isParton(pid()); }





    virtual void setConstituents(const Particles& cs, bool setmom=false);

    virtual void addConstituent(const Particle& c, bool addmom=false);

    virtual void addConstituents(const Particles& cs, bool addmom=false);


    bool isComposite() const { return !constituents().empty(); }


    const Particles& constituents() const { return _constituents; }

    const Particles constituents(const ParticleSorter& sorter) const {
      return sortBy(constituents(), sorter);
    }

    const Particles constituents(const Cut& c) const {
      return filter_select(constituents(), c);
    }

    const Particles constituents(const Cut& c, const ParticleSorter& sorter) const {
      return sortBy(constituents(c), sorter);
    }

    const Particles constituents(const ParticleSelector& selector) const {
      return filter_select(constituents(), selector);
    }

    const Particles constituents(const ParticleSelector& selector, const ParticleSorter& sorter) const {
      return sortBy(constituents(selector), sorter);
    }


    Particles rawConstituents() const;

    const Particles rawConstituents(const ParticleSorter& sorter) const {
      return sortBy(rawConstituents(), sorter);
    }

    const Particles rawConstituents(const Cut& c) const {
      return filter_select(rawConstituents(), c);
    }

    const Particles rawConstituents(const Cut& c, const ParticleSorter& sorter) const {
      return sortBy(rawConstituents(c), sorter);
    }

    const Particles rawConstituents(const ParticleSelector& selector) const {
      return filter_select(rawConstituents(), selector);
    }

    const Particles rawConstituents(const ParticleSelector& selector, const ParticleSorter& sorter) const {
      return sortBy(rawConstituents(selector), sorter);
    }





    Particles parents(const Cut& c=Cuts::OPEN) const;

    Particles parents(const ParticleSelector& f) const {
      return filter_select(parents(), f);
    }

    bool hasParentWith(const ParticleSelector& f) const {
      return !parents(f).empty();
    }
    bool hasParentWith(const Cut& c) const;

    bool hasParentWithout(const ParticleSelector& f) const {
      return hasParentWith([&](const Particle& p){ return !f(p); });
    }
    bool hasParentWithout(const Cut& c) const;

    //DEPRECATED("Prefer e.g. hasParentWith(Cut::pid == 123)");
    bool hasParent(PdgId pid) const;



    Particles ancestors(const Cut& c=Cuts::OPEN, bool only_physical=true) const;

    Particles ancestors(const ParticleSelector& f, bool only_physical=true) const {
      return filter_select(ancestors(Cuts::OPEN, only_physical), f);
    }

    bool hasAncestorWith(const ParticleSelector& f, bool only_physical=true) const {
      return !ancestors(f, only_physical).empty();
    }
    bool hasAncestorWith(const Cut& c, bool only_physical=true) const;

    bool hasAncestorWithout(const ParticleSelector& f, bool only_physical=true) const {
      return hasAncestorWith([&](const Particle& p){ return !f(p); }, only_physical);
    }
    bool hasAncestorWithout(const Cut& c, bool only_physical=true) const;

    //DEPRECATED("Prefer e.g. hasAncestorWith(Cut::pid == 123)");
    bool hasAncestor(PdgId pid, bool only_physical=true) const;


    bool fromBottom() const;

    bool fromCharm() const;

    // /// @brief Determine whether the particle is from a s-hadron decay
    // ///
    // /// @note If a hadron contains b or c quarks as well as strange it is
    // /// considered a b or c hadron, but NOT a strange hadron.
    // ///
    // /// @note This question is valid in MC, but may not be perfectly answerable
    // /// experimentally -- use this function with care when replicating
    // /// experimental analyses!
    // bool fromStrange() const;

    bool fromHadron() const;

    bool fromTau(bool prompt_taus_only=false) const;

    bool fromPromptTau() const { return fromTau(true); }

    bool fromHadronicTau(bool prompt_taus_only=false) const;

    bool fromDecay() const { return fromHadron() || fromPromptTau(); }

    bool isDirect(bool allow_from_direct_tau=false, bool allow_from_direct_mu=false) const;

    bool isPrompt(bool allow_from_prompt_tau=false, bool allow_from_prompt_mu=false) const {
      return isDirect(allow_from_prompt_tau, allow_from_prompt_mu);
    }





    bool isStable() const;



    Particles children(const Cut& c=Cuts::OPEN) const;

    Particles children(const ParticleSelector& f) const {
      return filter_select(children(), f);
    }

    bool hasChildWith(const ParticleSelector& f) const {
      return !children(f).empty();
    }
    bool hasChildWith(const Cut& c) const;

    bool hasChildWithout(const ParticleSelector& f) const {
      return hasChildWith([&](const Particle& p){ return !f(p); });
    }
    bool hasChildWithout(const Cut& c) const;


    Particles allDescendants(const Cut& c=Cuts::OPEN, bool remove_duplicates=true) const;

    Particles allDescendants(const ParticleSelector& f, bool remove_duplicates=true) const {
      return filter_select(allDescendants(Cuts::OPEN, remove_duplicates), f);
    }

    bool hasDescendantWith(const ParticleSelector& f, bool remove_duplicates=true) const {
      return !allDescendants(f, remove_duplicates).empty();
    }
    bool hasDescendantWith(const Cut& c, bool remove_duplicates=true) const;

    bool hasDescendantWithout(const ParticleSelector& f, bool remove_duplicates=true) const {
      return hasDescendantWith([&](const Particle& p){ return !f(p); }, remove_duplicates);
    }
    bool hasDescendantWithout(const Cut& c, bool remove_duplicates=true) const;


    Particles stableDescendants(const Cut& c=Cuts::OPEN) const;

    Particles stableDescendants(const ParticleSelector& f) const {
      return filter_select(stableDescendants(), f);
    }

    bool hasStableDescendantWith(const ParticleSelector& f) const {
      return !stableDescendants(f).empty();
    }
    bool hasStableDescendantWith(const Cut& c) const;

    bool hasStableDescendantWithout(const ParticleSelector& f) const {
      return hasStableDescendantWith([&](const Particle& p){ return !f(p); });
    }
    bool hasStableDescendantWithout(const Cut& c) const;


    double flightLength() const;





    inline bool isFirstWith(const ParticleSelector& f) const {
      if (!f(*this)) return false; //< This doesn't even meet f, let alone being the last to do so
      if (any(parents(), f)) return false; //< If a direct parent has this property, this isn't the first
      return true;
    }

    inline bool isFirstWithout(const ParticleSelector& f) const {
      return isFirstWith([&](const Particle& p){ return !f(p); });
    }

    inline bool isLastWith(const ParticleSelector& f) const {
      if (!f(*this)) return false; //< This doesn't even meet f, let alone being the last to do so
      if (any(children(), f)) return false; //< If a child has this property, this isn't the last
      return true;
    }

    inline bool isLastWithout(const ParticleSelector& f) const {
      return isLastWith([&](const Particle& p){ return !f(p); });
    }



  protected:

    const GenParticle* _original;

    Particles _constituents;

    PdgId _id;

    FourMomentum _momentum;

    FourVector _origin;

    mutable std::pair<bool,bool> _isDirect;

  };




  std::ostream& operator << (std::ostream& os, const Particle& p);

  std::ostream& operator << (std::ostream& os, const ParticlePair& pp);



}


#include "Rivet/Tools/ParticleUtils.hh"

#endif