pat::PackedGenParticle Class Reference

#include <PackedGenParticle.h>

Inheritance diagram for pat::PackedGenParticle:

Public Types
typedef reco::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...
enum	PVAssoc { NoPV =0, PVLoose =1, PVTight =2, PVUsedInFit =3 }
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...

Public Member Functions
virtual Vector	boostToCM () const
virtual int	charge () const
	electric charge More...
virtual PackedGenParticle *	clone () const
	returns a clone of the Candidate object More...
virtual const reco::Candidate *	daughter (size_type) const
	return daughter at a given position (throws an exception) More...
virtual reco::Candidate *	daughter (size_type)
	return daughter at a given position (throws an exception) More...
virtual reco::Candidate *	daughter (const std::string &s)
	return daughter with a specified role name More...
virtual const reco::Candidate *	daughter (const std::string &s) const
	return daughter with a specified role name More...
virtual float	dxy () const
	dxy with respect to the PV ref More...
virtual float	dxy (const Point &p) const
	dxy with respect to another point More...
virtual float	dz () const
	dz with respect to the PV ref More...
virtual float	dz (const Point &p) const
	dz with respect to another point More...
virtual double	energy () const
	energy More...
double	et () const
	transverse energy More...
double	et2 () const
	transverse energy squared (use this for cuts)! More...
virtual double	eta () const
	momentum pseudorapidity More...
virtual void	fillVertexCovariance (CovarianceMatrix &v) const
	fill SMatrix More...
bool	fromHardProcessFinalState () const
virtual bool	hasMasterClone () const
virtual bool	hasMasterClonePtr () const
virtual bool	isCaloMuon () const
virtual bool	isConvertedPhoton () const
bool	isDirectHardProcessTauDecayProductFinalState () const
bool	isDirectPromptTauDecayProductFinalState () const
virtual bool	isElectron () const
	get a component More...
virtual bool	isGlobalMuon () const
virtual bool	isJet () const
virtual bool	isMuon () const
virtual bool	isPhoton () const
bool	isPromptFinalState () const
virtual bool	isStandAloneMuon () const
virtual bool	isTrackerMuon () const
virtual bool	longLived () const
	is long lived? More...
virtual double	mass () const
	mass More...
virtual bool	massConstraint () const
	do mass constraint? More...
virtual double	massSqr () const
	mass squared More...
virtual const reco::CandidateBaseRef &	masterClone () const
virtual const reco::CandidatePtr &	masterClonePtr () const
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
virtual Vector	momentum () const
	spatial momentum vector More...
virtual const reco::Candidate *	mother (size_type) const
	return mother at a given position (throws an exception) More...
const reco::GenParticleRef &	motherRef () const
	direct access to the mother reference (may be null) More...
virtual double	mt () const
	transverse mass More...
virtual double	mtSqr () const
	transverse mass squared More...
virtual size_t	numberOfDaughters () const
	number of daughters More...
virtual size_t	numberOfMothers () const
	number of mothers More...
virtual size_t	numberOfSourceCandidatePtrs () const
PackedGenParticle &	operator= (PackedGenParticle &&iOther)
PackedGenParticle &	operator= (PackedGenParticle const &iOther)
virtual double	p () const
	magnitude of momentum vector More...
virtual const LorentzVector &	p4 () const
	four-momentum Lorentz vecto r More...
	PackedGenParticle ()
	default constructor More...
	PackedGenParticle (const reco::GenParticle &c)
	PackedGenParticle (const reco::GenParticle &c, const edm::Ref< reco::GenParticleCollection > &mother)
	PackedGenParticle (const PackedGenParticle &iOther)
	PackedGenParticle (PackedGenParticle &&iOther)
virtual int	pdgId () const
	PDG identifier. More...
virtual double	phi () const
	momentum azimuthal angle More...
virtual const PolarLorentzVector &	polarP4 () const
	four-momentum Lorentz vector More...
virtual double	pt () const
	transverse momentum More...
virtual double	px () const
	x coordinate of momentum vector More...
virtual double	py () const
	y coordinate of momentum vector More...
virtual double	pz () const
	z coordinate of momentum vector More...
virtual double	rapidity () const
	rapidity More...
virtual void	setCharge (int charge)
	set electric charge More...
virtual void	setLongLived ()
	set long lived flag More...
virtual void	setMass (double m)
	set particle mass More...
virtual void	setMassConstraint ()
	set mass constraint flag More...
virtual void	setP4 (const LorentzVector &p4)
	set 4-momentum More...
virtual void	setP4 (const PolarLorentzVector &p4)
	set 4-momentum More...
virtual void	setPdgId (int pdgId)
virtual void	setPz (double pz)
virtual void	setStatus (int status)
	set status word More...
virtual void	setThreeCharge (int threecharge)
	set electric charge More...
virtual void	setVertex (const Point &vertex)
	set vertex More...
virtual reco::CandidatePtr	sourceCandidatePtr (size_type i) const
virtual int	status () const
	status word More...
const reco::GenStatusFlags &	statusFlags () const
reco::GenStatusFlags &	statusFlags ()
virtual double	theta () const
	momentum polar angle More...
virtual int	threeCharge () const
	electric charge More...
virtual const Point &	vertex () const
	vertex position More...
virtual double	vertexChi2 () const
	chi-squares More...
virtual double	vertexCovariance (int i, int j) const
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
CovarianceMatrix	vertexCovariance () const
	return SMatrix More...
virtual double	vertexNdof () const
virtual double	vertexNormalizedChi2 () const
	chi-squared divided by n.d.o.f. More...
