pat::TriggerObject Class Reference

Analysis-level trigger object class. More...

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

Inheritance diagram for pat::TriggerObject:

Public Member Functions
void	addFilterId (trigger::TriggerObjectType triggerObjectType)
void	addFilterId (int triggerObjectType)
void	addTriggerObjectType (trigger::TriggerObjectType triggerObjectType)
	Add a new trigger object type identifier. More...
void	addTriggerObjectType (int triggerObjectType)
virtual bool	coll (const std::string &collName) const
	Calls 'hasCollection(...)'. More...
const std::string &	collection () const
	Get the label of the collection the trigger object originates from. More...
std::vector< int >	filterIds () const
virtual bool	hasCollection (const std::string &collName) const
	Checks, if a certain label of original collection is assigned. More...
virtual bool	hasCollection (const edm::InputTag &collName) const
bool	hasFilterId (trigger::TriggerObjectType triggerObjectType) const
bool	hasFilterId (int triggerObjectType) const
bool	hasTriggerObjectType (trigger::TriggerObjectType triggerObjectType) const
	Checks, if a certain trigger object type identifier is assigned. More...
bool	hasTriggerObjectType (int triggerObjectType) const
bool	id (trigger::TriggerObjectType triggerObjectType) const
bool	id (int triggerObjectType) const
const l1extra::L1EmParticleRef	origL1EmRef () const
const l1extra::L1EtMissParticleRef	origL1EtMissRef () const
const L1GctEmCand *	origL1GctEmCand () const
const L1GctEtHad *	origL1GctEtHad () const
const L1GctEtMiss *	origL1GctEtMiss () const
const L1GctEtTotal *	origL1GctEtTotal () const
const L1GctHtMiss *	origL1GctHtMiss () const
const L1GctJetCand *	origL1GctJetCand () const
const L1MuGMTExtendedCand *	origL1GmtMuonCand () const
const l1extra::L1JetParticleRef	origL1JetRef () const
const l1extra::L1MuonParticleRef	origL1MuonRef () const
const reco::Candidate *	origObjCand () const
const reco::CandidateBaseRef &	origObjRef () const
	Special methods for 'l1extra' particles. More...
void	setCollection (const std::string &collName)
	Methods. More...
void	setCollection (const edm::InputTag &collName)
	TriggerObject ()
	Constructors and Destructor. More...
	TriggerObject (const trigger::TriggerObject &trigObj)
	Constructor from trigger::TriggerObject. More...
	TriggerObject (const reco::LeafCandidate &leafCand)
	Constructors from base class object. More...
	TriggerObject (const reco::CandidateBaseRef &candRef)
	Constructors from base candidate reference (for 'l1extra' particles) More...
	TriggerObject (const reco::Particle::LorentzVector &vec, int id=0)
	Constructors from Lorentz-vectors and (optional) PDG ID. More...
	TriggerObject (const reco::Particle::PolarLorentzVector &vec, int id=0)
std::vector< int >	triggerObjectTypes () const
	Get all trigger object type identifiers. More...
bool	type (trigger::TriggerObjectType triggerObjectType) const
	Calls 'hasTriggerObjectType(...)'. More...
bool	type (int triggerObjectType) const
	~TriggerObject () override
	Destructor. More...
Public Member Functions inherited from reco::LeafCandidate
Vector	boostToCM () const final
int	charge () const final
	electric charge More...
LeafCandidate *	clone () const override
	returns a clone of the Candidate object More...
void	construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
const Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
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	isJet () 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	numberOfDaughters () const override
	number of daughters 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...

Private Attributes
std::string	collection_
	Data Members. More...
reco::CandidateBaseRef	refToOrig_
std::vector < trigger::TriggerObjectType >	triggerObjectTypes_

Additional Inherited Members
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...

Detailed Description

Analysis-level trigger object class.

TriggerObject implements a container for trigger objects' information within the 'pat' namespace. For detailed information, consult https://twiki.cern.ch/twiki/bin/view/CMS/SWGuidePATTrigger#TriggerObject

Author

Volker Adler

Definition at line 44 of file TriggerObject.h.

Constructor & Destructor Documentation

pat::TriggerObject::TriggerObject

(

)

Constructors and Destructor.

Default constructor

pat::TriggerObject::TriggerObject

(

const trigger::TriggerObject &

trigObj

)

Constructor from trigger::TriggerObject.

pat::TriggerObject::TriggerObject

(

const reco::LeafCandidate &

leafCand

)

Constructors from base class object.

pat::TriggerObject::TriggerObject

(

const reco::CandidateBaseRef &

candRef

)

Constructors from base candidate reference (for 'l1extra' particles)

pat::TriggerObject::TriggerObject	(	const reco::Particle::LorentzVector &	vec,
		int	id = 0
	)

Constructors from Lorentz-vectors and (optional) PDG ID.

pat::TriggerObject::TriggerObject	(	const reco::Particle::PolarLorentzVector &	vec,
		int	id = 0
	)

pat::TriggerObject::~TriggerObject ( )

inlineoverride

