pat::Jet Class Reference

Analysis-level calorimeter jet class. More...

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

Inheritance diagram for pat::Jet:

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::TrackRefVector &	associatedTracks () 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 CaloSpecific &	caloSpecific () 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...
Jet *	clone () 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::Candidate *	daughter (size_t i) const override
reco::CandidatePtr	daughterPtr (size_t i) const override
	reference to daughter at given position More...
const reco::CompositePtrCandidate::daughters &	daughterPtrVector () const override
	references to daughtes More...
float	elecMultiplicity () const
	chargedMultiplicity More...
const reco::TrackRefVector &	elecsInVertexInCalo () const
	electrons fully contained in cone More...
const reco::TrackRefVector &	elecsInVertexOutCalo () const
	electrons that curled out More...
const reco::TrackRefVector &	elecsOutVertexInCalo () 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::GenJet *	genJet () const
	return the matched generated jet More...
edm::FwdRef< reco::GenJetCollection > const &	genJetFwdRef () const
const reco::GenParticle *	genParton () 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::JetFlavourInfo &	jetFlavourInfo () const
	return the JetFlavourInfo of the jet More...
reco::JetID const &	jetID () const
	accessing Jet ID information More...
const JPTSpecific &	jptSpecific () 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::TrackRefVector &	muonsInVertexInCalo () const
	muons fully contained in cone More...
const reco::TrackRefVector &	muonsInVertexOutCalo () const
	muons that curled out More...
const reco::TrackRefVector &	muonsOutVertexInCalo () 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 PFSpecific &	pfSpecific () 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::TrackRefVector &	pionsInVertexInCalo () const
	pions fully contained in cone More...
const reco::TrackRefVector &	pionsInVertexOutCalo () const
	pions that curled out More...
const reco::TrackRefVector &	pionsOutVertexInCalo () const
	pions that curled in More...
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::BaseTagInfo *	tagInfo (const std::string &label) const
const reco::BoostedDoubleSVTagInfo *	tagInfoBoostedDoubleSV (const std::string &label="") const
const reco::CandIPTagInfo *	tagInfoCandIP (const std::string &label="") const
const reco::CandSecondaryVertexTagInfo *	tagInfoCandSecondaryVertex (const std::string &label="") const
const reco::CandSoftLeptonTagInfo *	tagInfoCandSoftLepton (const std::string &label="") const
std::vector< std::string > const &	tagInfoLabels () const
	get list of tag info labels More...
