ParticleIdUtils.hh File Reference

#include "Rivet/Tools/ParticleName.hh"
#include "Rivet/Math/MathUtils.hh"

Go to the source code of this file.

Namespaces
namespace	Rivet
namespace	Rivet::PID
Functions
Nucleus/ion functions
bool	isNucleus (int pid)
	Is this a nucleus PID?
int	nuclZ (int pid)
int	Z (int pid)
int	nuclA (int pid)
int	A (int pid)
int	nuclNlambda (int pid)
int	lambda (int pid)
Quark composite functions
bool	isReggeon (int pid)
	Is this a pomeron, odderon, or generic reggeon?
bool	isMeson (int pid)
	Check to see if this is a valid meson.
bool	isBaryon (int pid)
	Check to see if this is a valid baryon.
bool	isDiquark (int pid)
bool	isDiQuark (int pid)
bool	isPentaquark (int pid)
	Check to see if this is a valid pentaquark.
bool	isHadron (int pid)
	Is this a valid hadron ID?
More general particle class identification functions
bool	isLepton (int pid)
	Is this a valid lepton ID?
bool	isSUSY (int pid)
	Is this a fundamental SUSY particle?
bool	isRhadron (int pid)
	Is this an R-hadron?
bool	isRHadron (int pid)
bool	isTechnicolor (int pid)
	Is this a technicolor particle?
bool	isExcited (int pid)
	Is this an excited (composite) quark or lepton?
bool	isKK (int pid)
	Is this a Kaluza-Klein excitation?
bool	isGraviton (int pid)
	Is this a graviton?
bool	isBSM (int pid)
	Is this a BSM particle (including graviton)?
bool	_isValid (int pid)
	Check to see if this is a valid PID (i.e. matches any known scheme)
bool	isValid (int pid)
Parton content functions
bool	_hasQ (int pid, int q)
bool	hasDown (int pid)
	Does this particle contain a down quark?
bool	hasUp (int pid)
	Does this particle contain an up quark?
bool	hasStrange (int pid)
	Does this particle contain a strange quark?
bool	hasCharm (int pid)
	Does this particle contain a charm quark?
bool	hasBottom (int pid)
	Does this particle contain a bottom quark?
bool	hasTop (int pid)
	Does this particle contain a top quark?
Angular momentum functions
int	jSpin (int pid)
	jSpin returns 2J+1, where J is the total spin
int	sSpin (int pid)
	sSpin returns 2S+1, where S is the spin
int	lSpin (int pid)
	lSpin returns 2L+1, where L is the orbital angular momentum
Charge functions
int	charge3 (int pid)
	Three times the EM charge (as integer)
int	threeCharge (int pid)
int	abscharge3 (int pid)
	Return the absolute value of 3 times the EM charge.
double	charge (int pid)
	Return the EM charge (as floating point)
double	abscharge (int pid)
	Return the absolute value of the EM charge (as floating point)
General PID-based classifier functions
bool	isCharged (int pid)
	Determine if the particle is electrically charged.
bool	isNeutral (int pid)
	Determine if the particle is electrically neutral.
Fundamental particles
bool	isQuark (int pid)
	Determine if the PID is that of a quark.
bool	isGluon (int pid)
	Determine if the PID is that of a gluon.
bool	isParton (int pid)
	Determine if the PID is that of a parton (quark or gluon)
bool	isPhoton (int pid)
	Determine if the PID is that of a photon.
bool	isElectron (int pid)
	Determine if the PID is that of an electron or positron.
bool	isMuon (int pid)
	Determine if the PID is that of an muon or antimuon.
bool	isTau (int pid)
	Determine if the PID is that of an tau or antitau.
bool	isChargedLepton (int pid)
	Determine if the PID is that of a charged lepton.
bool	isChLepton (int pid)
bool	isNeutrino (int pid)
	Determine if the PID is that of a neutrino.
bool	isWplus (int pid)
	Determine if the PID is that of a W+.
bool	isWminus (int pid)
	Determine if the PID is that of a W-.
bool	isW (int pid)
	Determine if the PID is that of a W+-.
bool	isZ (int pid)
	Determine if the PID is that of a Z0.
bool	isHiggs (int pid)
	Determine if the PID is that of an SM/lightest SUSY Higgs.
bool	isStrange (int pid)
	Determine if the PID is that of a s/sbar.
bool	isCharm (int pid)
	Determine if the PID is that of a c/cbar.
bool	isBottom (int pid)
	Determine if the PID is that of a b/bbar.
bool	isTop (int pid)
	Determine if the PID is that of a t/tbar.
Hadron and parton flavour classification
bool	isHeavyFlavour (int pid)
	Determine if the particle is a heavy flavour hadron or parton.
bool	isHeavyParton (int pid)
	Determine if the PID is that of a heavy parton (c,b,t)
bool	isLightParton (int pid)
	Determine if the PID is that of a light parton (u,d,s)
bool	isHeavyMeson (int pid)
	Determine if the PID is that of a heavy flavour (b or c) meson.
bool	isHeavyBaryon (int pid)
	Determine if the PID is that of a heavy flavour (b or c) baryon.
bool	isHeavyHadron (int pid)
	Determine if the PID is that of a heavy flavour (b or c) hadron.
bool	isLightMeson (int pid)
	Determine if the PID is that of a light flavour (not b or c) meson.
bool	isLightBaryon (int pid)
	Determine if the PID is that of a light flavour (not b or c) baryon.
bool	isLightHadron (int pid)
	Determine if the PID is that of a light flavour (not b or c) hadron.
bool	isBottomMeson (int pid)
	Determine if the PID is that of a b-meson.
bool	isBottomBaryon (int pid)
	Determine if the PID is that of a b-baryon.
bool	isBottomHadron (int pid)
	Determine if the PID is that of a b-hadron.
bool	isCharmMeson (int pid)
	Determine if the PID is that of a c-meson.
bool	isCharmBaryon (int pid)
	Determine if the PID is that of a c-baryon.
bool	isCharmHadron (int pid)
bool	isStrangeMeson (int pid)
bool	isStrangeBaryon (int pid)
bool	isStrangeHadron (int pid)
Interaction classifiers
bool	isStrongInteracting (int pid)
	Determine if the PID is that of a strongly interacting particle.
bool	isEMInteracting (int pid)
	Determine if the PID is that of a electromagnetically interacting particle.
bool	isWeakInteracting (int pid)
Other classifiers
bool	isGenSpecific (int pid)
	Determine if the PID is in the generator-specific range.
bool	isResonance (int pid)
bool	isTransportable (int pid)
Utility functions
enum	Location {   nj = 1, nq3, nq2, nq1,   nl, nr, n, n8,   n9, n10 }
int	abspid (int pid)
unsigned short	_digit (Location loc, int pid)
	Split the PID into constituent integers.
int	_extraBits (int pid)
	Returns everything beyond the 7th digit (e.g. outside the numbering scheme)
int	_fundamentalID (int pid)
	Return the first two digits if this is a "fundamental" particle.