Destructor.

Definition at line 74 of file TriggerObject.h.

{};

Member Function Documentation

void pat::TriggerObject::addFilterId ( trigger::TriggerObjectType  triggerObjectType )

inline

Definition at line 89 of file TriggerObject.h.

References addTriggerObjectType().

                                                                 {
      addTriggerObjectType(triggerObjectType);
    };  // for backward compatibility

void pat::TriggerObject::addFilterId ( int  triggerObjectType )

inline

Definition at line 92 of file TriggerObject.h.

References addTriggerObjectType().

                                            {
      addTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };  // for backward compatibility

void pat::TriggerObject::addTriggerObjectType ( trigger::TriggerObjectType  triggerObjectType )

inline

Add a new trigger object type identifier.

Definition at line 82 of file TriggerObject.h.

References hasTriggerObjectType(), and triggerObjectTypes_.

Referenced by addFilterId(), addTriggerObjectType(), pat::PATTriggerProducer::produce(), and pat::TriggerObjectStandAlone::triggerObject().

                                                                          {
      if (!hasTriggerObjectType(triggerObjectType))
        triggerObjectTypes_.push_back(triggerObjectType);
    };

void pat::TriggerObject::addTriggerObjectType ( int  triggerObjectType )

inline

Definition at line 86 of file TriggerObject.h.

References addTriggerObjectType().

                                                     {
      addTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };

virtual bool pat::TriggerObject::coll ( const std::string &  collName ) const

inlinevirtual

Calls 'hasCollection(...)'.

Special methods for the cut string parser

• argument types usable in the cut string parser
• short names for readable configuration files

Reimplemented in pat::TriggerObjectStandAlone.

Definition at line 158 of file TriggerObject.h.

References hasCollection().

{ return hasCollection(collName); };

const std::string& pat::TriggerObject::collection ( ) const

inline

Get the label of the collection the trigger object originates from.

Definition at line 96 of file TriggerObject.h.

References collection_.

Referenced by pat::TriggerObjectStandAlone::hasCollection(), and pat::TriggerObjectStandAlone::triggerObject().

{ return collection_; };

std::vector<int> pat::TriggerObject::filterIds ( ) const

inline

Definition at line 101 of file TriggerObject.h.

References triggerObjectTypes().

{ return triggerObjectTypes(); };  // for double backward compatibility

virtual bool pat::TriggerObject::hasCollection ( const std::string &  collName ) const

virtual

Checks, if a certain label of original collection is assigned.

Reimplemented in pat::TriggerObjectStandAlone.

Referenced by coll(), and pat::TriggerObjectStandAlone::hasCollection().

virtual bool pat::TriggerObject::hasCollection ( const edm::InputTag &  collName ) const

inlinevirtual

Reimplemented in pat::TriggerObjectStandAlone.

Definition at line 104 of file TriggerObject.h.

References edm::InputTag::encode(), and hasCollection().

Referenced by hasCollection().

{ return hasCollection(collName.encode()); };

bool pat::TriggerObject::hasFilterId ( trigger::TriggerObjectType  triggerObjectType ) const

inline

Definition at line 110 of file TriggerObject.h.

References hasTriggerObjectType().

                                                                       {
      return hasTriggerObjectType(triggerObjectType);
    };  // for backward compatibility

bool pat::TriggerObject::hasFilterId ( int  triggerObjectType ) const

inline

Definition at line 113 of file TriggerObject.h.

References hasTriggerObjectType().

                                                  {
      return hasTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };  // for backward compatibility

bool pat::TriggerObject::hasTriggerObjectType

(

trigger::TriggerObjectType

triggerObjectType

)

const

Checks, if a certain trigger object type identifier is assigned.

Referenced by addTriggerObjectType(), hasFilterId(), hasTriggerObjectType(), id(), and type().

bool pat::TriggerObject::hasTriggerObjectType ( int  triggerObjectType ) const

inline

Definition at line 107 of file TriggerObject.h.

References hasTriggerObjectType().

                                                           {
      return hasTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };

bool pat::TriggerObject::id ( trigger::TriggerObjectType  triggerObjectType ) const

inline

Definition at line 164 of file TriggerObject.h.

References hasTriggerObjectType().

Referenced by pat::TriggerObjectStandAlone::packPathNames().

                                                              {
      return hasTriggerObjectType(triggerObjectType);
    };  // for backward compatibility

bool pat::TriggerObject::id ( int  triggerObjectType ) const

inline

Definition at line 167 of file TriggerObject.h.

References hasTriggerObjectType().

                                         {
      return hasTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };  // for backward compatibility

const l1extra::L1EmParticleRef pat::TriggerObject::origL1EmRef

(

)

const

Getters specific to the 'l1extra' particle type for

• EM

Referenced by origL1GctEmCand().

const l1extra::L1EtMissParticleRef pat::TriggerObject::origL1EtMissRef

(

)

const

• EtMiss

Referenced by origL1GctEtHad(), origL1GctEtMiss(), origL1GctEtTotal(), and origL1GctHtMiss().