virtual double	vx () const
	x coordinate of vertex position More...
virtual double	vy () const
	y coordinate of vertex position More...
virtual double	vz () const
	z coordinate of vertex position More...
virtual double	y () const
	rapidity More...
virtual	~PackedGenParticle ()
	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	setP4 (const PolarLorentzVector &p4)=0
	set 4-momentum More...
virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate. More...
virtual void	setVertex (const Point &vertex)=0
	set vertex More...
virtual	~Candidate ()
	destructor More...

Static Public Attributes
static const unsigned int	longLivedTag = 0
	long lived flag More...
static const unsigned int	massConstraintTag = 0
	do mass constraint flag More...

Protected Member Functions
virtual bool	overlap (const reco::Candidate &) const
	check overlap with another Candidate More...
void	pack (bool unpackAfterwards=true)
void	unpack () const

Protected Attributes
int8_t	charge_
	Charge. More...
float	dphi_
float	dxy_
float	dz_
reco::GenParticleRef	mother_
	Ref to first mother. More...
std::atomic< PolarLorentzVector * >	p4_
	the four vector More...
std::atomic< LorentzVector * >	p4c_
uint16_t	packedM_
uint16_t	packedPhi_
uint16_t	packedPt_
uint16_t	packedY_
int	pdgId_
	PDG identifier. More...
reco::GenStatusFlags	statusFlags_
Point	vertex_
	vertex position More...

Friends
class	::OverlapChecker
class	::testPackedGenParticle
template<typename , typename , typename >
struct	component
class	ShallowCloneCandidate
class	ShallowClonePtrCandidate

Detailed Description

Definition at line 19 of file PackedGenParticle.h.

Member Typedef Documentation

typedef reco::CandidateCollection pat::PackedGenParticle::daughters

collection of daughter candidates

Definition at line 24 of file PackedGenParticle.h.

typedef unsigned int pat::PackedGenParticle::index

Definition at line 34 of file PackedGenParticle.h.

typedef math::XYZTLorentzVector pat::PackedGenParticle::LorentzVector

Lorentz vector.

Definition at line 26 of file PackedGenParticle.h.

typedef math::XYZPoint pat::PackedGenParticle::Point

point in the space

Definition at line 30 of file PackedGenParticle.h.

typedef math::PtEtaPhiMLorentzVector pat::PackedGenParticle::PolarLorentzVector

Lorentz vector.

Definition at line 28 of file PackedGenParticle.h.

typedef math::XYZVector pat::PackedGenParticle::Vector

point in the space

Definition at line 32 of file PackedGenParticle.h.

Member Enumeration Documentation

enum pat::PackedGenParticle::PVAssoc

Enumerator
NoPV
PVLoose
PVTight
PVUsedInFit

Definition at line 219 of file PackedGenParticle.h.

{ NoPV=0, PVLoose=1, PVTight=2, PVUsedInFit=3 } ;

Constructor & Destructor Documentation

pat::PackedGenParticle::PackedGenParticle ( )

inline

default constructor

Definition at line 37 of file PackedGenParticle.h.

Referenced by clone().

    : packedPt_(0), packedY_(0), packedPhi_(0), packedM_(0), 
    p4_(nullptr), p4c_(nullptr), vertex_(0,0,0),  pdgId_(0), charge_(0) { }

pat::PackedGenParticle::PackedGenParticle ( const reco::GenParticle &  c )

inlineexplicit

Definition at line 40 of file PackedGenParticle.h.

References pack().

    : p4_(new PolarLorentzVector(c.pt(), c.eta(), c.phi(), c.mass())), p4c_( new LorentzVector(*p4_)), vertex_(0,0,0), pdgId_(c.pdgId()), charge_(c.charge()), mother_(c.motherRef(0)),
      statusFlags_(c.statusFlags()) { pack(); }

pat::PackedGenParticle::PackedGenParticle ( const reco::GenParticle &  c, const edm::Ref< reco::GenParticleCollection > &  mother  )

inlineexplicit

Definition at line 43 of file PackedGenParticle.h.

References pack().

    : p4_(new PolarLorentzVector(c.pt(), c.eta(), c.phi(), c.mass())), p4c_(new LorentzVector(*p4_)), vertex_(0,0,0), pdgId_(c.pdgId()), charge_(c.charge()), mother_(mother),
      statusFlags_(c.statusFlags()) { pack(); }

pat::PackedGenParticle::PackedGenParticle ( const PackedGenParticle &  iOther )

inline

Definition at line 47 of file PackedGenParticle.h.

References p4_, and p4c_.

    : packedPt_(iOther.packedPt_), packedY_(iOther.packedY_), packedPhi_(iOther.packedPhi_), packedM_(iOther.packedM_),
      p4_(nullptr),p4c_(nullptr),
      vertex_(iOther.vertex_), dxy_(iOther.dxy_), dz_(iOther.dz_),dphi_(iOther.dphi_),
      pdgId_(iOther.pdgId_),charge_(iOther.charge_),mother_(iOther.mother_),
      statusFlags_(iOther.statusFlags_) {
      if(iOther.p4c_) {
        p4_.store( new PolarLorentzVector(*iOther.p4_) );
        p4c_.store( new LorentzVector(*iOther.p4c_) );
      }
    }

pat::PackedGenParticle::PackedGenParticle ( PackedGenParticle &&  iOther )

inline

Definition at line 59 of file PackedGenParticle.h.

