CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Attributes | Private Member Functions | Friends
pat::Jet Class Reference

Analysis-level calorimeter jet class. More...

#include "DataFormats/PatCandidates/interface/Jet.h"

Inheritance diagram for pat::Jet:
pat::PATObject< reco::Jet > reco::Jet reco::CompositePtrCandidate reco::LeafCandidate reco::Candidate

Public Member Functions

void addBDiscriminatorPair (const std::pair< std::string, float > &thePair)
 method to add a algolabel-discriminator pair More...
 
void addSubjets (pat::JetPtrCollection const &pieces, std::string const &label="")
 Add new set of subjets. More...
 
void addTagInfo (const std::string &label, const TagInfoFwdPtrCollection::value_type &info)
 
const reco::TrackRefVectorassociatedTracks () const
 method to return a vector of refs to the tracks associated to this jet More...
 
const std::vector< std::string > availableJECLevels (const int &set=0) const
 
const std::vector< std::string > availableJECLevels (const std::string &set) const
 
const std::vector< std::string > availableJECSets () const
 -— methods for jet corrections -— More...
 
float bDiscriminator (const std::string &theLabel) const
 -— methods for accessing b-tagging info -— More...
 
const CaloSpecificcaloSpecific () const
 retrieve the calo specific part of the jet More...
 
CaloTowerFwdPtrVector const & caloTowersFwdPtr () const
 Access to bare FwdPtr collections. More...
 
float chargedEmEnergy () const
 chargedEmEnergy More...
 
float chargedEmEnergyFraction () const
 chargedEmEnergyFraction (relative to uncorrected jet energy) More...
 
float chargedHadronEnergy () const
 chargedHadronEnergy More...
 
float chargedHadronEnergyFraction () const
 chargedHadronEnergyFraction (relative to uncorrected jet energy) More...
 
int chargedHadronMultiplicity () const
 chargedHadronMultiplicity More...
 
float chargedMuEnergy () const
 chargedMuEnergy More...
 
float chargedMuEnergyFraction () const
 chargedMuEnergyFraction More...
 
int chargedMultiplicity () const
 chargedMultiplicity More...
 
void clearDaughters () override
 clear daughter references More...
 
Jetclone () const override
 required reimplementation of the Candidate's clone method More...
 
Jet correctedJet (const std::string &level, const std::string &flavor="none", const std::string &set="") const
 
Jet correctedJet (const unsigned int &level, const JetCorrFactors::Flavor &flavor=JetCorrFactors::NONE, const unsigned int &set=0) const
 
const LorentzVector correctedP4 (const std::string &level, const std::string &flavor="none", const std::string &set="") const
 
const LorentzVector correctedP4 (const unsigned int &level, const JetCorrFactors::Flavor &flavor=JetCorrFactors::NONE, const unsigned int &set=0) const
 
JetCorrFactors::Flavor currentJECFlavor () const
 return flavour of the current step of jet energy corrections More...
 
std::string currentJECLevel () const
 return the name of the current step of jet energy corrections More...
 
std::string currentJECSet () const
 returns the label of the current set of jet energy corrections More...
 
const reco::Candidatedaughter (size_t i) const override
 
reco::CandidatePtr daughterPtr (size_t i) const override
 reference to daughter at given position More...
 
const reco::CompositePtrCandidate::daughtersdaughterPtrVector () const override
 references to daughtes More...
 
float elecMultiplicity () const
 chargedMultiplicity More...
 
const reco::TrackRefVectorelecsInVertexInCalo () const
 electrons fully contained in cone More...
 
const reco::TrackRefVectorelecsInVertexOutCalo () const
 electrons that curled out More...
 
const reco::TrackRefVectorelecsOutVertexInCalo () const
 electrons that curled in More...
 
float electronEnergy () const
 electronEnergy More...
 
float electronEnergyFraction () const
 electronEnergyFraction (relative to corrected jet energy) More...
 
int electronMultiplicity () const
 electronMultiplicity More...
 
float emEnergyFraction () const
 returns the jet electromagnetic energy fraction More...
 
float emEnergyInEB () const
 returns the jet electromagnetic energy in EB More...
 
float emEnergyInEE () const
 returns the jet electromagnetic energy in EE More...
 
float emEnergyInHF () const
 returns the jet electromagnetic energy extracted from HF More...
 
float energyFractionHadronic () const
 returns the jet hadronic energy fraction More...
 
const reco::GenJetgenJet () const
 return the matched generated jet More...
 
edm::FwdRef< reco::GenJetCollection > const & genJetFwdRef () const
 
const reco::GenParticlegenParton () const
 -— methods for MC matching -— More...
 
CaloTowerPtr getCaloConstituent (unsigned fIndex) const
 convert generic constituent to specific type More...
 
std::vector< CaloTowerPtr > const & getCaloConstituents () const
 
const std::vector< std::pair< std::string, float > > & getPairDiscri () const
 get vector of paire labelname-disciValue More...
 
reco::PFCandidatePtr getPFConstituent (unsigned fIndex) const
 convert generic constituent to specific type More...
 
std::vector< reco::PFCandidatePtr > const & getPFConstituents () const
 
double groomedMass (unsigned int index=0) const
 Access to mass of subjets. More...
 
double groomedMass (std::string const &label) const
 
float hadEnergyInHB () const
 returns the jet hadronic energy in HB More...
 
float hadEnergyInHE () const
 returns the jet hadronic energy in HE More...
 
float hadEnergyInHF () const
 returns the jet hadronic energy in HF More...
 
float hadEnergyInHO () const
 returns the jet hadronic energy in HO More...
 
int hadronFlavour () const
 return the hadron-based flavour of the jet More...
 
bool hasPFSpecific () const
 check to see if the PFSpecific object is stored More...
 
bool hasSubjets (std::string const &label) const
 Check to see if the subjet collection exists. More...
 
bool hasTagInfo (const std::string label) const
 check to see if the given tag info is nonzero More...
 
float HFEMEnergy () const
 HFEMEnergy. More...
 
float HFEMEnergyFraction () const
 HFEMEnergyFraction (relative to corrected jet energy) More...
 
int HFEMMultiplicity () const
 HFEMMultiplicity. More...
 
float HFHadronEnergy () const
 HFHadronEnergy. More...
 
float HFHadronEnergyFraction () const
 HFHadronEnergyFraction (relative to corrected jet energy) More...
 
int HFHadronMultiplicity () const
 HFHadronMultiplicity. More...
 
float hoEnergy () const
 hoEnergy More...
 
float hoEnergyFraction () const
 hoEnergyFraction (relative to corrected jet energy) More...
 
bool isBasicJet () const
 check to see if the jet is no more than a reco::BasicJet More...
 
bool isCaloJet () const
 check to see if the jet is a reco::CaloJet More...
 
bool isJPTJet () const
 check to see if the jet is a reco::JPTJet More...
 
bool isPFJet () const
 check to see if the jet is a reco::PFJet More...
 
float jecFactor (const std::string &level, const std::string &flavor="none", const std::string &set="") const
 
float jecFactor (const unsigned int &level, const JetCorrFactors::Flavor &flavor=JetCorrFactors::NONE, const unsigned int &set=0) const
 
bool jecSetAvailable (const std::string &set) const
 
bool jecSetAvailable (const unsigned int &set) const
 
bool jecSetsAvailable () const
 
 Jet ()
 default constructor More...
 
 Jet (const reco::Jet &aJet)
 constructor from a reco::Jet More...
 
 Jet (const edm::RefToBase< reco::Jet > &aJetRef)
 constructor from ref to reco::Jet More...
 
 Jet (const edm::Ptr< reco::Jet > &aJetRef)
 constructor from ref to reco::Jet More...
 
 Jet (const edm::RefToBase< pat::Jet > &aJetRef)
 constructure from ref to pat::Jet More...
 
 Jet (const edm::Ptr< pat::Jet > &aJetRef)
 constructure from ref to pat::Jet More...
 
float jetCharge () const
 method to return the JetCharge computed when creating the Jet More...
 
const reco::JetFlavourInfojetFlavourInfo () const
 return the JetFlavourInfo of the jet More...
 
reco::JetID const & jetID () const
 accessing Jet ID information More...
 
const JPTSpecificjptSpecific () const
 retrieve the jpt specific part of the jet More...
 
float maxEInEmTowers () const
 returns the maximum energy deposited in ECAL towers More...
 
float maxEInHadTowers () const
 returns the maximum energy deposited in HCAL towers More...
 
float muonEnergy () const
 muonEnergy More...
 
float muonEnergyFraction () const
 muonEnergyFraction (relative to corrected jet energy) More...
 
int muonMultiplicity () const
 muonMultiplicity More...
 
const reco::TrackRefVectormuonsInVertexInCalo () const
 muons fully contained in cone More...
 
const reco::TrackRefVectormuonsInVertexOutCalo () const
 muons that curled out More...
 
const reco::TrackRefVectormuonsOutVertexInCalo () const
 muons that curled in More...
 
int n60 () const
 returns the number of constituents carrying a 60% of the total Jet energy*/ More...
 
int n90 () const
 returns the number of constituents carrying a 90% of the total Jet energy*/ More...
 
float neutralEmEnergy () const
 neutralEmEnergy More...
 
float neutralEmEnergyFraction () const
 neutralEmEnergyFraction (relative to uncorrected jet energy) More...
 
float neutralHadronEnergy () const
 neutralHadronEnergy More...
 
float neutralHadronEnergyFraction () const
 neutralHadronEnergyFraction (relative to uncorrected jet energy) More...
 
int neutralHadronMultiplicity () const
 neutralHadronMultiplicity More...
 
int neutralMultiplicity () const
 neutralMultiplicity More...
 
unsigned int nSubjetCollections () const
 Number of subjet collections. More...
 
size_t numberOfDaughters () const override
 
int partonFlavour () const
 return the parton-based flavour of the jet More...
 
reco::PFCandidateFwdPtrVector const & pfCandidatesFwdPtr () const
 
const PFSpecificpfSpecific () const
 retrieve the pf specific part of the jet More...
 
float photonEnergy () const
 photonEnergy More...
 
float photonEnergyFraction () const
 photonEnergyFraction (relative to corrected jet energy) More...
 
int photonMultiplicity () const
 photonMultiplicity More...
 
const reco::TrackRefVectorpionsInVertexInCalo () const
 pions fully contained in cone More...
 
const reco::TrackRefVectorpionsInVertexOutCalo () const
 pions that curled out More...
 
const reco::TrackRefVectorpionsOutVertexInCalo () const
 pions that curled in More...
 
void scaleEnergy (double fScale) override
 Scale energy and correspondingly adjust raw jec factors. More...
 
void scaleEnergy (double fScale, const std::string &level)
 
void setAssociatedTracks (const reco::TrackRefVector &tracks)
 method to set the vector of refs to the tracks associated to this jet More...
 
void setCaloSpecific (const CaloSpecific &newCaloSpecific)
 set the calo specific part of the jet More...
 
void setCaloTowers (const CaloTowerFwdPtrCollection &caloTowers)
 method to store the CaloJet constituents internally More...
 
void setGenJetRef (const edm::FwdRef< reco::GenJetCollection > &gj)
 method to set the matched generated jet reference, embedding if requested More...
 
void setGenParton (const reco::GenParticleRef &gp, bool embed=false)
 method to set the matched parton More...
 
void setHadronFlavour (int hadronFl)
 method to set the hadron-based flavour of the jet More...
 
void setJetCharge (float jetCharge)
 method to set the jet charge More...
 
void setJetFlavourInfo (const reco::JetFlavourInfo &jetFlavourInfo)
 method to set the JetFlavourInfo of the jet More...
 
void setJetID (reco::JetID const &id)
 methods for jet ID More...
 
void setJPTSpecific (const JPTSpecific &newJPTSpecific)
 set the jpt specific part of the jet More...
 
void setPartonFlavour (int partonFl)
 method to set the parton-based flavour of the jet More...
 
void setPFCandidates (const PFCandidateFwdPtrCollection &pfCandidates)
 method to store the PFCandidate constituents internally More...
 
void setPFSpecific (const PFSpecific &newPFSpecific)
 set the pf specific part of the jet More...
 
std::vector< std::string > const & subjetCollectionNames () const
 Subjet collection names. More...
 
pat::JetPtrCollection const & subjets (unsigned int index=0) const
 Access to subjet list. More...
 
pat::JetPtrCollection const & subjets (std::string const &label) const
 String access to subjet list. More...
 
const reco::BaseTagInfotagInfo (const std::string &label) const
 
const reco::BoostedDoubleSVTagInfotagInfoBoostedDoubleSV (const std::string &label="") const
 
const reco::CandIPTagInfotagInfoCandIP (const std::string &label="") const
 
const reco::CandSecondaryVertexTagInfotagInfoCandSecondaryVertex (const std::string &label="") const
 
const reco::CandSoftLeptonTagInfotagInfoCandSoftLepton (const std::string &label="") const
 
std::vector< std::string > const & tagInfoLabels () const
 get list of tag info labels More...
 
const reco::PixelClusterTagInfotagInfoPixelCluster (const std::string &label="") const
 
