reco::PFClusterJet Class Reference

Jets made out of PFClusters. More...

#include <PFClusterJet.h>

Inheritance diagram for reco::PFClusterJet:

Public Member Functions
PFClusterJet *	clone () const override
	Polymorphic clone. More...
reco::PFClusterRef	pfCluster (size_t i) const
	Easy Constituent access. More...
	PFClusterJet ()
	Default constructor. More...
	PFClusterJet (const LorentzVector &fP4, const Point &fVertex)
	Constructor without constituents. More...
	PFClusterJet (const LorentzVector &fP4, const Point &fVertex, const Jet::Constituents &fConstituents)
	Constructor from RecoChargedRefCandidate constituents. More...
std::string	print () const override
	Print object. More...
	~PFClusterJet () override
	Destructor. More...
Public Member Functions inherited from reco::Jet
float	constituentEtaPhiSpread () const
float	constituentPtDistribution () const
float	etaetaMoment () const
	eta-eta second moment, ET weighted More...
float	etaphiMoment () const
	eta-phi second moment, ET weighted More...
EtaPhiMoments	etaPhiStatistics () const
	eta-phi statistics, ET weighted More...
float	etInAnnulus (float fRmin, float fRmax) const
	ET in annulus between rmin and rmax around jet direction. More...
virtual Constituents	getJetConstituents () const
	list of constituents More...
virtual std::vector< const reco::Candidate * >	getJetConstituentsQuick () const
	quick list of constituents More...
bool	isJet () const override
virtual int	isWeighted () const
	boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
	Jet ()
	Default constructor. More...
	Jet (const LorentzVector &fP4, const Point &fVertex)
	Initiator. More...
	Jet (const LorentzVector &fP4, const Point &fVertex, const Constituents &fConstituents)
virtual float	jetArea () const
	get jet area More...
float	maxDistance () const
	maximum distance from jet to constituent More...
int	nCarrying (float fFraction) const
	return # of constituent carrying fraction of energy More...
virtual int	nConstituents () const
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 void	scaleEnergy (double fScale)
	scale energy of the jet More...
virtual void	setIsWeighted (bool isWeighted)
	Set boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
virtual void	setJetArea (float fArea)
	set jet area More...
virtual void	setNPasses (int fPasses)
	Set number of passes taken by algorithm. More...
virtual void	setPileup (float fEnergy)
	Set pileup energy contribution as calculated by algorithm. More...
	~Jet () override
	Destructor. More...
Public Member Functions inherited from reco::CompositePtrCandidate
void	addDaughter (const CandidatePtr &)
	add a daughter via a reference More...
virtual void	clearDaughters ()
	clear daughter references 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...
const Candidate *	daughter (size_type) const override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
Candidate *	daughter (size_type) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
virtual CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...
virtual const daughters &	daughterPtrVector () const
	references to daughtes More...
const Candidate *	mother (size_t i=0) const override
	return pointer to mother More...
size_t	numberOfDaughters () const override
	number of daughters 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)
const Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
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...
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 ()
template<typename... Args>
	LeafCandidate (Args &&... args)
	LeafCandidate (const Candidate &c)
	LeafCandidate (LeafCandidate &&)=default
	LeafCandidate (LeafCandidate &rh)
	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...
CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...
double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 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
iterator	begin ()
	first daughter iterator More...
const_iterator	begin () const
	first daughter const_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...
iterator	end ()
	last daughter iterator More...
const_iterator	end () const
	last daughter const_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 Member Functions
bool	overlap (const Candidate &dummy) const override
	Polymorphic overlap. More...

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

Detailed Description

Jets made out of PFClusters.

PFClusterJet represents Jets with PFClusters as constituents. The consitutents are in this case RecoPFClusterRefCandidates, that preserve the Refs to the original PFClusters. Those Refs are used to provide transparent access to the PFClusters.

Author

Salvatore Rappoccio

Definition at line 23 of file PFClusterJet.h.

Constructor & Destructor Documentation

PFClusterJet() [1/3]

reco::PFClusterJet::PFClusterJet

(

)

Default constructor.

Definition at line 4 of file PFClusterJet.cc.

: reco::Jet() {}

PFClusterJet() [2/3]

reco::PFClusterJet::PFClusterJet	(	const LorentzVector &	fP4,
		const Point &	fVertex
	)

Constructor without constituents.

Definition at line 6 of file PFClusterJet.cc.

: reco::Jet(fP4, fVertex) {}

PFClusterJet() [3/3]

reco::PFClusterJet::PFClusterJet	(	const LorentzVector &	fP4,
		const Point &	fVertex,
		const Jet::Constituents &	fConstituents
	)

Constructor from RecoChargedRefCandidate constituents.

Definition at line 8 of file PFClusterJet.cc.

    : reco::Jet(fP4, fVertex, fConstituents) {}

~PFClusterJet()

reco::PFClusterJet::~PFClusterJet ( )

inlineoverride

Destructor.

Definition at line 32 of file PFClusterJet.h.

{}

Member Function Documentation

clone()

reco::PFClusterJet * reco::PFClusterJet::clone ( void  ) const

overridevirtual

Polymorphic clone.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 11 of file PFClusterJet.cc.

{ return new reco::PFClusterJet(*this); }

overlap()

bool reco::PFClusterJet::overlap ( const Candidate &  dummy ) const

overrideprivatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 32 of file PFClusterJet.cc.

{ return false; }

pfCluster()

reco::PFClusterRef reco::PFClusterJet::pfCluster

(

size_t

i

)

const

Easy Constituent access.

Definition at line 13 of file PFClusterJet.cc.

                                                           {
  Constituent dau = daughterPtr(i);
  // check the daughter to be ok
  if (dau.isNonnull() && dau.isAvailable()) {
    // convert to concrete candidate type
    const RecoPFClusterRefCandidate* pfClusterCand = dynamic_cast<const RecoPFClusterRefCandidate*>(dau.get());
    // check the candidate is of the right type
    if (pfClusterCand) {
      return pfClusterCand->pfCluster();
    } else {
      throw cms::Exception("Invalid Constituent")
          << "PFClusterJet constituent is not of RecoPFClusterRefCandidate type";
    }
    // otherwise return empty ptr
  } else {
    return reco::PFClusterRef();
  }
}

References Exception, edm::Ptr< T >::get(), mps_fire::i, edm::Ptr< T >::isAvailable(), edm::Ptr< T >::isNonnull(), and reco::RecoPFClusterRefCandidate::pfCluster().

print()

std::string reco::PFClusterJet::print ( void  ) const

overridevirtual

Print object.

Reimplemented from reco::Jet.

Definition at line 34 of file PFClusterJet.cc.

                                        {
  std::ostringstream out;
  out << Jet::print() << std::endl;
  out << "    Constituents: " << std::endl;
  for (size_t i = 0; i < numberOfDaughters(); ++i) {
    out << *(pfCluster(i)) << std::endl;
  }
  return out.str();
}

References mps_fire::i, MillePedeFileConverter_cfg::out, and reco::Jet::print().