References p4_, and p4c_.

    : packedPt_(iOther.packedPt_), packedY_(iOther.packedY_), packedPhi_(iOther.packedPhi_), packedM_(iOther.packedM_),
      p4_(nullptr),p4c_(nullptr),
      vertex_(std::move(iOther.vertex_)), dxy_(iOther.dxy_), dz_(iOther.dz_),dphi_(iOther.dphi_),
      pdgId_(iOther.pdgId_),charge_(iOther.charge_),mother_(std::move(iOther.mother_)),
      statusFlags_(iOther.statusFlags_) {
      if(iOther.p4c_) {
        p4_.store( p4_.exchange(nullptr) );
        p4c_.store( p4c_.exchange(nullptr) );
      }
    }

pat::PackedGenParticle::~PackedGenParticle ( )

virtual

destructor

Definition at line 44 of file PackedGenParticle.cc.

                                         {
  delete p4_.load();
  delete p4c_.load();
 }

Member Function Documentation

virtual Vector pat::PackedGenParticle::boostToCM ( ) const

inlinevirtual

boost vector to boost a Lorentz vector to the particle center of mass system

Implements reco::Candidate.

Definition at line 148 of file PackedGenParticle.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->BoostToCM(); }

virtual int pat::PackedGenParticle::charge ( ) const

inlinevirtual

electric charge

Implements reco::Candidate.

Definition at line 131 of file PackedGenParticle.h.

References charge_.

Referenced by setCharge(), and threeCharge().

                               {
    return charge_; 
    }

virtual PackedGenParticle* pat::PackedGenParticle::clone ( void  ) const

inlinevirtual

returns a clone of the Candidate object

Implements reco::Candidate.

Definition at line 254 of file PackedGenParticle.h.

References PackedGenParticle().

                                               {
      return new PackedGenParticle( *this );
    }

const reco::Candidate * pat::PackedGenParticle::daughter ( size_type  ) const

virtual

return daughter at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 97 of file PackedGenParticle.cc.

                                                                      {
  return 0;
}

reco::Candidate * pat::PackedGenParticle::daughter ( size_type  )

virtual

return daughter at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 119 of file PackedGenParticle.cc.

                                                          {
  return 0;
}

reco::Candidate * pat::PackedGenParticle::daughter ( const std::string &  s )

virtual

return daughter with a specified role name

Implements reco::Candidate.

Definition at line 111 of file PackedGenParticle.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                               {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "This Candidate type does not implement daughter(std::string). "
    << "Please use CompositeCandidate or NamedCompositeCandidate.\n";
}

const reco::Candidate * pat::PackedGenParticle::daughter ( const std::string &  s ) const

virtual

return daughter with a specified role name

Implements reco::Candidate.

Definition at line 105 of file PackedGenParticle.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                                           {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "This Candidate type does not implement daughter(std::string). "
    << "Please use CompositeCandidate or NamedCompositeCandidate.\n";
}

virtual float pat::PackedGenParticle::dxy ( ) const

inlinevirtual

dxy with respect to the PV ref

Definition at line 223 of file PackedGenParticle.h.

References dxy_, and unpack().

Referenced by Electron.Electron::cutBasedId().

{ unpack(); return dxy_; }

float pat::PackedGenParticle::dxy ( const Point &  p ) const

virtual

dxy with respect to another point

Definition at line 50 of file PackedGenParticle.cc.

References funct::cos(), funct::sin(), and timeUnitHelper::unpack().

Referenced by Electron.Electron::cutBasedId().

                                                    {
    unpack();
    return -(vertex_.X()-p.X()) * std::sin(float(p4_.load()->Phi())) + (vertex_.Y()-p.Y()) * std::cos(float(p4_.load()->Phi()));
}

virtual float pat::PackedGenParticle::dz ( ) const

inlinevirtual

dz with respect to the PV ref

Definition at line 225 of file PackedGenParticle.h.

References dz_, and unpack().

Referenced by Electron.Electron::cutBasedId().

{ unpack(); return dz_; }

float pat::PackedGenParticle::dz ( const Point &  p ) const

virtual

dz with respect to another point

Definition at line 54 of file PackedGenParticle.cc.

References funct::cos(), funct::sin(), and timeUnitHelper::unpack().

Referenced by Electron.Electron::cutBasedId().

                                                   {
    unpack();
    return (vertex_.Z()-p.X())  - ((vertex_.X()-p.X()) * std::cos(float(p4_.load()->Phi())) + (vertex_.Y()-p.Y()) * std::sin(float(p4_.load()->Phi()))) * p4_.load()->Pz()/p4_.load()->Pt();
}

virtual double pat::PackedGenParticle::energy ( ) const

inlinevirtual

energy

Implements reco::Candidate.

Definition at line 152 of file PackedGenParticle.h.

References p4c_, and unpack().

Referenced by Jet.Jet::rawEnergy().

{ if (!p4c_) unpack(); return p4c_.load()->E(); }

double pat::PackedGenParticle::et ( ) const

inlinevirtual

transverse energy

Implements reco::Candidate.

Definition at line 154 of file PackedGenParticle.h.

References p4c_, and pt().

{ return (pt()<=0) ? 0 : p4c_.load()->Et(); }

double pat::PackedGenParticle::et2 ( ) const

inlinevirtual

transverse energy squared (use this for cuts)!

Implements reco::Candidate.

Definition at line 156 of file PackedGenParticle.h.

References p4c_, and pt().

{ return (pt()<=0) ? 0 : p4c_.load()->Et2(); }

virtual double pat::PackedGenParticle::eta ( ) const

inlinevirtual

momentum pseudorapidity