const L1GctEmCand* pat::TriggerObject::origL1GctEmCand ( ) const

inline

Definition at line 125 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1EmRef().

                                               {
      return origL1EmRef().isNonnull() ? origL1EmRef()->gctEmCand() : nullptr;
    };

const L1GctEtHad* pat::TriggerObject::origL1GctEtHad ( ) const

inline

Definition at line 139 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1EtMissRef().

                                             {
      return origL1EtMissRef().isNonnull() ? origL1EtMissRef()->gctEtHad() : nullptr;
    };

const L1GctEtMiss* pat::TriggerObject::origL1GctEtMiss ( ) const

inline

Definition at line 130 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1EtMissRef().

                                               {
      return origL1EtMissRef().isNonnull() ? origL1EtMissRef()->gctEtMiss() : nullptr;
    };

const L1GctEtTotal* pat::TriggerObject::origL1GctEtTotal ( ) const

inline

Definition at line 133 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1EtMissRef().

                                                 {
      return origL1EtMissRef().isNonnull() ? origL1EtMissRef()->gctEtTotal() : nullptr;
    };

const L1GctHtMiss* pat::TriggerObject::origL1GctHtMiss ( ) const

inline

Definition at line 136 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1EtMissRef().

                                               {
      return origL1EtMissRef().isNonnull() ? origL1EtMissRef()->gctHtMiss() : nullptr;
    };

const L1GctJetCand* pat::TriggerObject::origL1GctJetCand ( ) const

inline

Definition at line 144 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1JetRef().

                                                 {
      return origL1JetRef().isNonnull() ? origL1JetRef()->gctJetCand() : nullptr;
    };

const L1MuGMTExtendedCand* pat::TriggerObject::origL1GmtMuonCand ( ) const

inline

Definition at line 149 of file TriggerObject.h.

References edm::Ref< C, T, F >::isNonnull(), and origL1MuonRef().

                                                         {
      return origL1MuonRef().isNonnull() ? &(origL1MuonRef()->gmtMuonCand()) : nullptr;
    };

const l1extra::L1JetParticleRef pat::TriggerObject::origL1JetRef

(

)

const

• Jet

Referenced by origL1GctJetCand().

const l1extra::L1MuonParticleRef pat::TriggerObject::origL1MuonRef

(

)

const

• Muon

Referenced by origL1GmtMuonCand().

const reco::Candidate* pat::TriggerObject::origObjCand ( ) const

inline

Definition at line 121 of file TriggerObject.h.

References edm::RefToBase< T >::get(), and refToOrig_.

{ return refToOrig_.get(); };

const reco::CandidateBaseRef& pat::TriggerObject::origObjRef ( ) const

inline

Special methods for 'l1extra' particles.

General getters

Definition at line 120 of file TriggerObject.h.

References refToOrig_.

{ return refToOrig_; };

void pat::TriggerObject::setCollection ( const std::string &  collName )

inline

Methods.

Set the label of the collection the trigger object originates from

Definition at line 79 of file TriggerObject.h.

References collection_.

Referenced by TriggerObjectTableProducer::produce(), pat::PATTriggerProducer::produce(), and pat::TriggerObjectStandAlone::triggerObject().

{ collection_ = collName; };

void pat::TriggerObject::setCollection ( const edm::InputTag &  collName )

inline

Definition at line 80 of file TriggerObject.h.

References collection_, and edm::InputTag::encode().

{ collection_ = collName.encode(); };

std::vector<int> pat::TriggerObject::triggerObjectTypes

(

)

const

Get all trigger object type identifiers.

Referenced by filterIds(), and pat::TriggerObjectStandAlone::triggerObject().

bool pat::TriggerObject::type ( trigger::TriggerObjectType  triggerObjectType ) const

inline

Calls 'hasTriggerObjectType(...)'.

Definition at line 160 of file TriggerObject.h.

References hasTriggerObjectType().

{ return hasTriggerObjectType(triggerObjectType); };

bool pat::TriggerObject::type ( int  triggerObjectType ) const

inline

Definition at line 161 of file TriggerObject.h.

References hasTriggerObjectType().

                                           {
      return hasTriggerObjectType(trigger::TriggerObjectType(triggerObjectType));
    };

Member Data Documentation

std::string pat::TriggerObject::collection_

private

Data Members.

Label of the collection the trigger object originates from

Definition at line 48 of file TriggerObject.h.

Referenced by collection(), and setCollection().

reco::CandidateBaseRef pat::TriggerObject::refToOrig_

private

Reference to trigger object, meant for 'l1extra' particles to access their additional functionalities, empty otherwise

Definition at line 56 of file TriggerObject.h.

Referenced by origObjCand(), and origObjRef().

std::vector<trigger::TriggerObjectType> pat::TriggerObject::triggerObjectTypes_

private

Vector of special identifiers for the trigger object type as defined in trigger::TriggerObjectType (DataFormats/HLTReco/interface/TriggerTypeDefs.h), possibly empty

Definition at line 52 of file TriggerObject.h.

Referenced by addTriggerObjectType().