const reco::SecondaryVertexTagInfo *	tagInfoSecondaryVertex (const std::string &label="") const
TagInfoFwdPtrCollection const &	tagInfosFwdPtr () const
const reco::SoftLeptonTagInfo *	tagInfoSoftLepton (const std::string &label="") const
const reco::TrackIPTagInfo *	tagInfoTrackIP (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::LookupTableRecord &	efficiency (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::GenParticle *	genParticle (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::GenParticleRef >	genParticleRefs () const
size_t	genParticlesSize () const
	Number of generator level particles stored as ref or embedded. More...
const pat::CandKinResolution &	getKinResolution (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::Candidate *	originalObject () 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::CandidatePtrVector &	overlaps (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 TriggerObjectStandAlone *	triggerObjectMatch (const size_t idx=0) const
	get one matched trigger object by index More...
const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByCollection (const std::string &coll, const size_t idx=0) const
	get one matched trigger object from a certain collection by index More...
const TriggerObjectStandAlone *	triggerObjectMatchByCollection (const char *coll, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByCondition (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 TriggerObjectStandAlone *	triggerObjectMatchByCondition (const char *nameCondition, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByFilter (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 TriggerObjectStandAlone *	triggerObjectMatchByFilter (const char *labelFilter, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByFilterID (const unsigned triggerObjectType, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
const TriggerObjectStandAlone *	triggerObjectMatchByType (const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
	get one matched trigger object of a certain type by index More...
const TriggerObjectStandAlone *	triggerObjectMatchByType (const unsigned triggerObjectType, const size_t idx=0) const
const TriggerObjectStandAloneCollection &	triggerObjectMatches () 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 T *	userData (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
	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	scaleEnergy (double fScale)
	scale energy of the jet 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...
Candidate *	daughter (size_type) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
const Candidate *	mother (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)
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (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 CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () 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 Candidate *	mother (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
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
double	p () const final
	magnitude of momentum vector More...
const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...
int	pdgId () const final
	PDG identifier. More...
double	phi () const final
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () 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 Point &	vertex () 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 Track *	bestTrack () 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::GenJet >	genJet_
edm::FwdRef< reco::GenJetCollection >	genJetFwdRef_
reco::GenJetRefVector	genJetRef_
std::vector< pat::JetCorrFactors >	jec_
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< CaloSpecific >	specificCalo_
std::vector< JPTSpecific >	specificJPT_
std::vector< PFSpecific >	specificPF_
std::vector< pat::JetPtrCollection >	subjetCollections_
std::vector< std::string >	subjetLabels_
std::vector< std::string >	tagInfoLabels_
edm::OwnVector< reco::BaseTagInfo >	tagInfos_
TagInfoFwdPtrCollection	tagInfosFwdPtr_
Protected Attributes inherited from pat::PATObject< reco::Jet >
std::vector< std::string >	efficiencyNames_
	vector of the efficiencies (names) More...
std::vector< pat::LookupTableRecord >	efficiencyValues_
	vector of the efficiencies (values) More...
std::vector< reco::GenParticle >	genParticleEmbedded_
	vector to hold an embedded generator level particle More...
std::vector< reco::GenParticleRef >	genParticleRef_
	Reference to a generator level particle. More...
std::vector< std::string >	kinResolutionLabels_
std::vector< pat::CandKinResolution >	kinResolutions_
	Kinematic resolutions. More...
std::vector< reco::CandidatePtrVector >	overlapItems_
	Overlapping items (sorted by distance) More...
std::vector< std::string >	overlapLabels_
	Overlapping test labels (only if there are any overlaps) More...
edm::Ptr< reco::Candidate >	refToOrig_
TriggerObjectStandAloneCollection	triggerObjectMatchesEmbedded_
	vector of trigger matches More...
std::vector< std::string >	userCandLabels_
std::vector< reco::CandidatePtr >	userCands_
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 JetCorrFactors *	corrFactors_ (const std::string &set) const
	return the jet correction factors of a different set, for systematic studies More...
const JetCorrFactors *	corrFactors_ () 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 T *	tagInfoByType () const
template<typename T >
const T *	tagInfoByTypeOrLabel (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< Candidate >	Constituent
typedef std::vector< Constituent >	Constituents
Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtr >	daughters
	collection of references to daughters More...
typedef std::vector< CandidatePtr >	mothers
	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 80 of file Jet.h.

Constructor & Destructor Documentation

pat::Jet::Jet

(

)

default constructor

pat::Jet::Jet

(

const reco::Jet &

aJet

)

constructor from a reco::Jet

pat::Jet::Jet

(

const edm::RefToBase< reco::Jet > &

aJetRef

)

constructor from ref to reco::Jet

pat::Jet::Jet

(

const edm::Ptr< reco::Jet > &

aJetRef

)

constructor from ref to reco::Jet

pat::Jet::Jet

(

const edm::RefToBase< pat::Jet > &

aJetRef

)

constructure from ref to pat::Jet

pat::Jet::Jet

(

const edm::Ptr< pat::Jet > &

aJetRef

)

constructure from ref to pat::Jet

pat::Jet::~Jet ( )

override

destructor

Member Function Documentation

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().

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

inlineprivate

add more sets of energy correction factors

Definition at line 174 of file Jet.h.

References pat::JetCorrFactors::NONE, and AlCaHLTBitMon_QueryRunRegistry::string.

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

{jec_.push_back(jec); };

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

Add new set of subjets.

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().

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

(

)

const

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

Referenced by main().

const std::vector<std::string> pat::Jet::availableJECLevels

(

const int &

set = 0

)

const

Referenced by PATJetCorrExtractor::operator()().

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

inline

Definition at line 128 of file Jet.h.

References availableJECLevels().

Referenced by availableJECLevels().

{ return availableJECLevels(jecSet(set)); };

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

(

)

const

-— methods for jet corrections -—

returns the labels of all available sets of jet energy corrections

float pat::Jet::bDiscriminator

(

const std::string &

theLabel

)

const

-— methods for accessing b-tagging info -—

get b discriminant from label name

Referenced by AnalysisTasksAnalyzerBTag::analyze(), TtSemiLepJetComb::bTag(), Jet.Jet::btag(), TopSingleLepton_miniAOD::MonitorEnsemble::fill(), SingleTopTChannelLepton_miniAOD::MonitorEnsemble::fill(), bJetSelector::IsbTag(), TtHadLRJetCombObservables::operator()(), TtSemiLRJetCombObservables::operator()(), TtHadLRSignalSelObservables::CompareBdisc::operator()(), and TtSemiLRSignalSelObservables::CompareBdisc::operator()().

void pat::Jet::cacheCaloTowers ( ) const

private

cache calo towers

void pat::Jet::cacheDaughters ( ) const

private

void pat::Jet::cachePFCandidates ( ) const

private

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

inline

retrieve the calo specific part of the jet

Definition at line 259 of file Jet.h.

                                               {
    if (specificCalo_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a CaloJet.\n";
    return specificCalo_[0];
      }

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

inline

Access to bare FwdPtr collections.

Definition at line 466 of file Jet.h.

{ return caloTowersFwdPtr_;}

float pat::Jet::chargedEmEnergy ( ) const

inline

chargedEmEnergy

Definition at line 669 of file Jet.h.

References Exception.

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

{
  if(isPFJet()){ return pfSpecific().mChargedEmEnergy; }
  else if( isJPTJet() ){ return jptSpecific().mChargedEmEnergy;}
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

float pat::Jet::chargedEmEnergyFraction ( ) const

inline

chargedEmEnergyFraction (relative to uncorrected jet energy)

Definition at line 376 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

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

{return chargedEmEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

float pat::Jet::chargedHadronEnergy ( ) const

inline

chargedHadronEnergy

Definition at line 655 of file Jet.h.

References Exception.

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

{
  if(isPFJet()){ return pfSpecific().mChargedHadronEnergy; }
  else if( isJPTJet() ){ return jptSpecific().mChargedHadronEnergy; }
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

float pat::Jet::chargedHadronEnergyFraction ( ) const

inline

chargedHadronEnergyFraction (relative to uncorrected jet energy)

Definition at line 372 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

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

{return chargedHadronEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::chargedHadronMultiplicity ( ) const

inline

chargedHadronMultiplicity

Definition at line 403 of file Jet.h.

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

{return pfSpecific().mChargedHadronMultiplicity;}

float pat::Jet::chargedMuEnergy ( ) const

inline

chargedMuEnergy

Definition at line 417 of file Jet.h.

Referenced by Jet.Jet::chargedMuEnergyFraction().

{return pfSpecific().mChargedMuEnergy;}

float pat::Jet::chargedMuEnergyFraction ( ) const

inline

chargedMuEnergyFraction

Definition at line 419 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

{return chargedMuEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::chargedMultiplicity ( ) const

inline

chargedMultiplicity

Definition at line 690 of file Jet.h.

References Exception.

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

{
  if(isPFJet()){ return pfSpecific().mChargedMultiplicity; }
  else if( isJPTJet() ){ return jptSpecific().muonsInVertexInCalo.size()+jptSpecific().muonsInVertexOutCalo.size()+
                                jptSpecific().pionsInVertexInCalo.size()+jptSpecific().pionsInVertexOutCalo.size()+
                                jptSpecific().elecsInVertexInCalo.size()+jptSpecific().elecsInVertexOutCalo.size();}
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

void pat::Jet::clearDaughters ( )

inlineoverridevirtual

clear daughter references

Reimplemented from reco::CompositePtrCandidate.

Definition at line 456 of file Jet.h.

References slimmedGenJets_cfi::clearDaughters.

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

                                     {
        PATObject<reco::Jet>::clearDaughters();
        daughtersTemp_.reset(); // need to reset daughtersTemp_ as well
      }

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

inlineoverridevirtual

required reimplementation of the Candidate's clone method

Reimplemented from reco::CompositePtrCandidate.

Definition at line 105 of file Jet.h.

References nanoDQM_cfi::Jet.

{ return new Jet(*this); }

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

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

Referenced by PileupJetIdAlgo::computeIdVariables(), TtSemiEvtSolution::getHadb(), TtSemiEvtSolution::getHadp(), TtSemiEvtSolution::getHadq(), TtSemiEvtSolution::getLepb(), StEvtSolution::getRecBottom(), TtHadEvtSolution::getRecHadb(), TtSemiEvtSolution::getRecHadb(), TtHadEvtSolution::getRecHadbbar(), TtHadEvtSolution::getRecHadj(), TtHadEvtSolution::getRecHadk(), TtHadEvtSolution::getRecHadp(), TtSemiEvtSolution::getRecHadp(), TtHadEvtSolution::getRecHadq(), TtSemiEvtSolution::getRecHadq(), TtDilepEvtSolution::getRecJetB(), TtDilepEvtSolution::getRecJetBbar(), TtSemiEvtSolution::getRecLepb(), StEvtSolution::getRecLight(), hitfit::JetTranslatorBase< AJet >::operator()(), PFJetIDSelectionFunctor::operator()(), pat::BadPFCandidateJetsEEnoiseProducer::produce(), PileupJetIdProducer::produce(), and TtFullLepHypothesis::setCandidate().

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

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 158 of file Jet.h.

References reco::LeafCandidate::p4().

Referenced by BetaStarVarProducer< T >::calculateCHSEnergies(), LeptonJetVarProducer< T >::calculatePtRatioRel(), BJetEnergyRegressionVarProducer< T >::calculatePtRatioRel(), BJetEnergyRegressionVarProducer< T >::calculatePtRatioRelSimple(), pat::JetCorrFactorsProducer::evaluate(), pat::RawJetExtractorT< pat::Jet >::operator()(), JetCleanerForType1MET_namespace::RawJetExtractorT< pat::Jet >::operator()(), PFJetMETcorrInputProducer_namespace::RawJetExtractorT< pat::Jet >::operator()(), CaloJetMETcorrInputProducer_namespace::RawJetExtractorT< pat::Jet >::operator()(), PATJetCorrExtractor::operator()(), JetIDSelectionFunctor::operator()(), and pat::PATJetUpdater::produce().

{ return correctedJet(level, flavor, set).p4(); };

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 161 of file Jet.h.

References label, reco::LeafCandidate::p4(), and AlCaHLTBitMon_QueryRunRegistry::string.

{ return correctedJet(level, flavor, set).p4(); };

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

private

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

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

private

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

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

inline

return flavour of the current step of jet energy corrections

Definition at line 143 of file Jet.h.

References hcalDigis_cfi::level, pat::JetCorrFactors::NONE, and AlCaHLTBitMon_QueryRunRegistry::string.

{ return currentJECFlavor_; };

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

inlineprivate

update the current JEC flavor; used by correctedJet

Definition at line 172 of file Jet.h.

{ currentJECFlavor_=flavor; };

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 AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by PFJetIDSelectionFunctor::operator()(), JetIDSelectionFunctor::operator()(), and PatJetAnalyzer::print().

{ return currentJECSet_<jec_.size() ? jec_.at(currentJECSet_).jecLevel(currentJECLevel_) : std::string("ERROR"); };

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

inlineprivate

update the current JEC level; used by correctedJet

Definition at line 170 of file Jet.h.

References hcalDigis_cfi::level.

{ currentJECLevel_=level; };

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

inline

returns the label of the current set of jet energy corrections

Definition at line 139 of file Jet.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

{ return currentJECSet_<jec_.size() ? jec_.at(currentJECSet_).jecSet() : std::string("ERROR"); }

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

inlineprivate

update the current JEC set; used by correctedJet

Definition at line 168 of file Jet.h.

{ currentJECSet_=set; };

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.

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

overridevirtual

reference to daughter at given position

Reimplemented from reco::CompositePtrCandidate.

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

overridevirtual

references to daughtes

Reimplemented from reco::CompositePtrCandidate.

Referenced by BetaStarVarProducer< T >::calculateCHSEnergies(), LeptonJetVarProducer< T >::calculatePtRatioRel(), BJetEnergyRegressionMVA::fillAdditionalVariables(), Jet.Jet::leadingTrack(), and pat::PATJetSlimmer::produce().

float pat::Jet::elecMultiplicity ( ) const

inline

chargedMultiplicity

Definition at line 354 of file Jet.h.

References reco::btau::muonMultiplicity.

{return jptSpecific().elecsInVertexInCalo.size()+jptSpecific().elecsInVertexOutCalo.size();}

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

inline

electrons fully contained in cone

Definition at line 346 of file Jet.h.

{return jptSpecific().elecsInVertexInCalo; }

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

inline

electrons that curled out

Definition at line 348 of file Jet.h.

{return jptSpecific().elecsInVertexOutCalo;}

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

inline

electrons that curled in

Definition at line 350 of file Jet.h.

{return jptSpecific().elecsOutVertexInCalo;}

float pat::Jet::electronEnergy ( ) const

inline

electronEnergy

Definition at line 386 of file Jet.h.

Referenced by Jet.Jet::electronEnergyFraction().

{return pfSpecific().mElectronEnergy;}

float pat::Jet::electronEnergyFraction ( ) const

inline

electronEnergyFraction (relative to corrected jet energy)

Definition at line 388 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

Referenced by CombinedSVComputer::fillCommonVariables().

{return electronEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::electronMultiplicity ( ) const

inline

electronMultiplicity

Definition at line 409 of file Jet.h.

Referenced by CombinedSVComputer::fillCommonVariables().

{return pfSpecific().mElectronMultiplicity;}

float pat::Jet::emEnergyFraction ( ) const

inline

returns the jet electromagnetic energy fraction

Definition at line 300 of file Jet.h.

Referenced by PatZjetsJetAnalyzer::analyze(), main(), and JetIDSelectionFunctor::operator()().

{return caloSpecific().mEnergyFractionEm;}

float pat::Jet::emEnergyInEB ( ) const

inline

returns the jet electromagnetic energy in EB

Definition at line 310 of file Jet.h.

{return caloSpecific().mEmEnergyInEB;}

float pat::Jet::emEnergyInEE ( ) const

inline

returns the jet electromagnetic energy in EE

Definition at line 312 of file Jet.h.

{return caloSpecific().mEmEnergyInEE;}

float pat::Jet::emEnergyInHF ( ) const

inline

returns the jet electromagnetic energy extracted from HF

Definition at line 314 of file Jet.h.

{return caloSpecific().mEmEnergyInHF;}

float pat::Jet::energyFractionHadronic ( ) const

inline

returns the jet hadronic energy fraction

Definition at line 298 of file Jet.h.

{return caloSpecific().mEnergyFractionHadronic;}

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

(

)

const

return the matched generated jet

Referenced by main().

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

inline

Definition at line 468 of file Jet.h.

{ return genJetFwdRef_; }

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

inline

-— methods for MC matching -—

return the matched generated parton

Definition at line 110 of file Jet.h.

References jets_cff::hadronFlavour, and jets_cff::partonFlavour.

{ return genParticle(); }

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

Referenced by PatZjetsJetAnalyzer::analyze().

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

Referenced by PatZjetsJetAnalyzer::analyze(), and JetIDSelectionFunctor::operator()().

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

(

)

const

get vector of paire labelname-disciValue

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

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

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

inline

Access to mass of subjets.

Definition at line 527 of file Jet.h.

References a, b, and ResonanceBuilder::mass.

                                                      {
    auto const& sub = subjets(index);
    return nSubjetCollections() > index && !sub.empty() ?
      std::accumulate( sub.begin(), sub.end(),
               reco::Candidate::LorentzVector(),
               [] (reco::Candidate::LorentzVector const & a, reco::CandidatePtr const & b){return a + b->p4();}).mass() :
      -1.0;
      }

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

inline

Definition at line 535 of file Jet.h.

References a, b, and ResonanceBuilder::mass.

                                                       {
    auto const& sub = subjets(label);
    return hasSubjets(label) && !sub.empty() ?
      std::accumulate( sub.begin(), sub.end(),
               reco::Candidate::LorentzVector(),
               [] (reco::Candidate::LorentzVector const & a, reco::CandidatePtr const & b){return a + b->p4();}).mass() :
      -1.0;
      }

float pat::Jet::hadEnergyInHB ( ) const

inline

returns the jet hadronic energy in HB

Definition at line 302 of file Jet.h.

{return caloSpecific().mHadEnergyInHB;}

float pat::Jet::hadEnergyInHE ( ) const

inline

returns the jet hadronic energy in HE

Definition at line 306 of file Jet.h.

{return caloSpecific().mHadEnergyInHE;}

float pat::Jet::hadEnergyInHF ( ) const

inline

returns the jet hadronic energy in HF

Definition at line 308 of file Jet.h.

{return caloSpecific().mHadEnergyInHF;}

float pat::Jet::hadEnergyInHO ( ) const

inline

returns the jet hadronic energy in HO

Definition at line 304 of file Jet.h.

{return caloSpecific().mHadEnergyInHO;}

int pat::Jet::hadronFlavour

(

)

const

return the hadron-based flavour of the jet

bool pat::Jet::hasPFSpecific ( ) const

inline

check to see if the PFSpecific object is stored

Definition at line 269 of file Jet.h.

{ return !specificPF_.empty(); }

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

inline

Check to see if the subjet collection exists.

Definition at line 518 of file Jet.h.

References spr::find(), and label.

{ return find( subjetLabels_.begin(), subjetLabels_.end(), label) != subjetLabels_.end(); }

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

inline

check to see if the given tag info is nonzero

Definition at line 188 of file Jet.h.

References eleHcalExtractorBlocks_cff::caloTowers, info(), slimmedMuons_cfi::pfCandidates, AlCaHLTBitMon_QueryRunRegistry::string, and l1t::tracks.

{ return tagInfo(label) != nullptr; }

float pat::Jet::HFEMEnergy ( ) const

inline

HFEMEnergy.

Definition at line 398 of file Jet.h.

Referenced by Jet.Jet::HFEMEnergyFraction().

{return pfSpecific().mHFEMEnergy;}

float pat::Jet::HFEMEnergyFraction ( ) const

inline

HFEMEnergyFraction (relative to corrected jet energy)

Definition at line 400 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

{return HFEMEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::HFEMMultiplicity ( ) const

inline

HFEMMultiplicity.

Definition at line 414 of file Jet.h.

{return pfSpecific().mHFEMMultiplicity;}

float pat::Jet::HFHadronEnergy ( ) const

inline

HFHadronEnergy.

Definition at line 394 of file Jet.h.

Referenced by Jet.Jet::HFHadronEnergyFraction().

{return pfSpecific().mHFHadronEnergy;}

float pat::Jet::HFHadronEnergyFraction ( ) const

inline

HFHadronEnergyFraction (relative to corrected jet energy)

Definition at line 396 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

{return HFHadronEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::HFHadronMultiplicity ( ) const

inline

HFHadronMultiplicity.

Definition at line 412 of file Jet.h.

{return pfSpecific().mHFHadronMultiplicity;}

float pat::Jet::hoEnergy ( ) const

inline

hoEnergy

Definition at line 425 of file Jet.h.

Referenced by Jet.Jet::hoEnergyFraction().

{return pfSpecific().mHOEnergy;}

float pat::Jet::hoEnergyFraction ( ) const

inline

hoEnergyFraction (relative to corrected jet energy)

Definition at line 427 of file Jet.h.

References reco::LeafCandidate::daughter(), randomXiThetaGunProducer_cfi::energy, and mps_fire::i.

{return hoEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

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().

bool pat::Jet::isBasicJet ( ) const

inline

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

Definition at line 257 of file Jet.h.

Referenced by PFJetIDSelectionFunctor::firstDataCuts().

{ return !(isCaloJet() || isPFJet() || isJPTJet()); }

bool pat::Jet::isCaloJet ( ) const

inline

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

Definition at line 251 of file Jet.h.

Referenced by hitfit::JetTranslatorBase< AJet >::CheckEta(), CaloJetMETcorrInputProducer_namespace::InputTypeCheckerT< pat::Jet >::operator()(), hitfit::JetTranslatorBase< AJet >::operator()(), JetIDSelectionFunctor::operator()(), and pat::PATJetProducer::produce().

{ return !specificCalo_.empty() && !isJPTJet(); }

bool pat::Jet::isJPTJet ( ) const

inline

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

Definition at line 253 of file Jet.h.

Referenced by JetIDSelectionFunctor::operator()(), and pat::PATJetProducer::produce().

{ return !specificJPT_.empty(); }

bool pat::Jet::isPFJet ( ) const

inline

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

Definition at line 255 of file Jet.h.

Referenced by hitfit::JetTranslatorBase< AJet >::CheckEta(), PFMEtSignInterfaceBase::compResolution(), CombinedSVComputer::fillCommonVariables(), PFJetIDSelectionFunctor::firstDataCuts(), Jet.Jet::jetID(), PFJetMETcorrInputProducer_namespace::InputTypeCheckerT< pat::Jet, PATJetCorrExtractor >::operator()(), JetCleanerForType1MET_namespace::InputTypeCheckerT< pat::Jet, PATJetCorrExtractor >::operator()(), hitfit::JetTranslatorBase< AJet >::operator()(), and pat::PATJetProducer::produce().

{ return !specificPF_.empty(); }

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

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

Referenced by LeptonJetVarProducer< T >::calculatePtRatioRel(), BJetEnergyRegressionVarProducer< T >::calculatePtRatioRel(), TtFullHadKinFitter::KinFit::corJet(), AdHocNTupler::fill(), BJetEnergyRegressionMVA::fillAdditionalVariables(), main(), Jet.Jet::rawFactor(), TtFullHadHypothesis::setCandidate(), TtSemiLepHypothesis::setCandidate(), and Jet.Jet::setRawFactor().

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().

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

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 134 of file Jet.h.

{return (jecSet(set)>=0); };

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 137 of file Jet.h.

{return (set<jec_.size()); };

bool pat::Jet::jecSetsAvailable ( ) const

inline

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

Definition at line 131 of file Jet.h.

Referenced by pat::RawJetExtractorT< pat::Jet >::operator()(), PFJetMETcorrInputProducer_namespace::RawJetExtractorT< pat::Jet >::operator()(), JetCleanerForType1MET_namespace::RawJetExtractorT< pat::Jet >::operator()(), CaloJetMETcorrInputProducer_namespace::RawJetExtractorT< pat::Jet >::operator()(), and PFJetIDSelectionFunctor::operator()().

{ return !jec_.empty(); }

float pat::Jet::jetCharge

(

)

const

method to return the JetCharge computed when creating the Jet

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

(

)

const

return the JetFlavourInfo of the jet

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

inline

accessing Jet ID information

Definition at line 462 of file Jet.h.

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

{ return jetID_;}

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

inline

retrieve the jpt specific part of the jet

Definition at line 264 of file Jet.h.

                                             {
    if (specificJPT_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet.\n";
    return specificJPT_[0];
      }

float pat::Jet::maxEInEmTowers ( ) const

inline

returns the maximum energy deposited in ECAL towers

Definition at line 294 of file Jet.h.

{return caloSpecific().mMaxEInEmTowers;}

float pat::Jet::maxEInHadTowers ( ) const

inline

returns the maximum energy deposited in HCAL towers

Definition at line 296 of file Jet.h.

{return caloSpecific().mMaxEInHadTowers;}

float pat::Jet::muonEnergy ( ) const

inline

muonEnergy

Definition at line 390 of file Jet.h.

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

{return pfSpecific().mMuonEnergy;}

float pat::Jet::muonEnergyFraction ( ) const

inline

muonEnergyFraction (relative to corrected jet energy)

Definition at line 392 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

Referenced by CombinedSVComputer::fillCommonVariables().

{return muonEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::muonMultiplicity ( ) const

inline

muonMultiplicity

Definition at line 683 of file Jet.h.

References Exception.

Referenced by CombinedSVComputer::fillCommonVariables().

{
  if(isPFJet()){ return pfSpecific().mMuonMultiplicity; }
  else if( isJPTJet() ){ return jptSpecific().muonsInVertexInCalo.size()+jptSpecific().muonsInVertexOutCalo.size();}
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

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

inline

muons fully contained in cone

Definition at line 340 of file Jet.h.

{return jptSpecific().muonsInVertexInCalo; }

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

inline

muons that curled out

Definition at line 342 of file Jet.h.

{return jptSpecific().muonsInVertexOutCalo;}

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

inline

muons that curled in

Definition at line 344 of file Jet.h.

{return jptSpecific().muonsOutVertexInCalo;}

int pat::Jet::n60 ( ) const

inline

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

Definition at line 320 of file Jet.h.

{return nCarrying (0.6);}

int pat::Jet::n90 ( ) const

inline

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

Definition at line 318 of file Jet.h.

{return nCarrying (0.9);}

float pat::Jet::neutralEmEnergy ( ) const

inline

neutralEmEnergy

Definition at line 676 of file Jet.h.

References Exception.

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

{
  if(isPFJet()){ return pfSpecific().mNeutralEmEnergy; }
  else if( isJPTJet() ){ return jptSpecific().mNeutralEmEnergy;}
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

float pat::Jet::neutralEmEnergyFraction ( ) const

inline

neutralEmEnergyFraction (relative to uncorrected jet energy)

Definition at line 378 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

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

{return neutralEmEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

float pat::Jet::neutralHadronEnergy ( ) const

inline

neutralHadronEnergy

Definition at line 662 of file Jet.h.

References Exception.

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

{
  if(isPFJet()){ return pfSpecific().mNeutralHadronEnergy; }
  else if( isJPTJet() ){ return jptSpecific().mNeutralHadronEnergy; }
  else{ throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet nor from PFJet.\n"; }
}

float pat::Jet::neutralHadronEnergyFraction ( ) const

inline

neutralHadronEnergyFraction (relative to uncorrected jet energy)

Definition at line 374 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

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

{return neutralHadronEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::neutralHadronMultiplicity ( ) const

inline

neutralHadronMultiplicity

Definition at line 405 of file Jet.h.

Referenced by CombinedSVComputer::fillCommonVariables().

{return pfSpecific().mNeutralHadronMultiplicity;}

int pat::Jet::neutralMultiplicity ( ) const

inline

neutralMultiplicity

Definition at line 422 of file Jet.h.

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

{return pfSpecific().mNeutralMultiplicity;}

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

inline

Number of subjet collections.

Definition at line 521 of file Jet.h.

{ return  subjetCollections_.size(); }

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 PFJetIDSelectionFunctor::firstDataCuts().

int pat::Jet::partonFlavour

(

)

const

return the parton-based flavour of the jet

Referenced by AnalysisTasksAnalyzerBTag::analyze(), and TtDilepLRSignalSelObservables::operator()().

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

inline

Definition at line 467 of file Jet.h.

{ return pfCandidatesFwdPtr_; }

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

inline

retrieve the pf specific part of the jet

Definition at line 271 of file Jet.h.

Referenced by PFMEtSignInterfaceBase::compResolution().

                                           {
    if (specificPF_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a PFJet.\n";
    return specificPF_[0];
      }

float pat::Jet::photonEnergy ( ) const

inline

photonEnergy

Definition at line 382 of file Jet.h.

Referenced by Jet.Jet::photonEnergyFraction().

{return pfSpecific().mPhotonEnergy;}

float pat::Jet::photonEnergyFraction ( ) const

inline

photonEnergyFraction (relative to corrected jet energy)

Definition at line 384 of file Jet.h.

References randomXiThetaGunProducer_cfi::energy.

Referenced by CombinedSVComputer::fillCommonVariables().

{return photonEnergy()/((jecSetsAvailable() ? jecFactor(0) : 1.)*energy());}

int pat::Jet::photonMultiplicity ( ) const

inline

photonMultiplicity

Definition at line 407 of file Jet.h.

Referenced by CombinedSVComputer::fillCommonVariables().

{return pfSpecific().mPhotonMultiplicity;}

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

inline

pions fully contained in cone

Definition at line 334 of file Jet.h.

{return jptSpecific().pionsInVertexInCalo; }

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

inline

pions that curled out

Definition at line 336 of file Jet.h.

{return jptSpecific().pionsInVertexOutCalo;}

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

inline

pions that curled in

Definition at line 338 of file Jet.h.

{return jptSpecific().pionsOutVertexInCalo;}

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::PATJetSlimmer::produce(), and pat::PATJetProducer::produce().

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

inline

set the calo specific part of the jet

Definition at line 276 of file Jet.h.

                                                                {
    if (specificCalo_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a CaloJet.\n";
    specificCalo_[0] = newCaloSpecific;
      }

void pat::Jet::setCaloTowers

(

const CaloTowerFwdPtrCollection &

caloTowers

)

method to store the CaloJet constituents internally

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

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().

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

inline

method to set the matched parton

Definition at line 234 of file Jet.h.

References embed.

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

{ setGenParticleRef(gp, embed); }

void pat::Jet::setHadronFlavour

(

int

hadronFl

)

method to set the hadron-based flavour of the jet

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

void pat::Jet::setJetCharge

(

float

jetCharge

)

method to set the jet charge

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

void pat::Jet::setJetFlavourInfo

(

const reco::JetFlavourInfo &

jetFlavourInfo

)

method to set the JetFlavourInfo of the jet

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

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

inline

methods for jet ID

Definition at line 246 of file Jet.h.

References triggerObjects_cff::id.

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

{ jetID_ = id; }

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

inline

set the jpt specific part of the jet

Definition at line 281 of file Jet.h.

                                                             {
    if (specificJPT_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a JPTJet.\n";
    specificJPT_[0] = newJPTSpecific;
      }

void pat::Jet::setPartonFlavour

(

int

partonFl

)

method to set the parton-based flavour of the jet

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

void pat::Jet::setPFCandidates

(

const PFCandidateFwdPtrCollection &

pfCandidates

)

method to store the PFCandidate constituents internally

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

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

inline

set the pf specific part of the jet

Definition at line 286 of file Jet.h.

                                                          {
    if (specificPF_.empty()) throw cms::Exception("Type Mismatch") << "This PAT jet was not made from a PFJet.\n";
    specificPF_[0] = newPFSpecific;
      }

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

inline

Subjet collection names.

Definition at line 524 of file Jet.h.

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

{ return subjetLabels_; }

pat::JetPtrCollection const& pat::Jet::subjets

(

unsigned int

index = 0

)

const

Access to subjet list.

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

pat::JetPtrCollection const& pat::Jet::subjets

(

std::string const &

label

)

const

String access to subjet list.

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

const reco::BoostedDoubleSVTagInfo* pat::Jet::tagInfoBoostedDoubleSV

(

const std::string &

label = ""

)

const

template<typename T >

const T* pat::Jet::tagInfoByType ( ) const

inlineprivate

Definition at line 616 of file Jet.h.

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

      {
        // First check the factorized PAT version
        for (size_t i = 0, n = tagInfosFwdPtr_.size(); i < n; ++i) {
          TagInfoFwdPtrCollection::value_type const & val = tagInfosFwdPtr_[i];
          reco::BaseTagInfo const * baseTagInfo = val.get();
          if ( typeid(*baseTagInfo) == typeid(T) ) {
            return static_cast<const T *>( baseTagInfo );
          }
        }
        // Then check compatibility version
        for (size_t i = 0, n = tagInfos_.size(); i < n; ++i) {
          edm::OwnVector<reco::BaseTagInfo>::value_type const & val = tagInfos_[i];
          reco::BaseTagInfo const * baseTagInfo = &val;
          if ( typeid(*baseTagInfo) == typeid(T) ) {
            return static_cast<const T *>( baseTagInfo );
          }
        }
        return nullptr;
      }

template<typename T >

const T* pat::Jet::tagInfoByTypeOrLabel ( const std::string &  label = "" ) const

inlineprivate

Definition at line 637 of file Jet.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

      {
        return ( label.empty() ? tagInfoByType<T>() : dynamic_cast<const T *>(tagInfo(label)) );
      }

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

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

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

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

inline

get list of tag info labels

Definition at line 186 of file Jet.h.

{ return tagInfoLabels_; }

const reco::SecondaryVertexTagInfo* pat::Jet::tagInfoSecondaryVertex

(

const std::string &

label = ""

)

const

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

inline

Definition at line 469 of file Jet.h.

{ return tagInfosFwdPtr_; }

const reco::SoftLeptonTagInfo* pat::Jet::tagInfoSoftLepton

(

const std::string &

label = ""

)

const

const reco::TrackIPTagInfo* pat::Jet::tagInfoTrackIP

(

const std::string &

label = ""

)

const

float pat::Jet::towersArea ( ) const

inline

returns area of contributing towers

Definition at line 316 of file Jet.h.

{return caloSpecific().mTowersArea;}

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

private

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 473 of file Jet.h.

References Exception.

                                                                                              {
    if ( index < caloTowersFwdPtr_.size() ) {
      caloTowersFwdPtr_[index] = CaloTowerFwdPtrVector::value_type( updateFwd, caloTowersFwdPtr_[index].backPtr() );
    } else {
      throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
    }
      }

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

inline

Definition at line 498 of file Jet.h.

References hgcalPlots::obj, reco::operator<<(), MillePedeFileConverter_cfg::out, csvLumiCalc::pieces, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                           {
    genJetFwdRef_ = edm::FwdRef<reco::GenJetCollection>( updateRef, genJetFwdRef_.backRef() );
      }

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

inline

Definition at line 481 of file Jet.h.

References Exception.

                                                                                                      {
    if ( index < pfCandidatesFwdPtr_.size() ) {
      pfCandidatesFwdPtr_[index] = reco::PFCandidateFwdPtrVector::value_type( updateFwd, pfCandidatesFwdPtr_[index].backPtr() );
    } else {
      throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
    }
      }

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

inline

Definition at line 490 of file Jet.h.

References Exception.

                                                                                                  {
    if ( index < tagInfosFwdPtr_.size() ) {
      tagInfosFwdPtr_[index] = TagInfoFwdPtrCollection::value_type( updateFwd, tagInfosFwdPtr_[index].backPtr() );
    } else {
      throw cms::Exception("OutOfRange") << "Index " << index << " is out of range" << std::endl;
    }
      }

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

inline

zero suppression correction

Definition at line 352 of file Jet.h.

{return jptSpecific().mZSPCor;}

Friends And Related Function Documentation

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 84 of file Jet.h.

friend class PATJetSlimmer

friend

Definition at line 85 of file Jet.h.

friend class PATJetUpdater

friend

Definition at line 86 of file Jet.h.

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

friend

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

Member Data Documentation

reco::TrackRefVector pat::Jet::associatedTracks_

protected

Definition at line 598 of file Jet.h.

CaloTowerCollection pat::Jet::caloTowers_

protected

Definition at line 550 of file Jet.h.

CaloTowerFwdPtrVector pat::Jet::caloTowersFwdPtr_

protected

Definition at line 551 of file Jet.h.

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

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

protected

Definition at line 549 of file Jet.h.

JetCorrFactors::Flavor pat::Jet::currentJECFlavor_

protected

Definition at line 585 of file Jet.h.

unsigned int pat::Jet::currentJECLevel_

protected

Definition at line 582 of file Jet.h.

unsigned int pat::Jet::currentJECSet_

protected

Definition at line 580 of file Jet.h.

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

protected

Definition at line 563 of file Jet.h.

bool pat::Jet::embeddedCaloTowers_

protected

Definition at line 548 of file Jet.h.

bool pat::Jet::embeddedPFCandidates_

protected

Definition at line 554 of file Jet.h.

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

protected

Definition at line 567 of file Jet.h.

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

protected

Definition at line 569 of file Jet.h.

reco::GenJetRefVector pat::Jet::genJetRef_

protected

Definition at line 568 of file Jet.h.

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

protected

Definition at line 577 of file Jet.h.

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

float pat::Jet::jetCharge_

protected

Definition at line 597 of file Jet.h.

reco::JetFlavourInfo pat::Jet::jetFlavourInfo_

protected

Definition at line 570 of file Jet.h.

reco::JetID pat::Jet::jetID_

protected

Definition at line 607 of file Jet.h.

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

protected

Definition at line 589 of file Jet.h.

reco::PFCandidateCollection pat::Jet::pfCandidates_

protected

Definition at line 556 of file Jet.h.

reco::PFCandidateFwdPtrVector pat::Jet::pfCandidatesFwdPtr_

protected

Definition at line 557 of file Jet.h.

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

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

protected

Definition at line 555 of file Jet.h.

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

protected

Definition at line 602 of file Jet.h.

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

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

protected

Definition at line 603 of file Jet.h.

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

protected

Definition at line 604 of file Jet.h.

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

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

protected

Definition at line 561 of file Jet.h.

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

protected

Definition at line 562 of file Jet.h.

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

protected

Definition at line 590 of file Jet.h.

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

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

protected

Definition at line 591 of file Jet.h.

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

TagInfoFwdPtrCollection pat::Jet::tagInfosFwdPtr_

protected

Definition at line 592 of file Jet.h.

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