Implements reco::Candidate.

Definition at line 179 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), Jet.Jet::jetID(), and Jet.Jet::puJetId().

{ if (!p4c_) unpack(); return p4_.load()->Eta(); }

void pat::PackedGenParticle::fillVertexCovariance ( CovarianceMatrix &  v ) const

virtual

fill SMatrix

Implements reco::Candidate.

Definition at line 140 of file PackedGenParticle.cc.

References Exception, and edm::errors::UnimplementedFeature.

Referenced by vertexCovariance().

                                                                            {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "reco::ConcreteCandidate does not implement vertex covariant matrix.\n";
}

bool pat::PackedGenParticle::fromHardProcessFinalState ( ) const

inline

Definition at line 332 of file PackedGenParticle.h.

References reco::GenStatusFlags::fromHardProcess(), status(), and statusFlags_.

{ return status()==1 && statusFlags_.fromHardProcess(); }

bool pat::PackedGenParticle::hasMasterClone ( ) const

virtual

returns true if this candidate has a reference to a master clone. This only happens if the concrete Candidate type is ShallowCloneCandidate

Implements reco::Candidate.

Definition at line 68 of file PackedGenParticle.cc.

                                                {
  return false;
}

bool pat::PackedGenParticle::hasMasterClonePtr ( ) const

virtual

returns true if this candidate has a ptr to a master clone. This only happens if the concrete Candidate type is ShallowClonePtrCandidate

Implements reco::Candidate.

Definition at line 72 of file PackedGenParticle.cc.

                                                   {
  return false;
}

bool pat::PackedGenParticle::isCaloMuon ( ) const

virtual

Implements reco::Candidate.

Definition at line 155 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isConvertedPhoton ( ) const

virtual

Implements reco::Candidate.

Definition at line 159 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isDirectHardProcessTauDecayProductFinalState ( ) const

inline

Definition at line 336 of file PackedGenParticle.h.

References reco::GenStatusFlags::isDirectHardProcessTauDecayProduct(), status(), and statusFlags_.

{ return status()==1 && statusFlags_.isDirectHardProcessTauDecayProduct(); }

bool pat::PackedGenParticle::isDirectPromptTauDecayProductFinalState ( ) const

inline

Definition at line 321 of file PackedGenParticle.h.

References reco::GenStatusFlags::isDirectPromptTauDecayProduct(), status(), and statusFlags_.

{ return status()==1 && statusFlags_.isDirectPromptTauDecayProduct(); }

bool pat::PackedGenParticle::isElectron ( ) const

virtual

get a component

Implements reco::Candidate.

Definition at line 145 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isGlobalMuon ( ) const

virtual

Implements reco::Candidate.

Definition at line 149 of file PackedGenParticle.cc.

Referenced by Muon.Muon::muonID().

{ return false; }

bool pat::PackedGenParticle::isJet ( ) const

virtual

Implements reco::Candidate.

Definition at line 161 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isMuon ( ) const

virtual

Implements reco::Candidate.

Definition at line 147 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isPhoton ( ) const

virtual

Implements reco::Candidate.

Definition at line 157 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isPromptFinalState ( ) const

inline

Definition at line 317 of file PackedGenParticle.h.

References reco::GenStatusFlags::isPrompt(), status(), and statusFlags_.

{ return status()==1 && statusFlags_.isPrompt(); }

bool pat::PackedGenParticle::isStandAloneMuon ( ) const

virtual

Implements reco::Candidate.

Definition at line 151 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::isTrackerMuon ( ) const

virtual

Implements reco::Candidate.

Definition at line 153 of file PackedGenParticle.cc.

{ return false; }

bool pat::PackedGenParticle::longLived ( ) const

virtual

is long lived?

Implements reco::Candidate.

Definition at line 163 of file PackedGenParticle.cc.

{return false;}

virtual double pat::PackedGenParticle::mass ( ) const

inlinevirtual

mass

Implements reco::Candidate.

Definition at line 158 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), and DiObject.DiMuon::__str__().

{ if (!p4c_) unpack(); return p4_.load()->M(); }

bool pat::PackedGenParticle::massConstraint ( ) const

virtual

do mass constraint?

Implements reco::Candidate.

Definition at line 165 of file PackedGenParticle.cc.

{return false;}

virtual double pat::PackedGenParticle::massSqr ( ) const

inlinevirtual

mass squared

Implements reco::Candidate.

Definition at line 160 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->M()*p4_.load()->M(); }

const reco::CandidateBaseRef & pat::PackedGenParticle::masterClone ( ) const

virtual

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowCloneCandidate

Implements reco::Candidate.

Definition at line 62 of file PackedGenParticle.cc.

References Exception.

Referenced by masterRef().

                                                                     {
  throw cms::Exception("Invalid Reference")
    << "this Candidate has no master clone reference."
    << "Can't call masterClone() method.\n";
}

const reco::CandidatePtr & pat::PackedGenParticle::masterClonePtr ( ) const

virtual

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowClonePtrCandidate

Implements reco::Candidate.

Definition at line 77 of file PackedGenParticle.cc.

References Exception.

                                                                    {
  throw cms::Exception("Invalid Reference")
    << "this Candidate has no master clone ptr."
    << "Can't call masterClonePtr() method.\n";
}

template<typename Ref >

Ref pat::PackedGenParticle::masterRef ( ) const

inline

cast master clone reference to a concrete type

Definition at line 291 of file PackedGenParticle.h.

References masterClone().

{ return masterClone().template castTo<Ref>(); }