const reco::SecondaryVertexTagInfotagInfoSecondaryVertex (const std::string &label="") const
 
TagInfoFwdPtrCollection const & tagInfosFwdPtr () const
 
const reco::SoftLeptonTagInfotagInfoSoftLepton (const std::string &label="") const
 
const reco::TrackIPTagInfotagInfoTrackIP (const std::string &label="") const
 
float towersArea () const
 returns area of contributing towers More...
 
void updateFwdCaloTowerFwdPtr (unsigned int index, const edm::Ptr< CaloTower > &updateFwd)
 
void updateFwdGenJetFwdRef (edm::Ref< reco::GenJetCollection > updateRef)
 
void updateFwdPFCandidateFwdPtr (unsigned int index, const edm::Ptr< reco::PFCandidate > &updateFwd)
 
void updateFwdTagInfoFwdPtr (unsigned int index, const edm::Ptr< reco::BaseTagInfo > &updateFwd)
 
const float & zspCorrection () const
 zero suppression correction More...
 
 ~Jet () override
 destructor More...
 
- Public Member Functions inherited from pat::PATObject< reco::Jet >
void addGenParticleRef (const reco::GenParticleRef &ref)
 
void addTriggerObjectMatch (const TriggerObjectStandAlone &trigObj)
 add a trigger match More...
 
void addUserCand (const std::string &label, const reco::CandidatePtr &data, const bool overwrite=false)
 Set user-defined int. More...
 
void addUserData (const std::string &label, const T &data, bool transientOnly=false, bool overwrite=false)
 
void addUserDataFromPtr (const std::string &label, const edm::Ptr< pat::UserData > &data, bool overwrite=false)
 
void addUserFloat (const std::string &label, float data, const bool overwrite=false)
 Set user-defined float. More...
 
void addUserInt (const std::string &label, int32_t data, const bool overwrite=false)
 Set user-defined int. More...
 
std::vector< std::pair< std::string, pat::LookupTableRecord > > efficiencies () const
 Returns the efficiencies as <name,value> pairs (by value) More...
 
const pat::LookupTableRecordefficiency (const std::string &name) const
 Returns an efficiency given its name. More...
 
const std::vector< std::string > & efficiencyNames () const
 Returns the list of the names of the stored efficiencies. More...
 
const std::vector< pat::LookupTableRecord > & efficiencyValues () const
 Returns the list of the values of the stored efficiencies (the ordering is the same as in efficiencyNames()) More...
 
void embedGenParticle ()
 
const reco::GenParticlegenParticle (size_t idx=0) const
 
reco::GenParticleRef genParticleById (int pdgId, int status, uint8_t autoCharge=0) const
 
reco::GenParticleRef genParticleRef (size_t idx=0) const
 
std::vector< reco::GenParticleRefgenParticleRefs () const
 
size_t genParticlesSize () const
 Number of generator level particles stored as ref or embedded. More...
 
const pat::CandKinResolutiongetKinResolution (const std::string &label="") const
 
bool hasKinResolution (const std::string &label="") const
 Check if the kinematic resolutions are stored into this object (possibly specifying a label for them) More...
 
bool hasOverlaps (const std::string &label) const
 Returns true if there was at least one overlap for this test label. More...
 
bool hasUserCand (const std::string &key) const
 Return true if there is a user-defined int with a given name. More...
 
bool hasUserData (const std::string &key) const
 Check if user data with a specific type is present. More...
 
bool hasUserFloat (const std::string &key) const
 Return true if there is a user-defined float with a given name. More...
 
bool hasUserFloat (const char *key) const
 a CINT-friendly interface More...
 
bool hasUserInt (const std::string &key) const
 Return true if there is a user-defined int with a given name. More...
 
const reco::CandidateoriginalObject () const
 access to the original object; returns zero for null Ref and throws for unavailable collection More...
 
const edm::Ptr< reco::Candidate > & originalObjectRef () const
 reference to original object. Returns a null reference if not available More...
 
const std::vector< std::string > & overlapLabels () const
 Returns the labels of the overlap tests that found at least one overlap. More...
 
const reco::CandidatePtrVectoroverlaps (const std::string &label) const
 
 PATObject ()
 default constructor More...
 
 PATObject (const reco::Jet &obj)
 constructor from a base object (leaves invalid reference to original object!) More...
 
 PATObject (const edm::RefToBase< reco::Jet > &ref)
 constructor from reference More...
 
 PATObject (const edm::Ptr< reco::Jet > &ref)
 constructor from reference More...
 
double resolE (const std::string &label="") const
 Resolution on energy, possibly with a label to specify which resolution to use. More...
 
double resolEt (const std::string &label="") const
 Resolution on et, possibly with a label to specify which resolution to use. More...
 
double resolEta (const std::string &label="") const
 Resolution on eta, possibly with a label to specify which resolution to use. More...
 
double resolM (const std::string &label="") const
 
double resolP (const std::string &label="") const
 Resolution on p, possibly with a label to specify which resolution to use. More...
 
double resolPhi (const std::string &label="") const
 Resolution on phi, possibly with a label to specify which resolution to use. More...
 
double resolPInv (const std::string &label="") const
 Resolution on 1/p, possibly with a label to specify which resolution to use. More...
 
double resolPt (const std::string &label="") const
 Resolution on pt, possibly with a label to specify which resolution to use. More...
 
double resolPx (const std::string &label="") const
 Resolution on px, possibly with a label to specify which resolution to use. More...
 
double resolPy (const std::string &label="") const
 Resolution on py, possibly with a label to specify which resolution to use. More...
 
double resolPz (const std::string &label="") const
 Resolution on pz, possibly with a label to specify which resolution to use. More...
 
double resolTheta (const std::string &label="") const
 Resolution on theta, possibly with a label to specify which resolution to use. More...
 
void setEfficiency (const std::string &name, const pat::LookupTableRecord &value)
 
void setGenParticle (const reco::GenParticle &particle)
 Set the generator level particle from a particle not in the Event (embedding it, of course) More...
 
void setGenParticleRef (const reco::GenParticleRef &ref, bool embed=false)
 Set the generator level particle reference. More...
 
void setKinResolution (const pat::CandKinResolution &resol, const std::string &label="")
 Add a kinematic resolution to this object (possibly with a label) More...
 
void setOverlaps (const std::string &label, const reco::CandidatePtrVector &overlaps)
 
