PFTauDecayMode.h

Go to the documentation of this file.

#ifndef DataFormats_TauReco_PFTauDecayMode_h
#define DataFormats_TauReco_PFTauDecayMode_h

/* class PFTauDecayMode
 * 
 * Stores information for determing the type of hadronic decay of a tau lepton
 *
 * Associated to a reco::PFTau object
 * Provides functionality for:
 *      - merging gamma candidates into candidate PiZeroes
 *      - indexing reconstructed hadronic decay mode
 *      - computing vertex information for multi-prong
 *      - filtering suspected underlying event
 *                          
 * author: Evan K. Friis, UC Davis (evan.klose.friis@cern.ch)
 * created: Mon Jun 30 13:53:59 PDT 2008
 */

#include "DataFormats/Candidate/interface/CompositeCandidate.h"
#include "DataFormats/Candidate/interface/VertexCompositeCandidate.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidate.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidateFwd.h"
#include "DataFormats/TauReco/interface/PFTau.h"
#include "DataFormats/TauReco/interface/PFTauDecayModeFwd.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

namespace reco {
  class PFTauDecayMode : public CompositeCandidate {
  public:
    //to help with indexing.  changing this value necissitates changing the enum below
    const static unsigned char maxNumberOfPiZeroCandidatesAllowed = 4;

    enum hadronicTauDecayModes {
      tauDecay1ChargedPion0PiZero,
      tauDecay1ChargedPion1PiZero,  // rho (770 MeV) mediated)
      tauDecay1ChargedPion2PiZero,  // a1  (1.2 GeV) mediated
      tauDecay1ChargedPion3PiZero,  // contaminated or unmerged photo
      tauDecay1ChargedPion4PiZero,  // contaminated or unmerged photo
      tauDecay2ChargedPion0PiZero,  // extra track or un-recod track
      tauDecay2ChargedPion1PiZero,  // extra track or un-recod track
      tauDecay2ChargedPion2PiZero,  // extra track or un-recod track
      tauDecay2ChargedPion3PiZero,  // extra track or un-recod track
      tauDecay2ChargedPion4PiZero,  // extra track or un-recod track
      tauDecay3ChargedPion0PiZero,  // a1  (1.2 GeV) mediated
      tauDecay3ChargedPion1PiZero,  // a1  (1.2 GeV) mediated
      tauDecay3ChargedPion2PiZero,  // a1  (1.2 GeV) mediated
      tauDecay3ChargedPion3PiZero,  // a1  (1.2 GeV) mediated
      tauDecay3ChargedPion4PiZero,  // a1  (1.2 GeV) mediated
      tauDecaysElectron,
      tauDecayMuon,
      tauDecayOther  // catch-all
    };

    PFTauDecayMode() {}
    PFTauDecayMode(Charge q,
                   const LorentzVector& p4,
                   const Point& vtx = Point(0, 0, 0),
                   int pdgId = 12,
                   int status = 2,
                   bool integerCharge = true)
        : CompositeCandidate(q, p4, vtx, pdgId, status, integerCharge) {}

    PFTauDecayMode(const VertexCompositeCandidate& chargedPions,
                   const CompositeCandidate& piZeroes,
                   const CompositeCandidate& filteredObjects);

    ~PFTauDecayMode() override {}
    PFTauDecayMode* clone() const override;

    const PFTauRef& pfTauRef() const { return pfTauRef_; }
    void setPFTauRef(const PFTauRef& theTau) { pfTauRef_ = theTau; }

    hadronicTauDecayModes getDecayMode() const { return theDecayMode_; }
    void setDecayMode(hadronicTauDecayModes theDecayMode) { theDecayMode_ = theDecayMode; }

    const VertexCompositeCandidate& chargedPions() const;
    const CompositeCandidate& neutralPions() const;
    const CompositeCandidate& filteredObjects() const;

    std::vector<const Candidate*> chargedPionCandidates() const;
    std::vector<const Candidate*> neutralPionCandidates() const;
    std::vector<const Candidate*> decayProductCandidates() const;
    std::vector<const Candidate*> filteredObjectCandidates(int absCharge = -2) const;
    std::vector<const Candidate*> neutralFilteredObjectCandidates() const;
    std::vector<const Candidate*> chargedFilteredObjectCandidates() const;

    void pfMasterClones(const Candidate* input, PFCandidateRefVector& toFill) const;

    PFCandidateRefVector associatedChargedPFCandidates() const;
    PFCandidateRefVector associatedNeutralPFCandidates() const;
    PFCandidateRefVector filteredPFCandidates() const;

  protected:
    PFTauRef pfTauRef_;
    VertexCompositeCandidate chargedPions_;
    CompositeCandidate piZeroes_;
    CompositeCandidate filteredObjects_;  // stores objects considered UE
    hadronicTauDecayModes theDecayMode_;
  };
}  // namespace reco

#endif