virtual Vector pat::PackedGenParticle::momentum ( ) const

inlinevirtual

spatial momentum vector

Implements reco::Candidate.

Definition at line 145 of file PackedGenParticle.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->Vect(); }

const reco::Candidate * pat::PackedGenParticle::mother ( size_type  ) const

virtual

return mother at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 101 of file PackedGenParticle.cc.

References reco::Candidate::get().

                                                                    {
  return mother_.get();
}

const reco::GenParticleRef& pat::PackedGenParticle::motherRef ( ) const

inline

direct access to the mother reference (may be null)

Definition at line 113 of file PackedGenParticle.h.

References mother_.

{ return mother_; }

virtual double pat::PackedGenParticle::mt ( ) const

inlinevirtual

transverse mass

Implements reco::Candidate.

Definition at line 163 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Mt(); }

virtual double pat::PackedGenParticle::mtSqr ( ) const

inlinevirtual

transverse mass squared

Implements reco::Candidate.

Definition at line 165 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Mt2(); }

size_t pat::PackedGenParticle::numberOfDaughters ( ) const

virtual

number of daughters

Implements reco::Candidate.

Definition at line 83 of file PackedGenParticle.cc.

                                                     { 
  return 0; 
}

size_t pat::PackedGenParticle::numberOfMothers ( ) const

virtual

number of mothers

Implements reco::Candidate.

Definition at line 87 of file PackedGenParticle.cc.

                                                   { 
  if(mother_.isNonnull())   return 1; 
  return 0;
}

virtual size_t pat::PackedGenParticle::numberOfSourceCandidatePtrs ( ) const

inlinevirtual

return the number of source Candidates ( the candidates used to construct this Candidate)

Implements reco::Candidate.

Definition at line 123 of file PackedGenParticle.h.

{return 0;}

PackedGenParticle& pat::PackedGenParticle::operator= ( PackedGenParticle &&  iOther )

inline

Definition at line 71 of file PackedGenParticle.h.

References charge_, dphi_, dxy_, dz_, mother_, eostools::move(), p4_, p4c_, packedM_, packedPhi_, packedPt_, packedY_, pdgId_, statusFlags_, and vertex_.

                                                             {
      if(this != &iOther) {
        packedPt_ = iOther.packedPt_;
        packedY_ = iOther.packedY_;
        packedPhi_ = iOther.packedPhi_;
        packedM_ = iOther.packedM_;
        if(p4c_) {
          delete p4_.exchange(iOther.p4_.exchange(nullptr));
          delete p4c_.exchange(iOther.p4c_.exchange(nullptr)) ;
        } else {
          delete p4_.exchange(nullptr);
          delete p4c_.exchange(nullptr);
        }
        vertex_=std::move(iOther.vertex_);
        dxy_ = iOther.dxy_;
        dz_ = iOther.dz_;
        dphi_ = iOther.dphi_;
        pdgId_ = iOther.pdgId_;
        charge_ = iOther.charge_;
        mother_ = std::move(iOther.mother_);
        statusFlags_ = iOther.statusFlags_;
      }
      return *this;
    }

PackedGenParticle& pat::PackedGenParticle::operator= ( PackedGenParticle const &  iOther )

inline

Definition at line 96 of file PackedGenParticle.h.

References EnergyCorrector::c, and eostools::move().

                                                                  {
      PackedGenParticle c(iOther);
      *this = std::move(c);
      return *this;
    }

bool pat::PackedGenParticle::overlap ( const reco::Candidate &  o ) const

protectedvirtual

check overlap with another Candidate

Implements reco::Candidate.

Definition at line 92 of file PackedGenParticle.cc.

References RecoTauCleanerPlugins::charge, reco::Candidate::charge(), reco::Candidate::p4(), p4, and reco::Candidate::vertex().

                                                                  { 
  return  p4() == o.p4() && vertex() == o.vertex() && charge() == o.charge();
//  return  p4() == o.p4() && charge() == o.charge();
}

virtual double pat::PackedGenParticle::p ( ) const

inlinevirtual

magnitude of momentum vector

Implements reco::Candidate.

Definition at line 150 of file PackedGenParticle.h.

References p4c_, and unpack().

Referenced by Electron.Electron::ptErr().

{ if (!p4c_) unpack(); return p4c_.load()->P(); }

virtual const LorentzVector& pat::PackedGenParticle::p4 ( ) const

inlinevirtual

four-momentum Lorentz vecto r

Implements reco::Candidate.

Definition at line 141 of file PackedGenParticle.h.

References p4c_, and unpack().

Referenced by Tau.Tau::dxy_approx(), Tau.Tau::dz(), Lepton.Lepton::p4WithFSR(), and setP4().

{ if (!p4c_) unpack(); return *p4c_; }  

void pat::PackedGenParticle::pack ( bool  unpackAfterwards = true )

protected

Definition at line 7 of file PackedGenParticle.cc.

References MiniFloatConverter::float32to16(), bookConverter::max, p4_, p4c_, packedM_, packedPhi_, packedPt_, packedY_, and unpack().

Referenced by pyrootRender.interactiveRender::draw(), PackedGenParticle(), setMass(), setP4(), and setPz().

                                                     {
    packedPt_  =  MiniFloatConverter::float32to16(p4_.load()->Pt());
    packedY_ =  int16_t(p4_.load()->Rapidity()/6.0f*std::numeric_limits<int16_t>::max());
    packedPhi_ =  int16_t(p4_.load()->Phi()/3.2f*std::numeric_limits<int16_t>::max());
    packedM_   =  MiniFloatConverter::float32to16(p4_.load()->M());
    if (unpackAfterwards) {
      delete p4_.exchange(nullptr);
      delete p4c_.exchange(nullptr);
      unpack(); // force the values to match with the packed ones
    }
}