const TriggerObjectStandAlonetriggerObjectMatch (const size_t idx=0) const
 get one matched trigger object by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByCollection (const std::string &coll, const size_t idx=0) const
 get one matched trigger object from a certain collection by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByCollection (const char *coll, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByCondition (const std::string &nameCondition, const size_t idx=0) const
 get one matched L1 object used in a succeeding object combination of a certain L1 condition by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByCondition (const char *nameCondition, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByFilter (const std::string &labelFilter, const size_t idx=0) const
 get one matched HLT object used in a certain HLT filter by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByFilter (const char *labelFilter, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByFilterID (const unsigned triggerObjectType, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByType (const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
 get one matched trigger object of a certain type by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByType (const unsigned triggerObjectType, const size_t idx=0) const
 
const TriggerObjectStandAloneCollectiontriggerObjectMatches () const
 get all matched trigger objects More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCollection (const std::string &coll) const
 get all matched trigger objects from a certain collection More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCollection (const char *coll) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCondition (const std::string &nameCondition) const
 get all matched L1 objects used in a succeeding object combination of a certain L1 condition More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCondition (const char *nameCondition) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilter (const std::string &labelFilter) const
 get all matched HLT objects used in a certain HLT filter More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilter (const char *labelFilter) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilterID (const unsigned triggerObjectType) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByType (const trigger::TriggerObjectType triggerObjectType) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByType (const unsigned triggerObjectType) const
 
void unpackTriggerObjectPathNames (const edm::TriggerNames &names)
 unpack path names of matched trigger objects (if they were packed before embedding, which is not normally the case) More...
 
reco::CandidatePtr userCand (const std::string &key) const
 
const std::vector< std::string > & userCandNames () const
 Get list of user-defined cand names. More...
 
const TuserData (const std::string &key) const
 Returns user-defined data. Returns NULL if the data is not present, or not of type T. More...
 
const void * userDataBare (const std::string &key) const
 
const std::vector< std::string > & userDataNames () const
 Get list of user data object names. More...
 
const std::string & userDataObjectType (const std::string &key) const
 Get human-readable type of user data object, for debugging. More...
 
float userFloat (const std::string &key) const
 
float userFloat (const char *key) const
 a CINT-friendly interface More...
 
const std::vector< std::string > & userFloatNames () const
 Get list of user-defined float names. More...
 
std::vector< float > userFloatRange (const std::string &key) const
 return a range of values corresponding to key More...
 
int32_t userInt (const std::string &key) const
 
const std::vector< std::string > & userIntNames () const
 Get list of user-defined int names. More...
 
std::vector< int > userIntRange (const std::string &key) const
 returns a range of values corresponding to key More...
 
 ~PATObject () override
 destructor More...
 
- Public Member Functions inherited from reco::Jet
float constituentEtaPhiSpread () const
 
float constituentPtDistribution () const
 
float etaetaMoment () const
 eta-eta second moment, ET weighted More...
 
float etaphiMoment () const
 eta-phi second moment, ET weighted More...
 
EtaPhiMoments etaPhiStatistics () const
 eta-phi statistics, ET weighted More...
 
float etInAnnulus (float fRmin, float fRmax) const
 ET in annulus between rmin and rmax around jet direction. More...
 
virtual Constituents getJetConstituents () const
 list of constituents More...
 
virtual std::vector< const reco::Candidate * > getJetConstituentsQuick () const
 quick list of constituents More...
 
bool isJet () const override
 
virtual int isWeighted () const
 boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
 
 Jet ()
 Default constructor. More...
 
 Jet (const LorentzVector &fP4, const Point &fVertex)
 Initiator. More...
 
 Jet (const LorentzVector &fP4, const Point &fVertex, const Constituents &fConstituents)
 
virtual float jetArea () const
 get jet area More...
 
float maxDistance () const
 maximum distance from jet to constituent More...
 
int nCarrying (float fFraction) const
 return # of constituent carrying fraction of energy More...
 
virtual int nConstituents () const
 

of constituents

More...
 
virtual int nPasses () const
 number of passes taken by algorithm More...
 
float phiphiMoment () const
 phi-phi second moment, ET weighted More...
 
virtual float pileup () const
 pileup energy contribution as calculated by algorithm More...
 
virtual std::string print () const
 Print object. More...
 
virtual void setIsWeighted (bool isWeighted)
 Set boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
 
virtual void setJetArea (float fArea)
 set jet area More...
 
virtual void setNPasses (int fPasses)
 Set number of passes taken by algorithm. More...
 
virtual void setPileup (float fEnergy)
 Set pileup energy contribution as calculated by algorithm. More...
 
 ~Jet () override
 Destructor. More...
 
- Public Member Functions inherited from reco::CompositePtrCandidate
void addDaughter (const CandidatePtr &)
 add a daughter via a reference More...
 
 CompositePtrCandidate ()
 default constructor More...
 
 CompositePtrCandidate (Charge q, const LorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositePtrCandidate (Charge q, const PolarLorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositePtrCandidate (const Candidate &p)
 constructor from a Candidate More...
 
Candidatedaughter (size_type) override
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
 
const Candidatemother (size_t i=0) const override
 return pointer to mother More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
size_type numberOfSourceCandidatePtrs () const override
 
CandidatePtr sourceCandidatePtr (size_type i) const override
 
 ~CompositePtrCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge More...
 
void construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
 
Candidatedaughter (size_type) override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
double energy () const final
 energy More...
 
double et () const final
 transverse energy More...
 
double et2 () const final
 transverse energy squared (use this for cut!) More...
 
double eta () const final
 momentum pseudorapidity More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
bool hasMasterClone () const override
 
bool hasMasterClonePtr () const override
 
bool isCaloMuon () const override
 
bool isConvertedPhoton () const override
 
bool isElectron () const override
 
bool isGlobalMuon () const override
 
bool isMuon () const override
 
bool isPhoton () const override
 
bool isStandAloneMuon () const override
 
bool isTrackerMuon () const override
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
bool longLived () const final
 is long lived? More...
 
double mass () const final
 mass More...
 
bool massConstraint () const final
 do mass constraint? More...
 
double massSqr () const final
 mass squared More...
 
const CandidateBaseRefmasterClone () const override
 
const CandidatePtrmasterClonePtr () const override
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
Vector momentum () const final
 spatial momentum vector More...
 
const Candidatemother (size_type) const override
 return mother at a given position (throws an exception) More...
 
double mt () const final
 transverse mass More...
 
double mtSqr () const final
 transverse mass squared More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
size_t numberOfSourceCandidatePtrs () const override
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
double p () const final
 magnitude of momentum vector More...
 
const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
int pdgId () const final
 PDG identifier. More...
 
double phi () const final
 momentum azimuthal angle More...
 
const PolarLorentzVectorpolarP4 () const final
 four-momentum Lorentz vector More...
 
double pt () const final
 transverse momentum More...
 
double px () const final
 x coordinate of momentum vector More...
 
double py () const final
 y coordinate of momentum vector More...
 
double pz () const final
 z coordinate of momentum vector More...
 
double rapidity () const final
 rapidity More...
 
void setCharge (Charge q) final
 set electric charge More...
 
void setLongLived () final
 
void setMass (double m) final
 set particle mass More...
 
void setMassConstraint () final
 
void setP4 (const LorentzVector &p4) final
 set 4-momentum More...
 
void setP4 (const PolarLorentzVector &p4) final
 set 4-momentum More...
 
void setPdgId (int pdgId) final
 
void setPz (double pz) final
 
void setStatus (int status) final
 set status word More...
 
void setThreeCharge (Charge qx3) final
 set electric charge More...
 
void setVertex (const Point &vertex) override
 set vertex More...
 
CandidatePtr sourceCandidatePtr (size_type i) const override
 
int status () const final
 status word More...
 
double theta () const final
 momentum polar angle More...
 
int threeCharge () const final
 electric charge More...
 
const Pointvertex () const override
 vertex position (overwritten by PF...) More...
 
double vertexChi2 () const override
 chi-squares More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
double vertexNdof () const override
 
double vertexNormalizedChi2 () const override
 chi-squared divided by n.d.o.f. More...
 
double vx () const override
 x coordinate of vertex position More...
 
double vy () const override
 y coordinate of vertex position More...
 
double vz () const override
 z coordinate of vertex position More...
 
double y () const final
 rapidity More...
 
 ~LeafCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::Candidate
const_iterator begin () const
 first daughter const_iterator More...
 
iterator begin ()
 first daughter iterator More...
 
virtual const TrackbestTrack () const
 
 Candidate ()
 default constructor More...
 
virtual float dxyError () const
 uncertainty on dxy More...
 
virtual float dzError () const
 uncertainty on dz More...
 
const_iterator end () const
 last daughter const_iterator More...
 
iterator end ()
 last daughter iterator More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
virtual void setSourceCandidatePtr (const CandidatePtr &ptr)
 Set the ptr to the source Candidate. More...
 
virtual ~Candidate ()
 destructor More...
 

Protected Attributes

reco::TrackRefVector associatedTracks_
 
CaloTowerCollection caloTowers_
 
CaloTowerFwdPtrVector caloTowersFwdPtr_
 
edm::AtomicPtrCache< std::vector< CaloTowerPtr > > caloTowersTemp_
 
JetCorrFactors::Flavor currentJECFlavor_
 
unsigned int currentJECLevel_
 
unsigned int currentJECSet_
 
edm::AtomicPtrCache< std::vector< reco::CandidatePtr > > daughtersTemp_
 
bool embeddedCaloTowers_
 
bool embeddedPFCandidates_
 
std::vector< reco::GenJetgenJet_
 
edm::FwdRef< reco::GenJetCollectiongenJetFwdRef_
 
reco::GenJetRefVector genJetRef_
 
std::vector< pat::JetCorrFactorsjec_
 
float jetCharge_
 
reco::JetFlavourInfo jetFlavourInfo_
 
reco::JetID jetID_
 
std::vector< std::pair< std::string, float > > pairDiscriVector_
 
reco::PFCandidateCollection pfCandidates_
 
reco::PFCandidateFwdPtrVector pfCandidatesFwdPtr_
 
edm::AtomicPtrCache< std::vector< reco::PFCandidatePtr > > pfCandidatesTemp_
 
std::vector< CaloSpecificspecificCalo_
 
std::vector< JPTSpecificspecificJPT_
 
std::vector< PFSpecificspecificPF_
 
std::vector< pat::JetPtrCollectionsubjetCollections_
 
std::vector< std::string > subjetLabels_
 
std::vector< std::string > tagInfoLabels_
 
edm::OwnVector< reco::BaseTagInfotagInfos_
 
TagInfoFwdPtrCollection tagInfosFwdPtr_
 
- Protected Attributes inherited from pat::PATObject< reco::Jet >
std::vector< std::string > efficiencyNames_
 vector of the efficiencies (names) More...
 
std::vector< pat::LookupTableRecordefficiencyValues_
 vector of the efficiencies (values) More...
 
std::vector< reco::GenParticlegenParticleEmbedded_
 vector to hold an embedded generator level particle More...
 
std::vector< reco::GenParticleRefgenParticleRef_
 Reference to a generator level particle. More...
 
std::vector< std::string > kinResolutionLabels_
 
std::vector< pat::CandKinResolutionkinResolutions_
 Kinematic resolutions. More...
 
std::vector< reco::CandidatePtrVectoroverlapItems_
 Overlapping items (sorted by distance) More...
 
std::vector< std::string > overlapLabels_
 Overlapping test labels (only if there are any overlaps) More...
 
edm::Ptr< reco::CandidaterefToOrig_
 
TriggerObjectStandAloneCollection triggerObjectMatchesEmbedded_
 vector of trigger matches More...
 
std::vector< std::string > userCandLabels_
 
std::vector< reco::CandidatePtruserCands_
 
std::vector< std::string > userDataLabels_
 User data object. More...
 
pat::UserDataCollection userDataObjects_
 
std::vector< std::string > userFloatLabels_
 
std::vector< float > userFloats_
 
std::vector< std::string > userIntLabels_
 
std::vector< int32_t > userInts_
 

Private Member Functions

void addJECFactors (const JetCorrFactors &jec)
 add more sets of energy correction factors More...
 
void cacheCaloTowers () const
 cache calo towers More...
 
void cacheDaughters () const
 
void cachePFCandidates () const
 
const JetCorrFactorscorrFactors_ (const std::string &set) const
 return the jet correction factors of a different set, for systematic studies More...
 
const JetCorrFactorscorrFactors_ () const
 return the correction factor for this jet. Throws if they're not available. More...
 
void currentJECFlavor (const JetCorrFactors::Flavor &flavor)
 update the current JEC flavor; used by correctedJet More...
 
void currentJECLevel (const unsigned int &level)
 update the current JEC level; used by correctedJet More...
 
void currentJECSet (const unsigned int &set)
 update the current JEC set; used by correctedJet More...
 
void initializeJEC (unsigned int level, const JetCorrFactors::Flavor &flavor=JetCorrFactors::NONE, unsigned int set=0)
 initialize the jet to a given JEC level during creation starting from Uncorrected More...
 
int jecSet (const std::string &label) const
 
template<typename T >
const TtagInfoByType () const
 
template<typename T >
const TtagInfoByTypeOrLabel (const std::string &label="") const
 
void tryImportSpecific (const reco::Jet &source)
 

Friends

class PATJetProducer
 
class PATJetSlimmer
 
class PATJetUpdater
 
std::ostream & reco::operator<< (std::ostream &out, const pat::Jet &obj)
 pipe operator (introduced to use pat::Jet with PFTopProjectors) More...
 

Additional Inherited Members

- Public Types inherited from pat::PATObject< reco::Jet >
typedef reco::Jet base_type
 
- Public Types inherited from reco::Jet
typedef edm::Ptr< CandidateConstituent
 
typedef std::vector< ConstituentConstituents
 
- Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtrdaughters
 collection of references to daughters More...
 
typedef std::vector< CandidatePtrmothers
 collection of references to daughters More...
 
- Public Types inherited from reco::LeafCandidate
typedef int Charge
 electric charge type More...
 
typedef CandidateCollection daughters
 collection of daughter candidates More...
 
typedef unsigned int index
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef math::XYZVector Vector
 point in the space More...
 
- Public Types inherited from reco::Candidate
enum  { dimension = 3 }
 
enum  { size = dimension * (dimension + 1) / 2 }
 matix size More...
 
typedef int Charge
 electric charge type More...
 
typedef candidate::const_iterator const_iterator
 
typedef math::Error< dimension >::type CovarianceMatrix
 covariance error matrix (3x3) More...
 
typedef unsigned int index
 index type More...
 
typedef candidate::iterator iterator
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef size_t size_type
 
typedef math::XYZVector Vector
 point in the space More...
 
- Static Public Member Functions inherited from reco::Jet
static float detectorEta (float fZVertex, float fPhysicsEta)
 static function to convert physics eta to detector eta More...
 
static Candidate::LorentzVector detectorP4 (const Candidate::Point &vertex, const Candidate &inParticle)
 
static float physicsEta (float fZVertex, float fDetectorEta)
 static function to convert detector eta to physics eta More...
 
static Candidate::LorentzVector physicsP4 (const Candidate::Point &newVertex, const Candidate &inParticle, const Candidate::Point &oldVertex=Candidate::Point(0, 0, 0))
 
- Protected Member Functions inherited from pat::PATObject< reco::Jet >
void addUserDataObject_ (const std::string &label, std::unique_ptr< pat::UserData > value, bool overwrite=false)
 

Detailed Description

Analysis-level calorimeter jet class.

Jet implements the analysis-level calorimeter jet class within the 'pat' namespace

Author
Steven Lowette, Giovanni Petrucciani, Roger Wolf, Christian Autermann

Definition at line 77 of file Jet.h.

Constructor & Destructor Documentation

◆ Jet() [1/6]

pat::Jet::Jet ( )

default constructor

Referenced by clone().

◆ Jet() [2/6]

pat::Jet::Jet ( const reco::Jet aJet)

constructor from a reco::Jet

◆ Jet() [3/6]

pat::Jet::Jet ( const edm::RefToBase< reco::Jet > &  aJetRef)

constructor from ref to reco::Jet

◆ Jet() [4/6]

pat::Jet::Jet ( const edm::Ptr< reco::Jet > &  aJetRef)

constructor from ref to reco::Jet

◆ Jet() [5/6]

pat::Jet::Jet ( const edm::RefToBase< pat::Jet > &  aJetRef)

constructure from ref to pat::Jet

◆ Jet() [6/6]

pat::Jet::Jet ( const edm::Ptr< pat::Jet > &  aJetRef)

constructure from ref to pat::Jet

◆ ~Jet()

pat::Jet::~Jet ( )
override

destructor

Member Function Documentation

◆ addBDiscriminatorPair()

void pat::Jet::addBDiscriminatorPair ( const std::pair< std::string, float > &  thePair)

method to add a algolabel-discriminator pair

Referenced by pat::PATJetUpdater::produce(), and pat::PATJetProducer::produce().

◆ addJECFactors()

void pat::Jet::addJECFactors ( const JetCorrFactors jec)
inlineprivate

add more sets of energy correction factors

Definition at line 191 of file Jet.h.

References jetMETDQMOfflineSource_cff::jec, and jec_.

Referenced by pat::PATJetUpdater::produce(), and pat::PATJetProducer::produce().

191 { jec_.push_back(jec); };
std::vector< pat::JetCorrFactors > jec_
Definition: Jet.h:622

◆ addSubjets()

void pat::Jet::addSubjets ( pat::JetPtrCollection const &  pieces,
std::string const &  label = "" 
)

Add new set of subjets.

◆ addTagInfo()

void pat::Jet::addTagInfo ( const std::string &  label,
const TagInfoFwdPtrCollection::value_type &  info 
)

sets a tagInfo with the given name from an edm::Ptr<T> to it. If the label ends with 'TagInfos', the 'TagInfos' is stripped out.

Referenced by pat::PATJetUpdater::produce(), and pat::PATJetProducer::produce().

◆ associatedTracks()

const reco::TrackRefVector& pat::Jet::associatedTracks ( ) const

method to return a vector of refs to the tracks associated to this jet

Referenced by main().

◆ availableJECLevels() [1/2]

const std::vector<std::string> pat::Jet::availableJECLevels ( const int &  set = 0) const

Referenced by availableJECLevels().

◆ availableJECLevels() [2/2]

const std::vector<std::string> pat::Jet::availableJECLevels ( const std::string &  set) const
inline

Definition at line 124 of file Jet.h.

References availableJECLevels(), and jecSet().

124  {
125  return availableJECLevels(jecSet(set));
126  };
const std::vector< std::string > availableJECLevels(const int &set=0) const
int jecSet(const std::string &label) const

◆ availableJECSets()

const std::vector<std::string> pat::Jet::availableJECSets ( ) const

-— methods for jet corrections -—

returns the labels of all available sets of jet energy corrections

◆ bDiscriminator()

float pat::Jet::bDiscriminator ( const std::string &  theLabel) const

◆ cacheCaloTowers()

void pat::Jet::cacheCaloTowers ( ) const
private

cache calo towers

◆ cacheDaughters()

void pat::Jet::cacheDaughters ( ) const
private

◆ cachePFCandidates()

void pat::Jet::cachePFCandidates ( ) const
private

◆ caloSpecific()

const CaloSpecific& pat::Jet::caloSpecific ( ) const
inline

retrieve the calo specific part of the jet

Definition at line 279 of file Jet.h.

References specificCalo_.

Referenced by emEnergyFraction(), emEnergyInEB(), emEnergyInEE(), emEnergyInHF(), energyFractionHadronic(), hadEnergyInHB(), hadEnergyInHE(), hadEnergyInHF(), hadEnergyInHO(), maxEInEmTowers(), maxEInHadTowers(), and towersArea().

279  {
280  if (specificCalo_.empty())
281  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a CaloJet.\n";
282  return specificCalo_[0];
283  }
std::vector< CaloSpecific > specificCalo_
Definition: Jet.h:646

◆ caloTowersFwdPtr()

CaloTowerFwdPtrVector const& pat::Jet::caloTowersFwdPtr ( ) const
inline

Access to bare FwdPtr collections.

Definition at line 509 of file Jet.h.

References caloTowersFwdPtr_.

509 { return caloTowersFwdPtr_; }
CaloTowerFwdPtrVector caloTowersFwdPtr_
Definition: Jet.h:598

◆ chargedEmEnergy()

float pat::Jet::chargedEmEnergy ( ) const
inline

chargedEmEnergy

Definition at line 716 of file Jet.h.

References Exception.

Referenced by Jet.Jet::chargedEmEnergyFraction(), chargedEmEnergyFraction(), PileupJetIdAlgo::computeIdVariables(), PFJetIDSelectionFunctor::firstDataCuts(), and Jet.Jet::jetID().

716  {
717  if (isPFJet()) {
718  return pfSpecific().mChargedEmEnergy;
719  } else if (isJPTJet()) {
720  return jptSpecific().mChargedEmEnergy;
721  } else {
722  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
723  }
724 }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mChargedEmEnergy
Definition: JPTJet.h:61
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
float mChargedEmEnergy
Definition: PFJet.h:69
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275

◆ chargedEmEnergyFraction()

float pat::Jet::chargedEmEnergyFraction ( ) const
inline

chargedEmEnergyFraction (relative to uncorrected jet energy)

Definition at line 408 of file Jet.h.

References chargedEmEnergy(), reco::LeafCandidate::energy(), jecFactor(), and jecSetsAvailable().

Referenced by SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), PFJetIDSelectionFunctor::firstDataCuts(), and main().

408  {
409  return chargedEmEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
410  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float chargedEmEnergy() const
chargedEmEnergy
Definition: Jet.h:716
double energy() const final
energy

◆ chargedHadronEnergy()

float pat::Jet::chargedHadronEnergy ( ) const
inline

chargedHadronEnergy

Definition at line 696 of file Jet.h.

References Exception, isJPTJet(), isPFJet(), jptSpecific(), reco::PFJet::Specific::mChargedHadronEnergy, reco::JPTJet::Specific::mChargedHadronEnergy, and pfSpecific().

Referenced by Jet.Jet::chargedHadronEnergyFraction(), chargedHadronEnergyFraction(), PileupJetIdAlgo::computeIdVariables(), PFJetIDSelectionFunctor::firstDataCuts(), and Jet.Jet::jetID().

696  {
697  if (isPFJet()) {
699  } else if (isJPTJet()) {
701  } else {
702  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
703  }
704 }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mChargedHadronEnergy
Definition: JPTJet.h:59
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
float mChargedHadronEnergy
Definition: PFJet.h:51
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275

◆ chargedHadronEnergyFraction()

float pat::Jet::chargedHadronEnergyFraction ( ) const
inline

chargedHadronEnergyFraction (relative to uncorrected jet energy)

Definition at line 400 of file Jet.h.

References chargedHadronEnergy(), reco::LeafCandidate::energy(), jecFactor(), and jecSetsAvailable().

Referenced by SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), CombinedSVComputer::fillCommonVariables(), PFJetIDSelectionFunctor::firstDataCuts(), and main().

400  {
401  return chargedHadronEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
402  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float chargedHadronEnergy() const
chargedHadronEnergy
Definition: Jet.h:696
double energy() const final
energy

◆ chargedHadronMultiplicity()

int pat::Jet::chargedHadronMultiplicity ( ) const
inline

chargedHadronMultiplicity

Definition at line 445 of file Jet.h.

References reco::PFJet::Specific::mChargedHadronMultiplicity, and pfSpecific().

Referenced by CombinedSVComputer::fillCommonVariables(), and Jet.Jet::jetID().

const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
int mChargedHadronMultiplicity
Definition: PFJet.h:59

◆ chargedMuEnergy()

float pat::Jet::chargedMuEnergy ( ) const
inline

chargedMuEnergy

Definition at line 459 of file Jet.h.

References reco::PFJet::Specific::mChargedMuEnergy, and pfSpecific().

Referenced by Jet.Jet::chargedMuEnergyFraction(), and chargedMuEnergyFraction().

459 { return pfSpecific().mChargedMuEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mChargedMuEnergy
Definition: PFJet.h:70

◆ chargedMuEnergyFraction()

float pat::Jet::chargedMuEnergyFraction ( ) const
inline

chargedMuEnergyFraction

Definition at line 461 of file Jet.h.

References chargedMuEnergy(), reco::LeafCandidate::energy(), jecFactor(), and jecSetsAvailable().

461  {
462  return chargedMuEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
463  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float chargedMuEnergy() const
chargedMuEnergy
Definition: Jet.h:459
double energy() const final
energy

◆ chargedMultiplicity()

int pat::Jet::chargedMultiplicity ( ) const
inline

chargedMultiplicity

Definition at line 746 of file Jet.h.

References Exception.

Referenced by PileupJetIdAlgo::computeIdVariables(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), PFJetIDSelectionFunctor::firstDataCuts(), and Jet.Jet::jetID().

746  {
747  if (isPFJet()) {
749  } else if (isJPTJet()) {
753  } else {
754  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
755  }
756 }
reco::TrackRefVector muonsInVertexOutCalo
Definition: JPTJet.h:54
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
reco::TrackRefVector muonsInVertexInCalo
Definition: JPTJet.h:53
int mChargedMultiplicity
Definition: PFJet.h:72
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
reco::TrackRefVector pionsInVertexOutCalo
Definition: JPTJet.h:51
reco::TrackRefVector elecsInVertexInCalo
Definition: JPTJet.h:56
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275
reco::TrackRefVector pionsInVertexInCalo
Definition: JPTJet.h:50
size_type size() const
Size of the RefVector.
Definition: RefVector.h:102
reco::TrackRefVector elecsInVertexOutCalo
Definition: JPTJet.h:57

◆ clearDaughters()

void pat::Jet::clearDaughters ( )
inlineoverridevirtual

clear daughter references

Reimplemented from reco::CompositePtrCandidate.

Definition at line 500 of file Jet.h.

References slimmedGenJets_cfi::clearDaughters, and daughtersTemp_.

500  {
502  daughtersTemp_.reset(); // need to reset daughtersTemp_ as well
503  }
edm::AtomicPtrCache< std::vector< reco::CandidatePtr > > daughtersTemp_
Definition: Jet.h:608

◆ clone()

Jet* pat::Jet::clone ( void  ) const
inlineoverridevirtual

required reimplementation of the Candidate's clone method

Reimplemented from reco::CompositePtrCandidate.

Definition at line 101 of file Jet.h.

References Jet().

101 { return new Jet(*this); }
Jet()
default constructor

◆ correctedJet() [1/2]

Jet pat::Jet::correctedJet ( const std::string &  level,
const std::string &  flavor = "none",
const std::string &  set = "" 
) const

◆ correctedJet() [2/2]

Jet pat::Jet::correctedJet ( const unsigned int &  level,
const JetCorrFactors::Flavor flavor = JetCorrFactors::NONE,
const unsigned int &  set = 0 
) const

copy of the jet corrected up to the given level for the set of jet energy correction factors, which is currently in use

◆ correctedP4() [1/2]

const LorentzVector pat::Jet::correctedP4 ( const std::string &  level,
const std::string &  flavor = "none",
const std::string &  set = "" 
) const
inline

p4 of the jet corrected up to the given level for the set of jet energy correction factors, which is currently in use

Definition at line 164 of file Jet.h.

References correctedJet(), personalPlayback::level, and reco::LeafCandidate::p4().

Referenced by BetaStarVarProducer< T >::calculateCHSEnergies(), pat::JetCorrFactorsProducer::evaluate(), and pat::PATJetUpdater::produce().

166  {
167  return correctedJet(level, flavor, set).p4();
168  };
const LorentzVector & p4() const final
four-momentum Lorentz vector
Jet correctedJet(const std::string &level, const std::string &flavor="none", const std::string &set="") const

◆ correctedP4() [2/2]

const LorentzVector pat::Jet::correctedP4 ( const unsigned int &  level,
const JetCorrFactors::Flavor flavor = JetCorrFactors::NONE,
const unsigned int &  set = 0 
) const
inline

p4 of the jet corrected up to the given level for the set of jet energy correction factors, which is currently in use

Definition at line 171 of file Jet.h.

References correctedJet(), personalPlayback::level, and reco::LeafCandidate::p4().

173  {
174  return correctedJet(level, flavor, set).p4();
175  };
const LorentzVector & p4() const final
four-momentum Lorentz vector
Jet correctedJet(const std::string &level, const std::string &flavor="none", const std::string &set="") const

◆ corrFactors_() [1/2]

const JetCorrFactors* pat::Jet::corrFactors_ ( const std::string &  set) const
private

return the jet correction factors of a different set, for systematic studies

◆ corrFactors_() [2/2]

const JetCorrFactors* pat::Jet::corrFactors_ ( ) const
private

return the correction factor for this jet. Throws if they're not available.

◆ currentJECFlavor() [1/2]

JetCorrFactors::Flavor pat::Jet::currentJECFlavor ( ) const
inline

return flavour of the current step of jet energy corrections

Definition at line 145 of file Jet.h.

References currentJECFlavor_.

145 { return currentJECFlavor_; };
JetCorrFactors::Flavor currentJECFlavor_
Definition: Jet.h:630

◆ currentJECFlavor() [2/2]

void pat::Jet::currentJECFlavor ( const JetCorrFactors::Flavor flavor)
inlineprivate

update the current JEC flavor; used by correctedJet

Definition at line 189 of file Jet.h.

References currentJECFlavor_.

189 { currentJECFlavor_ = flavor; };
JetCorrFactors::Flavor currentJECFlavor_
Definition: Jet.h:630

◆ currentJECLevel() [1/2]

std::string pat::Jet::currentJECLevel ( ) const
inline

return the name of the current step of jet energy corrections

Definition at line 141 of file Jet.h.

References currentJECLevel_, currentJECSet_, jec_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by PatJetAnalyzer::print().

141  {
142  return currentJECSet_ < jec_.size() ? jec_.at(currentJECSet_).jecLevel(currentJECLevel_) : std::string("ERROR");
143  };
unsigned int currentJECLevel_
Definition: Jet.h:627
std::vector< pat::JetCorrFactors > jec_
Definition: Jet.h:622
unsigned int currentJECSet_
Definition: Jet.h:625

◆ currentJECLevel() [2/2]

void pat::Jet::currentJECLevel ( const unsigned int &  level)
inlineprivate

update the current JEC level; used by correctedJet

Definition at line 187 of file Jet.h.

References currentJECLevel_, and personalPlayback::level.

187 { currentJECLevel_ = level; };
unsigned int currentJECLevel_
Definition: Jet.h:627

◆ currentJECSet() [1/2]

std::string pat::Jet::currentJECSet ( ) const
inline

returns the label of the current set of jet energy corrections

Definition at line 137 of file Jet.h.

References currentJECSet_, jec_, and AlCaHLTBitMon_QueryRunRegistry::string.

137  {
138  return currentJECSet_ < jec_.size() ? jec_.at(currentJECSet_).jecSet() : std::string("ERROR");
139  }
std::vector< pat::JetCorrFactors > jec_
Definition: Jet.h:622
unsigned int currentJECSet_
Definition: Jet.h:625

◆ currentJECSet() [2/2]

void pat::Jet::currentJECSet ( const unsigned int &  set)
inlineprivate

update the current JEC set; used by correctedJet

Definition at line 185 of file Jet.h.

References currentJECSet_.

185 { currentJECSet_ = set; };
unsigned int currentJECSet_
Definition: Jet.h:625

◆ daughter()

const reco::Candidate* pat::Jet::daughter ( size_t  i) const
overridevirtual

get a pointer to a Candididate constituent of the jet If using refactorized PAT, return that. (constituents size > 0) Else check the old version of PAT (embedded constituents size > 0) Else return the reco Jet number of constituents

Reimplemented from reco::CompositePtrCandidate.

Referenced by BetaStarVarProducer< T >::calculateCHSEnergies().

◆ daughterPtr()

reco::CandidatePtr pat::Jet::daughterPtr ( size_t  i) const
overridevirtual

reference to daughter at given position

Reimplemented from reco::CompositePtrCandidate.

◆ daughterPtrVector()

const reco::CompositePtrCandidate::daughters& pat::Jet::daughterPtrVector ( ) const
overridevirtual

references to daughtes

Reimplemented from reco::CompositePtrCandidate.

Referenced by Jet.Jet::leadingTrack(), and LeptonInJetProducer< T >::produce().

◆ elecMultiplicity()

float pat::Jet::elecMultiplicity ( ) const
inline

chargedMultiplicity

Definition at line 380 of file Jet.h.

References reco::JPTJet::Specific::elecsInVertexInCalo, reco::JPTJet::Specific::elecsInVertexOutCalo, jptSpecific(), and edm::RefVector< C, T, F >::size().

380  {
382  }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector elecsInVertexInCalo
Definition: JPTJet.h:56
size_type size() const
Size of the RefVector.
Definition: RefVector.h:102
reco::TrackRefVector elecsInVertexOutCalo
Definition: JPTJet.h:57

◆ elecsInVertexInCalo()

const reco::TrackRefVector& pat::Jet::elecsInVertexInCalo ( ) const
inline

electrons fully contained in cone

Definition at line 372 of file Jet.h.

References reco::JPTJet::Specific::elecsInVertexInCalo, and jptSpecific().

372 { return jptSpecific().elecsInVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector elecsInVertexInCalo
Definition: JPTJet.h:56

◆ elecsInVertexOutCalo()

const reco::TrackRefVector& pat::Jet::elecsInVertexOutCalo ( ) const
inline

electrons that curled out

Definition at line 374 of file Jet.h.

References reco::JPTJet::Specific::elecsInVertexOutCalo, and jptSpecific().

374 { return jptSpecific().elecsInVertexOutCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector elecsInVertexOutCalo
Definition: JPTJet.h:57

◆ elecsOutVertexInCalo()

const reco::TrackRefVector& pat::Jet::elecsOutVertexInCalo ( ) const
inline

electrons that curled in

Definition at line 376 of file Jet.h.

References reco::JPTJet::Specific::elecsOutVertexInCalo, and jptSpecific().

376 { return jptSpecific().elecsOutVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector elecsOutVertexInCalo
Definition: JPTJet.h:58

◆ electronEnergy()

float pat::Jet::electronEnergy ( ) const
inline

electronEnergy

Definition at line 424 of file Jet.h.

References reco::PFJet::Specific::mElectronEnergy, and pfSpecific().

Referenced by Jet.Jet::electronEnergyFraction(), and electronEnergyFraction().

424 { return pfSpecific().mElectronEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mElectronEnergy
Definition: PFJet.h:54

◆ electronEnergyFraction()

float pat::Jet::electronEnergyFraction ( ) const
inline

electronEnergyFraction (relative to corrected jet energy)

Definition at line 426 of file Jet.h.

References electronEnergy(), reco::LeafCandidate::energy(), jecFactor(), and jecSetsAvailable().

Referenced by CombinedSVComputer::fillCommonVariables().

426  {
427  return electronEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
428  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float electronEnergy() const
electronEnergy
Definition: Jet.h:424
double energy() const final
energy

◆ electronMultiplicity()

int pat::Jet::electronMultiplicity ( ) const
inline

electronMultiplicity

Definition at line 451 of file Jet.h.

References reco::PFJet::Specific::mElectronMultiplicity, and pfSpecific().

Referenced by CombinedSVComputer::fillCommonVariables().

451 { return pfSpecific().mElectronMultiplicity; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
int mElectronMultiplicity
Definition: PFJet.h:62

◆ emEnergyFraction()

float pat::Jet::emEnergyFraction ( ) const
inline

returns the jet electromagnetic energy fraction

Definition at line 326 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mEnergyFractionEm.

Referenced by main().

326 { return caloSpecific().mEnergyFractionEm; }
float mEnergyFractionEm
Em energy fraction.
Definition: CaloJet.h:68
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ emEnergyInEB()

float pat::Jet::emEnergyInEB ( ) const
inline

returns the jet electromagnetic energy in EB

Definition at line 336 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mEmEnergyInEB.

336 { return caloSpecific().mEmEnergyInEB; }
float mEmEnergyInEB
Em energy in EB.
Definition: CaloJet.h:60
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ emEnergyInEE()

float pat::Jet::emEnergyInEE ( ) const
inline

returns the jet electromagnetic energy in EE

Definition at line 338 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mEmEnergyInEE.

338 { return caloSpecific().mEmEnergyInEE; }
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279
float mEmEnergyInEE
Em energy in EE.
Definition: CaloJet.h:62

◆ emEnergyInHF()

float pat::Jet::emEnergyInHF ( ) const
inline

returns the jet electromagnetic energy extracted from HF

Definition at line 340 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mEmEnergyInHF.

340 { return caloSpecific().mEmEnergyInHF; }
float mEmEnergyInHF
Em energy in HF.
Definition: CaloJet.h:64
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ energyFractionHadronic()

float pat::Jet::energyFractionHadronic ( ) const
inline

returns the jet hadronic energy fraction

Definition at line 324 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mEnergyFractionHadronic.

float mEnergyFractionHadronic
Hadronic energy fraction.
Definition: CaloJet.h:66
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ genJet()

const reco::GenJet* pat::Jet::genJet ( ) const

return the matched generated jet

◆ genJetFwdRef()

edm::FwdRef<reco::GenJetCollection> const& pat::Jet::genJetFwdRef ( ) const
inline

Definition at line 511 of file Jet.h.

References genJetFwdRef_.

511 { return genJetFwdRef_; }
edm::FwdRef< reco::GenJetCollection > genJetFwdRef_
Definition: Jet.h:614

◆ genParton()

const reco::GenParticle* pat::Jet::genParton ( ) const
inline

-— methods for MC matching -—

return the matched generated parton

Definition at line 106 of file Jet.h.

References pat::PATObject< reco::Jet >::genParticle().

106 { return genParticle(); }
const reco::GenParticle * genParticle(size_t idx=0) const
Definition: PATObject.h:285

◆ getCaloConstituent()

CaloTowerPtr pat::Jet::getCaloConstituent ( unsigned  fIndex) const

convert generic constituent to specific type

get specific constituent of the CaloJet. if the caloTowers were embedded, this reference is transient only and must not be persisted

◆ getCaloConstituents()

std::vector<CaloTowerPtr> const& pat::Jet::getCaloConstituents ( ) const

get the constituents of the CaloJet. If the caloTowers were embedded, these reference are transient only and must not be persisted

◆ getPairDiscri()

const std::vector<std::pair<std::string, float> >& pat::Jet::getPairDiscri ( ) const

get vector of paire labelname-disciValue

◆ getPFConstituent()

reco::PFCandidatePtr pat::Jet::getPFConstituent ( unsigned  fIndex) const

convert generic constituent to specific type

get specific constituent of the CaloJet. if the caloTowers were embedded, this reference is transient only and must not be persisted

◆ getPFConstituents()

std::vector<reco::PFCandidatePtr> const& pat::Jet::getPFConstituents ( ) const

get the constituents of the CaloJet. If the caloTowers were embedded, these reference are transient only and must not be persisted

◆ groomedMass() [1/2]

double pat::Jet::groomedMass ( unsigned int  index = 0) const
inline

Access to mass of subjets.

Definition at line 569 of file Jet.h.

References a, b, reco::LeafCandidate::mass(), nSubjetCollections(), and subjets().

569  {
570  auto const& sub = subjets(index);
571  return nSubjetCollections() > index && !sub.empty()
572  ? std::accumulate(
573  sub.begin(),
574  sub.end(),
576  [](reco::Candidate::LorentzVector const& a, reco::CandidatePtr const& b) { return a + b->p4(); })
577  .mass()
578  : -1.0;
579  }
unsigned int nSubjetCollections() const
Number of subjet collections.
Definition: Jet.h:563
pat::JetPtrCollection const & subjets(unsigned int index=0) const
Access to subjet list.
unsigned int index
Definition: LeafCandidate.h:31
double b
Definition: hdecay.h:118
math::XYZTLorentzVector LorentzVector
Lorentz vector.
Definition: Candidate.h:36
double mass() const final
mass
double a
Definition: hdecay.h:119

◆ groomedMass() [2/2]

double pat::Jet::groomedMass ( std::string const &  label) const
inline

Definition at line 580 of file Jet.h.

References a, b, hasSubjets(), label, reco::LeafCandidate::mass(), and subjets().

580  {
581  auto const& sub = subjets(label);
582  return hasSubjets(label) && !sub.empty()
583  ? std::accumulate(
584  sub.begin(),
585  sub.end(),
587  [](reco::Candidate::LorentzVector const& a, reco::CandidatePtr const& b) { return a + b->p4(); })
588  .mass()
589  : -1.0;
590  }
pat::JetPtrCollection const & subjets(unsigned int index=0) const
Access to subjet list.
char const * label
double b
Definition: hdecay.h:118
math::XYZTLorentzVector LorentzVector
Lorentz vector.
Definition: Candidate.h:36
bool hasSubjets(std::string const &label) const
Check to see if the subjet collection exists.
Definition: Jet.h:558
double mass() const final
mass
double a
Definition: hdecay.h:119

◆ hadEnergyInHB()

float pat::Jet::hadEnergyInHB ( ) const
inline

returns the jet hadronic energy in HB

Definition at line 328 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mHadEnergyInHB.

328 { return caloSpecific().mHadEnergyInHB; }
float mHadEnergyInHB
Hadronic energy in HB.
Definition: CaloJet.h:54
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ hadEnergyInHE()

float pat::Jet::hadEnergyInHE ( ) const
inline

returns the jet hadronic energy in HE

Definition at line 332 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mHadEnergyInHE.

332 { return caloSpecific().mHadEnergyInHE; }
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279
float mHadEnergyInHE
Hadronic energy in HE.
Definition: CaloJet.h:58

◆ hadEnergyInHF()

float pat::Jet::hadEnergyInHF ( ) const
inline

returns the jet hadronic energy in HF

Definition at line 334 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mHadEnergyInHF.

334 { return caloSpecific().mHadEnergyInHF; }
float mHadEnergyInHF
Hadronic energy in HF.
Definition: CaloJet.h:56
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ hadEnergyInHO()

float pat::Jet::hadEnergyInHO ( ) const
inline

returns the jet hadronic energy in HO

Definition at line 330 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mHadEnergyInHO.

330 { return caloSpecific().mHadEnergyInHO; }
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279
float mHadEnergyInHO
Hadronic nergy fraction in HO.
Definition: CaloJet.h:52

◆ hadronFlavour()

int pat::Jet::hadronFlavour ( ) const

return the hadron-based flavour of the jet

◆ hasPFSpecific()

bool pat::Jet::hasPFSpecific ( ) const
inline

check to see if the PFSpecific object is stored

Definition at line 291 of file Jet.h.

References specificPF_.

291 { return !specificPF_.empty(); }
std::vector< PFSpecific > specificPF_
Definition: Jet.h:648

◆ hasSubjets()

bool pat::Jet::hasSubjets ( std::string const &  label) const
inline

Check to see if the subjet collection exists.

Definition at line 558 of file Jet.h.

References spr::find(), label, and subjetLabels_.

Referenced by groomedMass().

558  {
559  return find(subjetLabels_.begin(), subjetLabels_.end(), label) != subjetLabels_.end();
560  }
void find(edm::Handle< EcalRecHitCollection > &hits, DetId thisDet, std::vector< EcalRecHitCollection::const_iterator > &hit, bool debug=false)
Definition: FindCaloHit.cc:19
std::vector< std::string > subjetLabels_
Definition: Jet.h:607
char const * label

◆ hasTagInfo()

bool pat::Jet::hasTagInfo ( const std::string  label) const
inline

check to see if the given tag info is nonzero

Definition at line 207 of file Jet.h.

References label, and tagInfo().

207 { return tagInfo(label) != nullptr; }
const reco::BaseTagInfo * tagInfo(const std::string &label) const
char const * label

◆ HFEMEnergy()

float pat::Jet::HFEMEnergy ( ) const
inline

HFEMEnergy.

Definition at line 440 of file Jet.h.

References reco::PFJet::Specific::mHFEMEnergy, and pfSpecific().

Referenced by Jet.Jet::HFEMEnergyFraction(), and HFEMEnergyFraction().

440 { return pfSpecific().mHFEMEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293

◆ HFEMEnergyFraction()

float pat::Jet::HFEMEnergyFraction ( ) const
inline

HFEMEnergyFraction (relative to corrected jet energy)

Definition at line 442 of file Jet.h.

References reco::LeafCandidate::energy(), HFEMEnergy(), jecFactor(), and jecSetsAvailable().

442 { return HFEMEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy()); }
float HFEMEnergy() const
HFEMEnergy.
Definition: Jet.h:440
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
double energy() const final
energy

◆ HFEMMultiplicity()

int pat::Jet::HFEMMultiplicity ( ) const
inline

HFEMMultiplicity.

Definition at line 456 of file Jet.h.

References reco::PFJet::Specific::mHFEMMultiplicity, and pfSpecific().

456 { return pfSpecific().mHFEMMultiplicity; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293

◆ HFHadronEnergy()

float pat::Jet::HFHadronEnergy ( ) const
inline

HFHadronEnergy.

Definition at line 434 of file Jet.h.

References reco::PFJet::Specific::mHFHadronEnergy, and pfSpecific().

Referenced by Jet.Jet::HFHadronEnergyFraction(), and HFHadronEnergyFraction().

434 { return pfSpecific().mHFHadronEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mHFHadronEnergy
Definition: PFJet.h:56

◆ HFHadronEnergyFraction()

float pat::Jet::HFHadronEnergyFraction ( ) const
inline

HFHadronEnergyFraction (relative to corrected jet energy)

Definition at line 436 of file Jet.h.

References reco::LeafCandidate::energy(), HFHadronEnergy(), jecFactor(), and jecSetsAvailable().

436  {
437  return HFHadronEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
438  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float HFHadronEnergy() const
HFHadronEnergy.
Definition: Jet.h:434
double energy() const final
energy

◆ HFHadronMultiplicity()

int pat::Jet::HFHadronMultiplicity ( ) const
inline

HFHadronMultiplicity.

Definition at line 454 of file Jet.h.

References reco::PFJet::Specific::mHFHadronMultiplicity, and pfSpecific().

454 { return pfSpecific().mHFHadronMultiplicity; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
int mHFHadronMultiplicity
Definition: PFJet.h:64

◆ hoEnergy()

float pat::Jet::hoEnergy ( ) const
inline

hoEnergy

Definition at line 469 of file Jet.h.

References reco::PFJet::Specific::mHOEnergy, and pfSpecific().

Referenced by Jet.Jet::hoEnergyFraction(), and hoEnergyFraction().

469 { return pfSpecific().mHOEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293

◆ hoEnergyFraction()

float pat::Jet::hoEnergyFraction ( ) const
inline

hoEnergyFraction (relative to corrected jet energy)

Definition at line 471 of file Jet.h.

References reco::LeafCandidate::energy(), hoEnergy(), jecFactor(), and jecSetsAvailable().

471 { return hoEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy()); }
float hoEnergy() const
hoEnergy
Definition: Jet.h:469
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
double energy() const final
energy

◆ initializeJEC()

void pat::Jet::initializeJEC ( unsigned int  level,
const JetCorrFactors::Flavor flavor = JetCorrFactors::NONE,
unsigned int  set = 0 
)
private

initialize the jet to a given JEC level during creation starting from Uncorrected

Referenced by pat::PATJetUpdater::produce(), and pat::PATJetProducer::produce().

◆ isBasicJet()

bool pat::Jet::isBasicJet ( ) const
inline

check to see if the jet is no more than a reco::BasicJet

Definition at line 277 of file Jet.h.

References isCaloJet(), isJPTJet(), and isPFJet().

Referenced by PFJetIDSelectionFunctor::firstDataCuts().

277 { return !(isCaloJet() || isPFJet() || isJPTJet()); }
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275
bool isCaloJet() const
check to see if the jet is a reco::CaloJet
Definition: Jet.h:271

◆ isCaloJet()

bool pat::Jet::isCaloJet ( ) const
inline

check to see if the jet is a reco::CaloJet

Definition at line 271 of file Jet.h.

References isJPTJet(), and specificCalo_.

Referenced by isBasicJet(), and pat::PATJetProducer::produce().

271 { return !specificCalo_.empty() && !isJPTJet(); }
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
std::vector< CaloSpecific > specificCalo_
Definition: Jet.h:646

◆ isJPTJet()

bool pat::Jet::isJPTJet ( ) const
inline

check to see if the jet is a reco::JPTJet

Definition at line 273 of file Jet.h.

References specificJPT_.

Referenced by chargedHadronEnergy(), isBasicJet(), isCaloJet(), and pat::PATJetProducer::produce().

273 { return !specificJPT_.empty(); }
std::vector< JPTSpecific > specificJPT_
Definition: Jet.h:647

◆ isPFJet()

bool pat::Jet::isPFJet ( ) const
inline

check to see if the jet is a reco::PFJet

Definition at line 275 of file Jet.h.

References specificPF_.

Referenced by chargedHadronEnergy(), CombinedSVComputer::fillCommonVariables(), PFJetIDSelectionFunctor::firstDataCuts(), isBasicJet(), Jet.Jet::jetID(), and pat::PATJetProducer::produce().

275 { return !specificPF_.empty(); }
std::vector< PFSpecific > specificPF_
Definition: Jet.h:648

◆ jecFactor() [1/2]

float pat::Jet::jecFactor ( const std::string &  level,
const std::string &  flavor = "none",
const std::string &  set = "" 
) const

◆ jecFactor() [2/2]

float pat::Jet::jecFactor ( const unsigned int &  level,
const JetCorrFactors::Flavor flavor = JetCorrFactors::NONE,
const unsigned int &  set = 0 
) const

correction factor to the given level for a specific set of correction factors, starting from the current level

Referenced by Jet.Jet::rawFactor(), and Jet.Jet::setRawFactor().

◆ jecSet()

int pat::Jet::jecSet ( const std::string &  label) const
private

index of the set of jec factors with given label; returns -1 if no set of jec factors exists with the given label

Referenced by availableJECLevels(), and jecSetAvailable().

◆ jecSetAvailable() [1/2]

bool pat::Jet::jecSetAvailable ( const std::string &  set) const
inline

returns true if the jet carries a set of jet energy correction factors with the given label

Definition at line 132 of file Jet.h.

References jecSet().

132 { return (jecSet(set) >= 0); };
int jecSet(const std::string &label) const

◆ jecSetAvailable() [2/2]

bool pat::Jet::jecSetAvailable ( const unsigned int &  set) const
inline

returns true if the jet carries a set of jet energy correction factors with the given label

Definition at line 135 of file Jet.h.

References jec_.

135 { return (set < jec_.size()); };
std::vector< pat::JetCorrFactors > jec_
Definition: Jet.h:622

◆ jecSetsAvailable()

bool pat::Jet::jecSetsAvailable ( ) const
inline

returns true if the jet carries jet energy correction information at all

Definition at line 129 of file Jet.h.

References jec_.

Referenced by chargedEmEnergyFraction(), chargedHadronEnergyFraction(), chargedMuEnergyFraction(), electronEnergyFraction(), HFEMEnergyFraction(), HFHadronEnergyFraction(), hoEnergyFraction(), muonEnergyFraction(), neutralEmEnergyFraction(), neutralHadronEnergyFraction(), and photonEnergyFraction().

129 { return !jec_.empty(); }
std::vector< pat::JetCorrFactors > jec_
Definition: Jet.h:622

◆ jetCharge()

float pat::Jet::jetCharge ( ) const

method to return the JetCharge computed when creating the Jet

◆ jetFlavourInfo()

const reco::JetFlavourInfo& pat::Jet::jetFlavourInfo ( ) const

return the JetFlavourInfo of the jet

◆ jetID()

reco::JetID const& pat::Jet::jetID ( ) const
inline

accessing Jet ID information

Definition at line 506 of file Jet.h.

References jetID_.

Referenced by Jet.Jet::jetID(), Jet.Jet::looseJetId(), and main().

506 { return jetID_; }
reco::JetID jetID_
Definition: Jet.h:651

◆ jptSpecific()

const JPTSpecific& pat::Jet::jptSpecific ( ) const
inline

retrieve the jpt specific part of the jet

Definition at line 285 of file Jet.h.

References specificJPT_.

Referenced by chargedHadronEnergy(), elecMultiplicity(), elecsInVertexInCalo(), elecsInVertexOutCalo(), elecsOutVertexInCalo(), muonsInVertexInCalo(), muonsInVertexOutCalo(), muonsOutVertexInCalo(), pionsInVertexInCalo(), pionsInVertexOutCalo(), pionsOutVertexInCalo(), and zspCorrection().

285  {
286  if (specificJPT_.empty())
287  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet.\n";
288  return specificJPT_[0];
289  }
std::vector< JPTSpecific > specificJPT_
Definition: Jet.h:647

◆ maxEInEmTowers()

float pat::Jet::maxEInEmTowers ( ) const
inline

returns the maximum energy deposited in ECAL towers

Definition at line 320 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mMaxEInEmTowers.

320 { return caloSpecific().mMaxEInEmTowers; }
float mMaxEInEmTowers
Maximum energy in EM towers.
Definition: CaloJet.h:48
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ maxEInHadTowers()

float pat::Jet::maxEInHadTowers ( ) const
inline

returns the maximum energy deposited in HCAL towers

Definition at line 322 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mMaxEInHadTowers.

322 { return caloSpecific().mMaxEInHadTowers; }
float mMaxEInHadTowers
Maximum energy in HCAL towers.
Definition: CaloJet.h:50
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279

◆ muonEnergy()

float pat::Jet::muonEnergy ( ) const
inline

muonEnergy

Definition at line 430 of file Jet.h.

References reco::PFJet::Specific::mMuonEnergy, and pfSpecific().

Referenced by PFJetIDSelectionFunctor::firstDataCuts(), Jet.Jet::jetID(), Jet.Jet::muonEnergyFraction(), and muonEnergyFraction().

430 { return pfSpecific().mMuonEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293

◆ muonEnergyFraction()

float pat::Jet::muonEnergyFraction ( ) const
inline

muonEnergyFraction (relative to corrected jet energy)

Definition at line 432 of file Jet.h.

References reco::LeafCandidate::energy(), jecFactor(), jecSetsAvailable(), and muonEnergy().

Referenced by CombinedSVComputer::fillCommonVariables(), and PFJetIDSelectionFunctor::firstDataCuts().

432 { return muonEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy()); }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
float muonEnergy() const
muonEnergy
Definition: Jet.h:430
bool jecSetsAvailable() const
Definition: Jet.h:129
double energy() const final
energy

◆ muonMultiplicity()

int pat::Jet::muonMultiplicity ( ) const
inline

muonMultiplicity

Definition at line 736 of file Jet.h.

References Exception.

Referenced by CombinedSVComputer::fillCommonVariables().

736  {
737  if (isPFJet()) {
738  return pfSpecific().mMuonMultiplicity;
739  } else if (isJPTJet()) {
741  } else {
742  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
743  }
744 }
reco::TrackRefVector muonsInVertexOutCalo
Definition: JPTJet.h:54
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
reco::TrackRefVector muonsInVertexInCalo
Definition: JPTJet.h:53
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275
size_type size() const
Size of the RefVector.
Definition: RefVector.h:102

◆ muonsInVertexInCalo()

const reco::TrackRefVector& pat::Jet::muonsInVertexInCalo ( ) const
inline

muons fully contained in cone

Definition at line 366 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::muonsInVertexInCalo.

366 { return jptSpecific().muonsInVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector muonsInVertexInCalo
Definition: JPTJet.h:53

◆ muonsInVertexOutCalo()

const reco::TrackRefVector& pat::Jet::muonsInVertexOutCalo ( ) const
inline

muons that curled out

Definition at line 368 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::muonsInVertexOutCalo.

368 { return jptSpecific().muonsInVertexOutCalo; }
reco::TrackRefVector muonsInVertexOutCalo
Definition: JPTJet.h:54
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285

◆ muonsOutVertexInCalo()

const reco::TrackRefVector& pat::Jet::muonsOutVertexInCalo ( ) const
inline

muons that curled in

Definition at line 370 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::muonsOutVertexInCalo.

370 { return jptSpecific().muonsOutVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector muonsOutVertexInCalo
Definition: JPTJet.h:55

◆ n60()

int pat::Jet::n60 ( ) const
inline

returns the number of constituents carrying a 60% of the total Jet energy*/

Definition at line 346 of file Jet.h.

References reco::Jet::nCarrying().

346 { return nCarrying(0.6); }
int nCarrying(float fFraction) const
return # of constituent carrying fraction of energy

◆ n90()

int pat::Jet::n90 ( ) const
inline

returns the number of constituents carrying a 90% of the total Jet energy*/

Definition at line 344 of file Jet.h.

References reco::Jet::nCarrying().

344 { return nCarrying(0.9); }
int nCarrying(float fFraction) const
return # of constituent carrying fraction of energy

◆ neutralEmEnergy()

float pat::Jet::neutralEmEnergy ( ) const
inline

neutralEmEnergy

Definition at line 726 of file Jet.h.

References Exception.

Referenced by PileupJetIdAlgo::computeIdVariables(), PFJetIDSelectionFunctor::firstDataCuts(), Jet.Jet::jetID(), Jet.Jet::neutralEmEnergyFraction(), and neutralEmEnergyFraction().

726  {
727  if (isPFJet()) {
728  return pfSpecific().mNeutralEmEnergy;
729  } else if (isJPTJet()) {
730  return jptSpecific().mNeutralEmEnergy;
731  } else {
732  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
733  }
734 }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
float mNeutralEmEnergy
Definition: JPTJet.h:62
float mNeutralEmEnergy
Definition: PFJet.h:71
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275

◆ neutralEmEnergyFraction()

float pat::Jet::neutralEmEnergyFraction ( ) const
inline

neutralEmEnergyFraction (relative to uncorrected jet energy)

Definition at line 412 of file Jet.h.

References reco::LeafCandidate::energy(), jecFactor(), jecSetsAvailable(), and neutralEmEnergy().

Referenced by SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), PFJetIDSelectionFunctor::firstDataCuts(), and main().

412  {
413  return neutralEmEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
414  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float neutralEmEnergy() const
neutralEmEnergy
Definition: Jet.h:726
double energy() const final
energy

◆ neutralHadronEnergy()

float pat::Jet::neutralHadronEnergy ( ) const
inline

neutralHadronEnergy

Definition at line 706 of file Jet.h.

References Exception.

Referenced by PileupJetIdAlgo::computeIdVariables(), PFJetIDSelectionFunctor::firstDataCuts(), Jet.Jet::jetID(), Jet.Jet::neutralHadronEnergyFraction(), and neutralHadronEnergyFraction().

706  {
707  if (isPFJet()) {
709  } else if (isJPTJet()) {
711  } else {
712  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n";
713  }
714 }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
bool isJPTJet() const
check to see if the jet is a reco::JPTJet
Definition: Jet.h:273
float mNeutralHadronEnergy
Definition: PFJet.h:52
float mNeutralHadronEnergy
Definition: JPTJet.h:60
bool isPFJet() const
check to see if the jet is a reco::PFJet
Definition: Jet.h:275

◆ neutralHadronEnergyFraction()

float pat::Jet::neutralHadronEnergyFraction ( ) const
inline

neutralHadronEnergyFraction (relative to uncorrected jet energy)

Definition at line 404 of file Jet.h.

References reco::LeafCandidate::energy(), jecFactor(), jecSetsAvailable(), and neutralHadronEnergy().

Referenced by SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), CombinedSVComputer::fillCommonVariables(), PFJetIDSelectionFunctor::firstDataCuts(), and main().

404  {
405  return neutralHadronEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
406  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float neutralHadronEnergy() const
neutralHadronEnergy
Definition: Jet.h:706
double energy() const final
energy

◆ neutralHadronMultiplicity()

int pat::Jet::neutralHadronMultiplicity ( ) const
inline

neutralHadronMultiplicity

Definition at line 447 of file Jet.h.

References reco::PFJet::Specific::mNeutralHadronMultiplicity, and pfSpecific().

Referenced by CombinedSVComputer::fillCommonVariables().

const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
int mNeutralHadronMultiplicity
Definition: PFJet.h:60

◆ neutralMultiplicity()

int pat::Jet::neutralMultiplicity ( ) const
inline

◆ nSubjetCollections()

unsigned int pat::Jet::nSubjetCollections ( ) const
inline

Number of subjet collections.

Definition at line 563 of file Jet.h.

References subjetCollections_.

Referenced by groomedMass().

563 { return subjetCollections_.size(); }
std::vector< pat::JetPtrCollection > subjetCollections_
Definition: Jet.h:606

◆ numberOfDaughters()

size_t pat::Jet::numberOfDaughters ( ) const
overridevirtual

Return number of daughters: If using refactorized PAT, return that. (constituents size > 0) Else check the old version of PAT (embedded constituents size > 0) Else return the reco Jet number of constituents

Reimplemented from reco::CompositePtrCandidate.

Referenced by BetaStarVarProducer< T >::calculateCHSEnergies().

◆ partonFlavour()

int pat::Jet::partonFlavour ( ) const

return the parton-based flavour of the jet

Referenced by TtDilepLRSignalSelObservables::operator()().

◆ pfCandidatesFwdPtr()

reco::PFCandidateFwdPtrVector const& pat::Jet::pfCandidatesFwdPtr ( ) const
inline

Definition at line 510 of file Jet.h.

References pfCandidatesFwdPtr_.

510 { return pfCandidatesFwdPtr_; }
reco::PFCandidateFwdPtrVector pfCandidatesFwdPtr_
Definition: Jet.h:603

◆ pfSpecific()

const PFSpecific& pat::Jet::pfSpecific ( ) const
inline

retrieve the pf specific part of the jet

Definition at line 293 of file Jet.h.

References specificPF_.

Referenced by chargedHadronEnergy(), chargedHadronMultiplicity(), chargedMuEnergy(), electronEnergy(), electronMultiplicity(), HFEMEnergy(), HFEMMultiplicity(), HFHadronEnergy(), HFHadronMultiplicity(), hoEnergy(), muonEnergy(), neutralHadronMultiplicity(), neutralMultiplicity(), photonEnergy(), and photonMultiplicity().

293  {
294  if (specificPF_.empty())
295  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a PFJet.\n";
296  return specificPF_[0];
297  }
std::vector< PFSpecific > specificPF_
Definition: Jet.h:648

◆ photonEnergy()

float pat::Jet::photonEnergy ( ) const
inline

photonEnergy

Definition at line 418 of file Jet.h.

References reco::PFJet::Specific::mPhotonEnergy, and pfSpecific().

Referenced by Jet.Jet::photonEnergyFraction(), and photonEnergyFraction().

418 { return pfSpecific().mPhotonEnergy; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
float mPhotonEnergy
Definition: PFJet.h:53

◆ photonEnergyFraction()

float pat::Jet::photonEnergyFraction ( ) const
inline

photonEnergyFraction (relative to corrected jet energy)

Definition at line 420 of file Jet.h.

References reco::LeafCandidate::energy(), jecFactor(), jecSetsAvailable(), and photonEnergy().

Referenced by CombinedSVComputer::fillCommonVariables().

420  {
421  return photonEnergy() / ((jecSetsAvailable() ? jecFactor(0) : 1.) * energy());
422  }
float jecFactor(const std::string &level, const std::string &flavor="none", const std::string &set="") const
bool jecSetsAvailable() const
Definition: Jet.h:129
float photonEnergy() const
photonEnergy
Definition: Jet.h:418
double energy() const final
energy

◆ photonMultiplicity()

int pat::Jet::photonMultiplicity ( ) const
inline

photonMultiplicity

Definition at line 449 of file Jet.h.

References reco::PFJet::Specific::mPhotonMultiplicity, and pfSpecific().

Referenced by CombinedSVComputer::fillCommonVariables().

449 { return pfSpecific().mPhotonMultiplicity; }
const PFSpecific & pfSpecific() const
retrieve the pf specific part of the jet
Definition: Jet.h:293
int mPhotonMultiplicity
Definition: PFJet.h:61

◆ pionsInVertexInCalo()

const reco::TrackRefVector& pat::Jet::pionsInVertexInCalo ( ) const
inline

pions fully contained in cone

Definition at line 360 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::pionsInVertexInCalo.

360 { return jptSpecific().pionsInVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector pionsInVertexInCalo
Definition: JPTJet.h:50

◆ pionsInVertexOutCalo()

const reco::TrackRefVector& pat::Jet::pionsInVertexOutCalo ( ) const
inline

pions that curled out

Definition at line 362 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::pionsInVertexOutCalo.

362 { return jptSpecific().pionsInVertexOutCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector pionsInVertexOutCalo
Definition: JPTJet.h:51

◆ pionsOutVertexInCalo()

const reco::TrackRefVector& pat::Jet::pionsOutVertexInCalo ( ) const
inline

pions that curled in

Definition at line 364 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::pionsOutVertexInCalo.

364 { return jptSpecific().pionsOutVertexInCalo; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285
reco::TrackRefVector pionsOutVertexInCalo
Definition: JPTJet.h:52

◆ scaleEnergy() [1/2]

void pat::Jet::scaleEnergy ( double  fScale)
inlineoverridevirtual

Scale energy and correspondingly adjust raw jec factors.

Reimplemented from reco::Jet.

Definition at line 177 of file Jet.h.

References scaleEnergy().

Referenced by hitfit::JetTranslatorBase< pat::Jet >::operator()(), JetEnergyShift::produce(), and scaleEnergy().

177 { scaleEnergy(fScale, "Unscaled"); }
void scaleEnergy(double fScale) override
Scale energy and correspondingly adjust raw jec factors.
Definition: Jet.h:177

◆ scaleEnergy() [2/2]

void pat::Jet::scaleEnergy ( double  fScale,
const std::string &  level 
)

◆ setAssociatedTracks()

void pat::Jet::setAssociatedTracks ( const reco::TrackRefVector tracks)

method to set the vector of refs to the tracks associated to this jet

Referenced by pat::PATJetProducer::produce().

◆ setCaloSpecific()

void pat::Jet::setCaloSpecific ( const CaloSpecific newCaloSpecific)
inline

set the calo specific part of the jet

Definition at line 299 of file Jet.h.

References specificCalo_.

299  {
300  if (specificCalo_.empty())
301  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a CaloJet.\n";
302  specificCalo_[0] = newCaloSpecific;
303  }
std::vector< CaloSpecific > specificCalo_
Definition: Jet.h:646

◆ setCaloTowers()

void pat::Jet::setCaloTowers ( const CaloTowerFwdPtrCollection caloTowers)

method to store the CaloJet constituents internally

Referenced by pat::PATJetProducer::produce().

◆ setGenJetRef()

void pat::Jet::setGenJetRef ( const edm::FwdRef< reco::GenJetCollection > &  gj)

method to set the matched generated jet reference, embedding if requested

Referenced by pat::PATJetProducer::produce().

◆ setGenParton()

void pat::Jet::setGenParton ( const reco::GenParticleRef gp,
bool  embed = false 
)
inline

method to set the matched parton

Definition at line 255 of file Jet.h.

References embed, runTauDisplay::gp, and pat::PATObject< reco::Jet >::setGenParticleRef().

Referenced by pat::PATJetProducer::produce().

void setGenParticleRef(const reco::GenParticleRef &ref, bool embed=false)
Set the generator level particle reference.
Definition: PATObject.h:743
#define embed
Definition: AMPTWrapper.h:188

◆ setHadronFlavour()

void pat::Jet::setHadronFlavour ( int  hadronFl)

method to set the hadron-based flavour of the jet

Referenced by pat::PATJetProducer::produce().

◆ setJetCharge()

void pat::Jet::setJetCharge ( float  jetCharge)

method to set the jet charge

Referenced by pat::PATJetProducer::produce().

◆ setJetFlavourInfo()

void pat::Jet::setJetFlavourInfo ( const reco::JetFlavourInfo jetFlavourInfo)

method to set the JetFlavourInfo of the jet

Referenced by pat::PATJetProducer::produce().

◆ setJetID()

void pat::Jet::setJetID ( reco::JetID const &  id)
inline

methods for jet ID

Definition at line 266 of file Jet.h.

References triggerObjects_cff::id, and jetID_.

Referenced by pat::PATJetProducer::produce().

266 { jetID_ = id; }
reco::JetID jetID_
Definition: Jet.h:651

◆ setJPTSpecific()

void pat::Jet::setJPTSpecific ( const JPTSpecific newJPTSpecific)
inline

set the jpt specific part of the jet

Definition at line 305 of file Jet.h.

References specificJPT_.

305  {
306  if (specificJPT_.empty())
307  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet.\n";
308  specificJPT_[0] = newJPTSpecific;
309  }
std::vector< JPTSpecific > specificJPT_
Definition: Jet.h:647

◆ setPartonFlavour()

void pat::Jet::setPartonFlavour ( int  partonFl)

method to set the parton-based flavour of the jet

Referenced by pat::PATJetProducer::produce().

◆ setPFCandidates()

void pat::Jet::setPFCandidates ( const PFCandidateFwdPtrCollection pfCandidates)

method to store the PFCandidate constituents internally

Referenced by pat::PATJetProducer::produce().

◆ setPFSpecific()

void pat::Jet::setPFSpecific ( const PFSpecific newPFSpecific)
inline

set the pf specific part of the jet

Definition at line 311 of file Jet.h.

References specificPF_.

311  {
312  if (specificPF_.empty())
313  throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a PFJet.\n";
314  specificPF_[0] = newPFSpecific;
315  }
std::vector< PFSpecific > specificPF_
Definition: Jet.h:648

◆ subjetCollectionNames()

std::vector<std::string> const& pat::Jet::subjetCollectionNames ( ) const
inline

Subjet collection names.

Definition at line 566 of file Jet.h.

References subjetLabels_.

Referenced by TemplatedSecondaryVertexProducer< IPTI, VTX >::matchSubjets().

566 { return subjetLabels_; }
std::vector< std::string > subjetLabels_
Definition: Jet.h:607

◆ subjets() [1/2]

pat::JetPtrCollection const& pat::Jet::subjets ( unsigned int  index = 0) const

◆ subjets() [2/2]

pat::JetPtrCollection const& pat::Jet::subjets ( std::string const &  label) const

String access to subjet list.

◆ tagInfo()

const reco::BaseTagInfo* pat::Jet::tagInfo ( const std::string &  label) const

get a tagInfo with the given name, or NULL if none is found. You should omit the 'TagInfos' part from the label

Referenced by hasTagInfo(), and tagInfoByTypeOrLabel().

◆ tagInfoBoostedDoubleSV()

const reco::BoostedDoubleSVTagInfo* pat::Jet::tagInfoBoostedDoubleSV ( const std::string &  label = "") const

◆ tagInfoByType()

template<typename T >
const T* pat::Jet::tagInfoByType ( ) const
inlineprivate

Definition at line 659 of file Jet.h.

References mps_fire::i, dqmiodumpmetadata::n, edm::OwnVector< T, P >::size(), tagInfos_, tagInfosFwdPtr_, and heppy_batch::val.

659  {
660  // First check the factorized PAT version
661  for (size_t i = 0, n = tagInfosFwdPtr_.size(); i < n; ++i) {
663  reco::BaseTagInfo const* baseTagInfo = val.get();
664  if (typeid(*baseTagInfo) == typeid(T)) {
665  return static_cast<const T*>(baseTagInfo);
666  }
667  }
668  // Then check compatibility version
669  for (size_t i = 0, n = tagInfos_.size(); i < n; ++i) {
671  reco::BaseTagInfo const* baseTagInfo = &val;
672  if (typeid(*baseTagInfo) == typeid(T)) {
673  return static_cast<const T*>(baseTagInfo);
674  }
675  }
676  return nullptr;
677  }
TagInfoFwdPtrCollection tagInfosFwdPtr_
Definition: Jet.h:637
edm::OwnVector< reco::BaseTagInfo > tagInfos_
Definition: Jet.h:636
size_type size() const
Definition: OwnVector.h:300
long double T

◆ tagInfoByTypeOrLabel()

template<typename T >
const T* pat::Jet::tagInfoByTypeOrLabel ( const std::string &  label = "") const
inlineprivate

Definition at line 680 of file Jet.h.

References label, and tagInfo().

680  {
681  return (label.empty() ? tagInfoByType<T>() : dynamic_cast<const T*>(tagInfo(label)));
682  }
const reco::BaseTagInfo * tagInfo(const std::string &label) const
char const * label

◆ tagInfoCandIP()

const reco::CandIPTagInfo* pat::Jet::tagInfoCandIP ( const std::string &  label = "") const

get a tagInfo with the given name and type or NULL if none is found. If the label is empty or not specified, it returns the first tagInfo of that type (if any one exists) you should omit the 'TagInfos' part from the label

◆ tagInfoCandSecondaryVertex()

const reco::CandSecondaryVertexTagInfo* pat::Jet::tagInfoCandSecondaryVertex ( const std::string &  label = "") const

get a tagInfo with the given name and type or NULL if none is found. If the label is empty or not specified, it returns the first tagInfo of that type (if any one exists) you should omit the 'TagInfos' part from the label

◆ tagInfoCandSoftLepton()

const reco::CandSoftLeptonTagInfo* pat::Jet::tagInfoCandSoftLepton ( const std::string &  label = "") const

get a tagInfo with the given name and type or NULL if none is found. If the label is empty or not specified, it returns the first tagInfo of that type (if any one exists) you should omit the 'TagInfos' part from the label

◆ tagInfoLabels()

std::vector<std::string> const& pat::Jet::tagInfoLabels ( ) const
inline

get list of tag info labels

Definition at line 205 of file Jet.h.

References tagInfoLabels_.

205 { return tagInfoLabels_; }
std::vector< std::string > tagInfoLabels_
Definition: Jet.h:635

◆ tagInfoPixelCluster()

const reco::PixelClusterTagInfo* pat::Jet::tagInfoPixelCluster ( const std::string &  label = "") const

get a tagInfo with the given name and type or NULL if none is found. If the label is empty or not specified, it returns the first tagInfo of that type (if any one exists) you should omit the 'TagInfos' part from the label

◆ tagInfoSecondaryVertex()

const reco::SecondaryVertexTagInfo* pat::Jet::tagInfoSecondaryVertex ( const std::string &  label = "") const

◆ tagInfosFwdPtr()

TagInfoFwdPtrCollection const& pat::Jet::tagInfosFwdPtr ( ) const
inline

Definition at line 512 of file Jet.h.

References tagInfosFwdPtr_.

512 { return tagInfosFwdPtr_; }
TagInfoFwdPtrCollection tagInfosFwdPtr_
Definition: Jet.h:637

◆ tagInfoSoftLepton()

const reco::SoftLeptonTagInfo* pat::Jet::tagInfoSoftLepton ( const std::string &  label = "") const

◆ tagInfoTrackIP()

const reco::TrackIPTagInfo* pat::Jet::tagInfoTrackIP ( const std::string &  label = "") const

◆ towersArea()

float pat::Jet::towersArea ( ) const
inline

returns area of contributing towers

Definition at line 342 of file Jet.h.

References caloSpecific(), and reco::CaloJet::Specific::mTowersArea.

342 { return caloSpecific().mTowersArea; }
const CaloSpecific & caloSpecific() const
retrieve the calo specific part of the jet
Definition: Jet.h:279
float mTowersArea
Area of contributing CaloTowers.
Definition: CaloJet.h:70

◆ tryImportSpecific()

void pat::Jet::tryImportSpecific ( const reco::Jet source)
private

◆ updateFwdCaloTowerFwdPtr()

void pat::Jet::updateFwdCaloTowerFwdPtr ( unsigned int  index,
const edm::Ptr< CaloTower > &  updateFwd 
)
inline

Update bare FwdPtr and FwdRef "forward" pointers while keeping the "back" pointers the same (i.e. the ref "forwarding")

Definition at line 516 of file Jet.h.

References caloTowersFwdPtr_, and Exception.

516  {
517  if (index < caloTowersFwdPtr_.size()) {
519  } else {
520  throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
521  }
522  }
CaloTowerFwdPtrVector caloTowersFwdPtr_
Definition: Jet.h:598
unsigned int index
Definition: LeafCandidate.h:31

◆ updateFwdGenJetFwdRef()

void pat::Jet::updateFwdGenJetFwdRef ( edm::Ref< reco::GenJetCollection updateRef)
inline

Definition at line 541 of file Jet.h.

References edm::FwdRef< C, T, F >::backRef(), and genJetFwdRef_.

541  {
543  }
edm::FwdRef< reco::GenJetCollection > genJetFwdRef_
Definition: Jet.h:614
Ref< C, T, F > const & backRef() const
Definition: FwdRef.h:172

◆ updateFwdPFCandidateFwdPtr()

void pat::Jet::updateFwdPFCandidateFwdPtr ( unsigned int  index,
const edm::Ptr< reco::PFCandidate > &  updateFwd 
)
inline

Definition at line 524 of file Jet.h.

References Exception, and pfCandidatesFwdPtr_.

524  {
525  if (index < pfCandidatesFwdPtr_.size()) {
528  } else {
529  throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
530  }
531  }
unsigned int index
Definition: LeafCandidate.h:31
reco::PFCandidateFwdPtrVector pfCandidatesFwdPtr_
Definition: Jet.h:603

◆ updateFwdTagInfoFwdPtr()

void pat::Jet::updateFwdTagInfoFwdPtr ( unsigned int  index,
const edm::Ptr< reco::BaseTagInfo > &  updateFwd 
)
inline

Definition at line 533 of file Jet.h.

References Exception, and tagInfosFwdPtr_.

533  {
534  if (index < tagInfosFwdPtr_.size()) {
536  } else {
537  throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
538  }
539  }
TagInfoFwdPtrCollection tagInfosFwdPtr_
Definition: Jet.h:637
unsigned int index
Definition: LeafCandidate.h:31

◆ zspCorrection()

const float& pat::Jet::zspCorrection ( ) const
inline

zero suppression correction

Definition at line 378 of file Jet.h.

References jptSpecific(), and reco::JPTJet::Specific::mZSPCor.

378 { return jptSpecific().mZSPCor; }
const JPTSpecific & jptSpecific() const
retrieve the jpt specific part of the jet
Definition: Jet.h:285

Friends And Related Function Documentation

◆ PATJetProducer

friend class PATJetProducer
friend

make friends with PATJetProducer so that it can set the an initial jet energy scale unequal to raw calling the private initializeJEC function, which should be non accessible to any other user

Definition at line 81 of file Jet.h.

◆ PATJetSlimmer

friend class PATJetSlimmer
friend

Definition at line 82 of file Jet.h.

◆ PATJetUpdater

friend class PATJetUpdater
friend

Definition at line 83 of file Jet.h.

◆ reco::operator<<

std::ostream& reco::operator<< ( std::ostream &  out,
const pat::Jet obj 
)
friend

pipe operator (introduced to use pat::Jet with PFTopProjectors)

Member Data Documentation

◆ associatedTracks_

reco::TrackRefVector pat::Jet::associatedTracks_
protected

Definition at line 642 of file Jet.h.

◆ caloTowers_

CaloTowerCollection pat::Jet::caloTowers_
protected

Definition at line 597 of file Jet.h.

◆ caloTowersFwdPtr_

CaloTowerFwdPtrVector pat::Jet::caloTowersFwdPtr_
protected

Definition at line 598 of file Jet.h.

Referenced by caloTowersFwdPtr(), and updateFwdCaloTowerFwdPtr().

◆ caloTowersTemp_

edm::AtomicPtrCache<std::vector<CaloTowerPtr> > pat::Jet::caloTowersTemp_
protected

Definition at line 596 of file Jet.h.

◆ currentJECFlavor_

JetCorrFactors::Flavor pat::Jet::currentJECFlavor_
protected

Definition at line 630 of file Jet.h.

Referenced by currentJECFlavor().

◆ currentJECLevel_

unsigned int pat::Jet::currentJECLevel_
protected

Definition at line 627 of file Jet.h.

Referenced by currentJECLevel().

◆ currentJECSet_

unsigned int pat::Jet::currentJECSet_
protected

Definition at line 625 of file Jet.h.

Referenced by currentJECLevel(), and currentJECSet().

◆ daughtersTemp_

edm::AtomicPtrCache<std::vector<reco::CandidatePtr> > pat::Jet::daughtersTemp_
protected

Definition at line 608 of file Jet.h.

Referenced by clearDaughters().

◆ embeddedCaloTowers_

bool pat::Jet::embeddedCaloTowers_
protected

Definition at line 595 of file Jet.h.

◆ embeddedPFCandidates_

bool pat::Jet::embeddedPFCandidates_
protected

Definition at line 600 of file Jet.h.

◆ genJet_

std::vector<reco::GenJet> pat::Jet::genJet_
protected

Definition at line 612 of file Jet.h.

◆ genJetFwdRef_

edm::FwdRef<reco::GenJetCollection> pat::Jet::genJetFwdRef_
protected

Definition at line 614 of file Jet.h.

Referenced by genJetFwdRef(), and updateFwdGenJetFwdRef().

◆ genJetRef_

reco::GenJetRefVector pat::Jet::genJetRef_
protected

Definition at line 613 of file Jet.h.

◆ jec_

std::vector<pat::JetCorrFactors> pat::Jet::jec_
protected

◆ jetCharge_

float pat::Jet::jetCharge_
protected

Definition at line 641 of file Jet.h.

◆ jetFlavourInfo_

reco::JetFlavourInfo pat::Jet::jetFlavourInfo_
protected

Definition at line 615 of file Jet.h.

◆ jetID_

reco::JetID pat::Jet::jetID_
protected

Definition at line 651 of file Jet.h.

Referenced by jetID(), and setJetID().

◆ pairDiscriVector_

std::vector<std::pair<std::string, float> > pat::Jet::pairDiscriVector_
protected

Definition at line 634 of file Jet.h.

◆ pfCandidates_

reco::PFCandidateCollection pat::Jet::pfCandidates_
protected

Definition at line 602 of file Jet.h.

◆ pfCandidatesFwdPtr_

reco::PFCandidateFwdPtrVector pat::Jet::pfCandidatesFwdPtr_
protected

Definition at line 603 of file Jet.h.

Referenced by pfCandidatesFwdPtr(), and updateFwdPFCandidateFwdPtr().

◆ pfCandidatesTemp_

edm::AtomicPtrCache<std::vector<reco::PFCandidatePtr> > pat::Jet::pfCandidatesTemp_
protected

Definition at line 601 of file Jet.h.

◆ specificCalo_

std::vector<CaloSpecific> pat::Jet::specificCalo_
protected

Definition at line 646 of file Jet.h.

Referenced by caloSpecific(), isCaloJet(), and setCaloSpecific().

◆ specificJPT_

std::vector<JPTSpecific> pat::Jet::specificJPT_
protected

Definition at line 647 of file Jet.h.

Referenced by isJPTJet(), jptSpecific(), and setJPTSpecific().

◆ specificPF_

std::vector<PFSpecific> pat::Jet::specificPF_
protected

Definition at line 648 of file Jet.h.

Referenced by hasPFSpecific(), isPFJet(), pfSpecific(), and setPFSpecific().

◆ subjetCollections_

std::vector<pat::JetPtrCollection> pat::Jet::subjetCollections_
protected

Definition at line 606 of file Jet.h.

Referenced by nSubjetCollections().

◆ subjetLabels_

std::vector<std::string> pat::Jet::subjetLabels_
protected

Definition at line 607 of file Jet.h.

Referenced by hasSubjets(), and subjetCollectionNames().

◆ tagInfoLabels_

std::vector<std::string> pat::Jet::tagInfoLabels_
protected

Definition at line 635 of file Jet.h.

Referenced by tagInfoLabels().

◆ tagInfos_

edm::OwnVector<reco::BaseTagInfo> pat::Jet::tagInfos_
protected

Definition at line 636 of file Jet.h.

Referenced by tagInfoByType().

◆ tagInfosFwdPtr_

TagInfoFwdPtrCollection pat::Jet::tagInfosFwdPtr_
protected

Definition at line 637 of file Jet.h.

Referenced by tagInfoByType(), tagInfosFwdPtr(), and updateFwdTagInfoFwdPtr().