virtual int pat::PackedGenParticle::pdgId ( ) const

inlinevirtual

PDG identifier.

Implements reco::Candidate.

Definition at line 233 of file PackedGenParticle.h.

References pdgId_.

Referenced by Particle.Particle::__str__(), and setPdgId().

{ return pdgId_; }

virtual double pat::PackedGenParticle::phi ( ) const

inlinevirtual

momentum azimuthal angle

Implements reco::Candidate.

Definition at line 175 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__().

{ if (!p4c_) unpack(); return p4_.load()->Phi(); }

virtual const PolarLorentzVector& pat::PackedGenParticle::polarP4 ( ) const

inlinevirtual

four-momentum Lorentz vector

Implements reco::Candidate.

Definition at line 143 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return *p4_; }

virtual double pat::PackedGenParticle::pt ( void  ) const

inlinevirtual

transverse momentum

Implements reco::Candidate.

Definition at line 173 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), et(), et2(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), Electron.Electron::ptErr(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), and Jet.Jet::setCorrP4().

{ if (!p4c_) unpack(); return p4_.load()->Pt();}

virtual double pat::PackedGenParticle::px ( ) const

inlinevirtual

x coordinate of momentum vector

Implements reco::Candidate.

Definition at line 167 of file PackedGenParticle.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->Px(); }

virtual double pat::PackedGenParticle::py ( ) const

inlinevirtual

y coordinate of momentum vector

Implements reco::Candidate.

Definition at line 169 of file PackedGenParticle.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->Py(); }

virtual double pat::PackedGenParticle::pz ( ) const

inlinevirtual

z coordinate of momentum vector

Implements reco::Candidate.

Definition at line 171 of file PackedGenParticle.h.

References p4c_, and unpack().

Referenced by setPz().

{ if (!p4c_) unpack(); return p4c_.load()->Pz(); }

virtual double pat::PackedGenParticle::rapidity ( ) const

inlinevirtual

rapidity

Implements reco::Candidate.

Definition at line 181 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Rapidity(); }

virtual void pat::PackedGenParticle::setCharge ( int  charge )

inlinevirtual

set electric charge

Implements reco::Candidate.

Definition at line 135 of file PackedGenParticle.h.

References charge(), and charge_.

{charge_=charge;}

virtual void pat::PackedGenParticle::setLongLived ( )

inlinevirtual

set long lived flag

Implements reco::Candidate.

Definition at line 243 of file PackedGenParticle.h.

{} /*FIXME*/

virtual void pat::PackedGenParticle::setMass ( double  m )

inlinevirtual

set particle mass

Implements reco::Candidate.

Definition at line 197 of file PackedGenParticle.h.

References visualization-live-secondInstance_cfg::m, p4_, p4c_, pack(), and unpack().

                                     {
      if (!p4c_) unpack(); 
      *p4_ = PolarLorentzVector(p4_.load()->Pt(), p4_.load()->Eta(), p4_.load()->Phi(), m); 
      pack();
    }

virtual void pat::PackedGenParticle::setMassConstraint ( )

inlinevirtual

set mass constraint flag

Implements reco::Candidate.

Definition at line 249 of file PackedGenParticle.h.

{} /*FIXME*/

virtual void pat::PackedGenParticle::setP4 ( const LorentzVector &  p4 )

inlinevirtual

set 4-momentum

Implements reco::Candidate.

Definition at line 185 of file PackedGenParticle.h.

References p4_, pack(), and unpack().

Referenced by Jet.Jet::setCorrP4().

                                                   { 
        unpack(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
        *p4_ = PolarLorentzVector(p4.Pt(), p4.Eta(), p4.Phi(), p4.M());
        pack();
    }

virtual void pat::PackedGenParticle::setP4 ( const PolarLorentzVector &  p4 )

inlinevirtual

set 4-momentum

Definition at line 191 of file PackedGenParticle.h.

References p4(), p4_, pack(), and unpack().

Referenced by Jet.Jet::setCorrP4().

                                                        { 
        unpack(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
        *p4_ = p4; 
        pack();
    }

virtual void pat::PackedGenParticle::setPdgId ( int  pdgId )

inlinevirtual

Implements reco::Candidate.

Definition at line 235 of file PackedGenParticle.h.

References pdgId(), and pdgId_.

{ pdgId_ = pdgId; }

virtual void pat::PackedGenParticle::setPz ( double  pz )

inlinevirtual

Implements reco::Candidate.

Definition at line 202 of file PackedGenParticle.h.

References p4_, p4c_, pack(), pz(), and unpack().

                                    {
      unpack(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
      *p4c_ = LorentzVector(p4c_.load()->Px(), p4c_.load()->Py(), pz, p4c_.load()->E());
      *p4_  = PolarLorentzVector(p4c_.load()->Pt(), p4c_.load()->Eta(), p4c_.load()->Phi(), p4c_.load()->M());
      pack();
    }

virtual void pat::PackedGenParticle::setStatus ( int  status )

inlinevirtual

set status word

Implements reco::Candidate.

Definition at line 239 of file PackedGenParticle.h.

{} /*FIXME*/

virtual void pat::PackedGenParticle::setThreeCharge ( int  threecharge )

inlinevirtual

set electric charge

Implements reco::Candidate.

Definition at line 139 of file PackedGenParticle.h.

{}

virtual void pat::PackedGenParticle::setVertex ( const Point &  vertex )

inlinevirtual

set vertex

Definition at line 217 of file PackedGenParticle.h.

References vertex(), and vertex_.

{ vertex_ = vertex;  }

virtual reco::CandidatePtr pat::PackedGenParticle::sourceCandidatePtr ( size_type  i ) const

inlinevirtual

return a Ptr to one of the source Candidates ( the candidates used to construct this Candidate)

Reimplemented from reco::Candidate.

Definition at line 126 of file PackedGenParticle.h.

                                                                     {
      return reco::CandidatePtr();
    }

virtual int pat::PackedGenParticle::status ( ) const

inlinevirtual

status word

Implements reco::Candidate.

Definition at line 237 of file PackedGenParticle.h.

Referenced by fromHardProcessFinalState(), isDirectHardProcessTauDecayProductFinalState(), isDirectPromptTauDecayProductFinalState(), and isPromptFinalState().

{ return 1; } /*FIXME*/

const reco::GenStatusFlags& pat::PackedGenParticle::statusFlags ( ) const

inline

Definition at line 304 of file PackedGenParticle.h.

References statusFlags_.

{ return statusFlags_; }

reco::GenStatusFlags& pat::PackedGenParticle::statusFlags ( )

inline

Definition at line 305 of file PackedGenParticle.h.

References statusFlags_.

{ return statusFlags_; }

virtual double pat::PackedGenParticle::theta ( ) const

inlinevirtual

momentum polar angle

Implements reco::Candidate.

Definition at line 177 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by Tau.Tau::zImpact().

{ if (!p4c_) unpack(); return p4_.load()->Theta(); }

virtual int pat::PackedGenParticle::threeCharge ( ) const

inlinevirtual

electric charge

Implements reco::Candidate.

Definition at line 137 of file PackedGenParticle.h.

References charge().

{return charge()*3;}

void pat::PackedGenParticle::unpack ( ) const

protected

Definition at line 20 of file PackedGenParticle.cc.

References eta, MiniFloatConverter::float16to32(), visualization-live-secondInstance_cfg::m, bookConverter::max, p4, phi(), EnergyCorrector::pt, edm::shift, jetcorrextractor::sign(), and mathSSE::sqrt().

Referenced by boostToCM(), dxy(), dz(), energy(), eta(), mass(), massSqr(), momentum(), mt(), mtSqr(), p(), p4(), pack(), phi(), polarP4(), pt(), px(), py(), pz(), rapidity(), setMass(), setP4(), setPz(), theta(), and y().

                                        {
    float y = int16_t(packedY_)*6.0f/std::numeric_limits<int16_t>::max();
    float pt=MiniFloatConverter::float16to32(packedPt_);
    float m=MiniFloatConverter::float16to32(packedM_);
    float pz = std::tanh(y)*std::sqrt((m*m+pt*pt)/(1.-std::tanh(y)*std::tanh(y)));
    float eta = 0;
    if(pt != 0.) {
      eta = std::asinh(pz/pt);
    }
    double shift = (pt<1. ? 0.1*pt : 0.1/pt); // shift particle phi to break degeneracies in angular separations
    double sign = ( ( int(pt*10) % 2 == 0 ) ? 1 : -1 ); // introduce a pseudo-random sign of the shift
    double phi = int16_t(packedPhi_)*3.2f/std::numeric_limits<int16_t>::max() + sign*shift*3.2/std::numeric_limits<int16_t>::max();
    auto p4 = std::make_unique<PolarLorentzVector>(pt,eta,phi,m);
    PolarLorentzVector* expectp4 = nullptr;
    if(p4_.compare_exchange_strong(expectp4,p4.get())) {
      p4.release();
    }
    auto p4c = std::make_unique<LorentzVector>(*p4_);
    LorentzVector* expectp4c = nullptr;
    if(p4c_.compare_exchange_strong(expectp4c,p4c.get())) {
      p4c.release();
    }
}

virtual const Point& pat::PackedGenParticle::vertex ( ) const

inlinevirtual

vertex position

Implements reco::Candidate.

Definition at line 209 of file PackedGenParticle.h.

References vertex_.

Referenced by Tau.Tau::dxy(), and setVertex().

{ return vertex_; }//{ if (fromPV_) return Point(0,0,0); else return Point(0,0,100); }

double pat::PackedGenParticle::vertexChi2 ( ) const

virtual

chi-squares

Implements reco::Candidate.

Definition at line 123 of file PackedGenParticle.cc.

                                              {
  return 0;
}

double pat::PackedGenParticle::vertexCovariance ( int  i, int  j  ) const

virtual

(i, j)-th element of error matrix, i, j = 0, ... 2

Implements reco::Candidate.

Definition at line 135 of file PackedGenParticle.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                                {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "reco::ConcreteCandidate does not implement vertex covariant matrix.\n";
}

CovarianceMatrix pat::PackedGenParticle::vertexCovariance ( ) const

inlinevirtual

return SMatrix

Reimplemented from reco::Candidate.

Definition at line 272 of file PackedGenParticle.h.

References fillVertexCovariance(), and visualization-live-secondInstance_cfg::m.

{ CovarianceMatrix m; fillVertexCovariance(m); return m; }

double pat::PackedGenParticle::vertexNdof ( ) const

virtual

Number of degrees of freedom Meant to be Double32_t for soft-assignment fitters: tracks may contribute to the vertex with fractional weights. The ndof is then = to the sum of the track weights. see e.g. CMS NOTE-2006/032, CMS NOTE-2004/002

Implements reco::Candidate.

Definition at line 127 of file PackedGenParticle.cc.

                                              {
  return 0;
}

double pat::PackedGenParticle::vertexNormalizedChi2 ( ) const

virtual

chi-squared divided by n.d.o.f.

Implements reco::Candidate.

Definition at line 131 of file PackedGenParticle.cc.

                                                        {
  return 0;
}

virtual double pat::PackedGenParticle::vx ( ) const

inlinevirtual

x coordinate of vertex position

Implements reco::Candidate.

Definition at line 211 of file PackedGenParticle.h.

References vertex_.

{  return vertex_.X(); }//{ return 0; }

virtual double pat::PackedGenParticle::vy ( ) const

inlinevirtual

y coordinate of vertex position

Implements reco::Candidate.

Definition at line 213 of file PackedGenParticle.h.

References vertex_.

{  return vertex_.Y(); }//{ return 0; }

virtual double pat::PackedGenParticle::vz ( ) const

inlinevirtual

z coordinate of vertex position

Implements reco::Candidate.

Definition at line 215 of file PackedGenParticle.h.

References vertex_.

{  return vertex_.Z(); }//{ if (fromPV_) return 0; else return 100; }

virtual double pat::PackedGenParticle::y ( ) const

inlinevirtual

rapidity

Implements reco::Candidate.

Definition at line 183 of file PackedGenParticle.h.

References p4_, p4c_, and unpack().

Referenced by svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), geometryXMLparser.Alignable::pos(), and Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget().

{ if (!p4c_) unpack(); return p4_.load()->Rapidity(); }

Friends And Related Function Documentation

friend class ::OverlapChecker

friend

Definition at line 362 of file PackedGenParticle.h.

friend class ::testPackedGenParticle

friend

Definition at line 21 of file PackedGenParticle.h.

template<typename , typename , typename >

friend struct component

friend

Definition at line 361 of file PackedGenParticle.h.

friend class ShallowCloneCandidate

friend

Definition at line 363 of file PackedGenParticle.h.

friend class ShallowClonePtrCandidate

friend

Definition at line 364 of file PackedGenParticle.h.

Member Data Documentation

int8_t pat::PackedGenParticle::charge_

protected

Charge.

Definition at line 353 of file PackedGenParticle.h.

Referenced by charge(), operator=(), and setCharge().

float pat::PackedGenParticle::dphi_

protected

Definition at line 349 of file PackedGenParticle.h.

Referenced by operator=().

float pat::PackedGenParticle::dxy_

protected

Definition at line 349 of file PackedGenParticle.h.

Referenced by dxy(), and operator=().

float pat::PackedGenParticle::dz_

protected

Definition at line 349 of file PackedGenParticle.h.

Referenced by dz(), and operator=().

const unsigned int pat::PackedGenParticle::longLivedTag = 0

static

long lived flag

Definition at line 241 of file PackedGenParticle.h.

const unsigned int pat::PackedGenParticle::massConstraintTag = 0

static

do mass constraint flag

Definition at line 247 of file PackedGenParticle.h.

reco::GenParticleRef pat::PackedGenParticle::mother_

protected

Ref to first mother.

Definition at line 355 of file PackedGenParticle.h.

Referenced by motherRef(), and operator=().

std::atomic<PolarLorentzVector*> pat::PackedGenParticle::p4_

mutableprotected

the four vector

Definition at line 345 of file PackedGenParticle.h.

Referenced by eta(), mass(), massSqr(), mt(), mtSqr(), operator=(), pack(), PackedGenParticle(), phi(), polarP4(), pt(), rapidity(), setMass(), setP4(), setPz(), theta(), and y().

std::atomic<LorentzVector*> pat::PackedGenParticle::p4c_

mutableprotected

Definition at line 346 of file PackedGenParticle.h.

Referenced by boostToCM(), energy(), et(), et2(), eta(), mass(), massSqr(), momentum(), mt(), mtSqr(), operator=(), p(), p4(), pack(), PackedGenParticle(), phi(), polarP4(), pt(), px(), py(), pz(), rapidity(), setMass(), setPz(), theta(), and y().

uint16_t pat::PackedGenParticle::packedM_

protected

Definition at line 340 of file PackedGenParticle.h.

Referenced by operator=(), and pack().

uint16_t pat::PackedGenParticle::packedPhi_

protected

Definition at line 340 of file PackedGenParticle.h.

Referenced by operator=(), and pack().

uint16_t pat::PackedGenParticle::packedPt_

protected

Definition at line 340 of file PackedGenParticle.h.

Referenced by operator=(), and pack().

uint16_t pat::PackedGenParticle::packedY_

protected

Definition at line 340 of file PackedGenParticle.h.

Referenced by operator=(), and pack().

int pat::PackedGenParticle::pdgId_

protected

PDG identifier.

Definition at line 351 of file PackedGenParticle.h.

Referenced by operator=(), pdgId(), and setPdgId().

reco::GenStatusFlags pat::PackedGenParticle::statusFlags_

protected

Definition at line 357 of file PackedGenParticle.h.

Referenced by fromHardProcessFinalState(), isDirectHardProcessTauDecayProductFinalState(), isDirectPromptTauDecayProductFinalState(), isPromptFinalState(), operator=(), and statusFlags().

Point pat::PackedGenParticle::vertex_

protected

vertex position

Definition at line 348 of file PackedGenParticle.h.

Referenced by operator=(), setVertex(), vertex(), vx(), vy(), and vz().