Classes
class	ParticleNames
Enumerations
enum	location { nj = 1, nq3, nq2, nq1, nl, nr, n, n8, n9, n10 }
Functions
const std::string &	toParticleName (PdgId p)
	Print a PdgId as a named string.
PdgId	toParticleId (const std::string &pname)
	Print a PdgId as a named string.
std::pair< PdgId, PdgId >	make_pdgid_pair (PdgId a, PdgId b)
	Convenience maker of particle ID pairs from PdgIds.
std::pair< PdgId, PdgId >	make_pdgid_pair (const std::string &a, const std::string &b)
	Convenience maker of particle ID pairs from particle names.
std::string	toBeamsString (const PdgIdPair &pair)
	Print a PdgIdPair as a string.
unsigned short	digit (location loc, const int &pid)
	return the digit at a named location in the PID
int	fundamentalID (const int &pid)
	extract fundamental ID (1-100) if this is a "fundamental" particle
int	extraBits (const int &pid)
	if this is a fundamental particle, does it have a valid antiparticle?
int	Z (const int &pid)
int	A (const int &pid)
int	lambda (const int &pid)
PID operations on Rivet::Particle wrapper
int	abspid (const int &pid)
	Absolute value of particle ID.
bool	isValid (const int &pid)
	Is this a valid ID?
bool	isMeson (const int &pid)
	Is this a valid meson ID?
bool	isBaryon (const int &pid)
	Is this a valid baryon ID?
bool	isDiQuark (const int &pid)
	Is this a valid diquark ID?
bool	isHadron (const int &pid)
	Is this a valid hadron ID?
bool	isLepton (const int &pid)
	Is this a valid lepton ID?
bool	isNeutrino (const int &pid)
	Is this a neutrino ID?
bool	isNucleus (const int &pid)
	Is this a valid ion ID?
bool	isPentaquark (const int &pid)
	Is this a valid pentaquark ID?
bool	isSUSY (const int &pid)
	Is this a valid SUSY ID?
bool	isRhadron (const int &pid)
	Is this a valid R-hadron ID?
bool	hasUp (const int &pid)
	Does this particle contain an up quark?
bool	hasDown (const int &pid)
	Does this particle contain a down quark?
bool	hasStrange (const int &pid)
	Does this particle contain a strange quark?
bool	hasCharm (const int &pid)
	Does this particle contain a charm quark?
bool	hasBottom (const int &pid)
	Does this particle contain a bottom quark?
bool	hasTop (const int &pid)
	Does this particle contain a top quark?
int	jSpin (const int &pid)
	jSpin returns 2J+1, where J is the total spin
int	sSpin (const int &pid)
	sSpin returns 2S+1, where S is the spin
int	lSpin (const int &pid)
	lSpin returns 2L+1, where L is the orbital angular momentum
int	threeCharge (const int &pid)
	Return 3 times the charge (3 x quark charge is an int)
double	charge (const int &pid)
	Return the charge.
int	abspid (const Particle &p)
	Absolute value of particle ID.
bool	isMeson (const Particle &p)
	Is this a valid meson ID?
bool	isBaryon (const Particle &p)
	Is this a valid baryon ID?
bool	isDiQuark (const Particle &p)
	Is this a valid diquark ID?
bool	isHadron (const Particle &p)
	Is this a valid hadron ID?
bool	isLepton (const Particle &p)
	Is this a valid lepton ID?
bool	isNucleus (const Particle &p)
	Is this a valid ion ID?
bool	isPentaquark (const Particle &p)
	Is this a valid pentaquark ID?
bool	isSUSY (const Particle &p)
	Is this a valid SUSY ID?
bool	isRhadron (const Particle &p)
	Is this a valid R-hadron ID?
bool	hasUp (const Particle &p)
	Does this particle contain an up quark?
bool	hasDown (const Particle &p)
	Does this particle contain a down quark?
bool	hasStrange (const Particle &p)
	Does this particle contain a strange quark?
bool	hasCharm (const Particle &p)
	Does this particle contain a charm quark?
bool	hasBottom (const Particle &p)
	Does this particle contain a bottom quark?
bool	hasTop (const Particle &p)
	Does this particle contain a top quark?
int	jSpin (const Particle &p)
	jSpin returns 2J+1, where J is the total spin
int	sSpin (const Particle &p)
	sSpin returns 2S+1, where S is the spin
int	lSpin (const Particle &p)
	lSpin returns 2L+1, where L is the orbital angular momentum
int	threeCharge (const Particle &p)
	Return 3 times the charge (3 x quark charge is an int)
double	charge (const Particle &p)
	Return the charge.
Variables
static const PdgId	ANY = 10000
	Static const convenience particle ID names.
Charged leptons
static const PdgId	ELECTRON = 11
static const PdgId	POSITRON = -ELECTRON
static const PdgId	EMINUS = ELECTRON
static const PdgId	EPLUS = POSITRON
static const PdgId	MUON = 13
static const PdgId	ANTIMUON = -MUON
static const PdgId	TAU = 15
static const PdgId	ANTITAU = -TAU
Neutrinos
static const PdgId	NU_E = 12
static const PdgId	NU_EBAR = -NU_E
static const PdgId	NU_MU = 14
static const PdgId	NU_MUBAR = -NU_MU
static const PdgId	NU_TAU = 16
static const PdgId	NU_TAUBAR = -NU_TAU
Bosons
static const PdgId	PHOTON = 22
static const PdgId	GAMMA = PHOTON
static const PdgId	GLUON = 21
static const PdgId	WPLUSBOSON = 24
static const PdgId	WMINUSBOSON = -WPLUSBOSON
static const PdgId	WPLUS = WPLUSBOSON
static const PdgId	WMINUS = WMINUSBOSON
static const PdgId	Z0BOSON = 23
static const PdgId	ZBOSON = Z0BOSON
static const PdgId	Z0 = Z0BOSON
static const PdgId	HIGGSBOSON = 25
static const PdgId	HIGGS = HIGGSBOSON
Quarks
static const PdgId	DQUARK = 1
static const PdgId	UQUARK = 2
static const PdgId	SQUARK = 3
static const PdgId	CQUARK = 4
static const PdgId	BQUARK = 5
static const PdgId	TQUARK = 6
Nucleons
static const PdgId	PROTON = 2212
static const PdgId	ANTIPROTON = -PROTON
static const PdgId	PBAR = ANTIPROTON
static const PdgId	NEUTRON = 2112
static const PdgId	ANTINEUTRON = -NEUTRON
Light mesons
static const PdgId	PI0 = 111
static const PdgId	PIPLUS = 211
static const PdgId	PIMINUS = -PIPLUS
static const PdgId	K0L = 130
static const PdgId	K0S = 310
static const PdgId	KPLUS = 321
static const PdgId	KMINUS = -KPLUS
static const PdgId	ETA = 221
static const PdgId	ETAPRIME = 331
static const PdgId	PHI = 333
static const PdgId	OMEGA = 223
Charmonia
static const PdgId	ETAC = 441
static const PdgId	JPSI = 443
static const PdgId	PSI2S = 100443
Charm mesons
static const PdgId	D0 = 421
static const PdgId	DPLUS = 411
static const PdgId	DMINUS = -DPLUS
static const PdgId	DSPLUS = 431
static const PdgId	DSMINUS = -DSPLUS
Bottomonia
static const PdgId	ETAB = 551
static const PdgId	UPSILON1S = 553
static const PdgId	UPSILON2S = 100553
static const PdgId	UPSILON3S = 200553
static const PdgId	UPSILON4S = 300553
b mesons
static const PdgId	B0 = 511
static const PdgId	BPLUS = 521
static const PdgId	BMINUS = -BPLUS
static const PdgId	B0S = 531
static const PdgId	BCPLUS = 541
static const PdgId	BCMINUS = -BCPLUS
Baryons
static const PdgId	LAMBDA = 3122
static const PdgId	SIGMA0 = 3212
static const PdgId	SIGMAPLUS = 3222
static const PdgId	SIGMAMINUS = 3112
static const PdgId	LAMBDACPLUS = 4122
static const PdgId	LAMBDACMINUS = 4122
static const PdgId	LAMBDAB = 5122
static const PdgId	XI0 = 3322
static const PdgId	XIMINUS = 3312
static const PdgId	XIPLUS = -XIMINUS
static const PdgId	OMEGAMINUS = 3334
static const PdgId	OMEGAPLUS = -OMEGAMINUS
Exotic/weird stuff
static const PdgId	REGGEON = 110
static const PdgId	POMERON = 990
static const PdgId	ODDERON = 9990
static const PdgId	GRAVITON = 39
static const PdgId	NEUTRALINO1 = 1000022
static const PdgId	GRAVITINO = 1000039
static const PdgId	GLUINO = 1000021

Enumeration Type Documentation

enum location

PID digits (base 10) are: n nr nl nq1 nq2 nq3 nj The location enum provides a convenient index into the PID.

Enumerator:

nj
nq3
nq2
nq1
nl
nr
n
n8
n9
n10

Definition at line 19 of file ParticleIdUtils.cc.

{ nj=1, nq3, nq2, nq1, nl, nr, n, n8, n9, n10 };

Function Documentation

int Rivet::PID::A ( const int & pid )

Definition at line 79 of file ParticleIdUtils.cc.

References abspid(), and isNucleus().

Referenced by Rivet::diagonalize().

    {
        // a proton can also be a Hydrogen nucleus
        if( abspid(pid) == 2212 ) { return 1; }
        if( isNucleus(pid) ) return (abspid(pid)/10)%1000;
        return 0;
    }

int Rivet::PID::abspid ( const Particle & p ) [inline]

Absolute value of particle ID.

if this is a nucleus (ion), get A Ion numbers are +/- 10LZZZAAAI. if this is a nucleus (ion), get Z Ion numbers are +/- 10LZZZAAAI. if this is a nucleus (ion), get nLambda Ion numbers are +/- 10LZZZAAAI.

Definition at line 27 of file ParticleUtils.hh.

References abspid(), and Particle::pdgId().

{ return abspid(p.pdgId()); }

int abspid ( const int & pid )

Absolute value of particle ID.

Definition at line 35 of file ParticleIdUtils.cc.

Referenced by A(), abspid(), digit(), extraBits(), fundamentalID(), isBaryon(), isDiQuark(), isMeson(), isNucleus(), jSpin(), lambda(), threeCharge(), and Z().

    {
      return (pid < 0) ? -pid : pid;
    }

double Rivet::PID::charge ( const Particle & p ) [inline]

Return the charge.

Definition at line 71 of file ParticleUtils.hh.

References threeCharge().

{ return threeCharge(p)/3.0; }

double Rivet::PID::charge ( const int & pid ) [inline]

Return the charge.

Definition at line 89 of file ParticleIdUtils.hh.

References threeCharge().

Referenced by CMS_2011_I954992::analyze(), D0_2008_S7837160::analyze(), ATLAS_2013_I1243871::analyze(), ATLAS_2012_I1094568::analyze(), and threeCharge().

{ return threeCharge(pid)/3.0; }

unsigned short digit	(	location	loc,
		const int &	pid
	)

return the digit at a named location in the PID

Definition at line 47 of file ParticleIdUtils.cc.

References abspid().

Referenced by fundamentalID(), hasBottom(), hasCharm(), hasDown(), hasStrange(), hasTop(), hasUp(), isBaryon(), isDiQuark(), isMeson(), isNucleus(), isPentaquark(), isRhadron(), isSUSY(), lambda(), lSpin(), sSpin(), and threeCharge().

    {
        //  PID digits (base 10) are: n nr nl nq1 nq2 nq3 nj
        //  the location enum provides a convenient index into the PID
        int numerator = (int) std::pow(10.0,(loc-1));
        return (abspid(pid)/numerator)%10;
    }

int extraBits ( const int & pid )

if this is a fundamental particle, does it have a valid antiparticle?

returns everything beyond the 7th digit (e.g. outside the standard numbering scheme)

Definition at line 41 of file ParticleIdUtils.cc.

References abspid().

Referenced by fundamentalID(), hasBottom(), hasCharm(), hasDown(), hasStrange(), hasTop(), hasUp(), isBaryon(), isDiQuark(), isHadron(), isLepton(), isMeson(), isNeutrino(), isPentaquark(), isRhadron(), isSUSY(), isValid(), jSpin(), and threeCharge().

    {
        return abspid(pid)/10000000;
    }

int fundamentalID ( const int & pid )

extract fundamental ID (1-100) if this is a "fundamental" particle

Definition at line 57 of file ParticleIdUtils.cc.

References abspid(), digit(), extraBits(), nq1, and nq2.

Referenced by hasBottom(), hasCharm(), hasDown(), hasStrange(), hasTop(), hasUp(), isBaryon(), isDiQuark(), isLepton(), isMeson(), isNeutrino(), isSUSY(), isValid(), jSpin(), and threeCharge().

    {
        if( extraBits(pid) > 0 ) return 0;
        if( digit(nq2,pid) == 0 && digit(nq1,pid) == 0) {
            return abspid(pid)%10000;
        } else if( abspid(pid) <= 100 ) {
            return abspid(pid);
        } else {
            return 0;
        }
    }

bool Rivet::PID::hasBottom ( const Particle & p ) [inline]

Does this particle contain a bottom quark?

Definition at line 57 of file ParticleUtils.hh.

References hasBottom(), and Particle::pdgId().

{ return hasBottom(p.pdgId()); }

bool hasBottom ( const int & pid )

Does this particle contain a bottom quark?

Definition at line 325 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by ATLAS_2012_I1118269::analyze(), LHCB_2010_I867355::analyze(), ATLAS_2011_S9035664::analyze(), ATLAS_2012_I1188891::analyze(), ATLAS_2013_I1243871::analyze(), ATLAS_2012_I1094568::analyze(), Jet::containsBottom(), hasBottom(), and HeavyHadrons::project().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 5 || digit(nq2,pid) == 5 || digit(nq1,pid) == 5 ) { return true; }
        return false;
    }

bool Rivet::PID::hasCharm ( const Particle & p ) [inline]

Does this particle contain a charm quark?

Definition at line 55 of file ParticleUtils.hh.

References hasCharm(), and Particle::pdgId().

{ return hasCharm(p.pdgId()); }

bool hasCharm ( const int & pid )

Does this particle contain a charm quark?

Definition at line 317 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by ATLAS_2012_I1188891::analyze(), Jet::containsCharm(), hasCharm(), and HeavyHadrons::project().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 4 || digit(nq2,pid) == 4 || digit(nq1,pid) == 4 ) { return true; }
        return false;
    }

bool Rivet::PID::hasDown ( const Particle & p ) [inline]

Does this particle contain a down quark?

Definition at line 51 of file ParticleUtils.hh.

References hasDown(), and Particle::pdgId().

{ return hasDown(p.pdgId()); }

bool hasDown ( const int & pid )

Does this particle contain a down quark?

Definition at line 301 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by hasDown().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 1 || digit(nq2,pid) == 1 || digit(nq1,pid) == 1 ) { return true; }
        return false;
    }

bool Rivet::PID::hasStrange ( const Particle & p ) [inline]

Does this particle contain a strange quark?

Definition at line 53 of file ParticleUtils.hh.

References hasStrange(), and Particle::pdgId().

{ return hasStrange(p.pdgId()); }

bool hasStrange ( const int & pid )

Does this particle contain a strange quark?

Definition at line 309 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by hasStrange().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 3 || digit(nq2,pid) == 3 || digit(nq1,pid) == 3 ) { return true; }
        return false;
    }

bool Rivet::PID::hasTop ( const Particle & p ) [inline]

Does this particle contain a top quark?

Definition at line 59 of file ParticleUtils.hh.

References hasTop(), and Particle::pdgId().

{ return hasTop(p.pdgId()); }

bool hasTop ( const int & pid )

Does this particle contain a top quark?

Definition at line 333 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by hasTop().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 6 || digit(nq2,pid) == 6 || digit(nq1,pid) == 6 ) { return true; }
        return false;
    }

bool Rivet::PID::hasUp ( const Particle & p ) [inline]

Does this particle contain an up quark?

Definition at line 49 of file ParticleUtils.hh.

References hasUp(), and Particle::pdgId().

{ return hasUp(p.pdgId()); }

bool hasUp ( const int & pid )

Does this particle contain an up quark?

Definition at line 293 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), nq1, nq2, and nq3.

Referenced by hasUp().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) > 0 ) { return false; }
        if( digit(nq3,pid) == 2 || digit(nq2,pid) == 2 || digit(nq1,pid) == 2 ) { return true; }
        return false;
    }

bool Rivet::PID::isBaryon ( const Particle & p ) [inline]

Is this a valid baryon ID?

Definition at line 32 of file ParticleUtils.hh.

References isBaryon(), and Particle::pdgId().

{ return isBaryon(p.pdgId()); }

bool isBaryon ( const int & pid )

Is this a valid baryon ID?

Definition at line 169 of file ParticleIdUtils.cc.

References abspid(), digit(), extraBits(), fundamentalID(), nj, nq1, nq2, and nq3.

Referenced by isBaryon(), isHadron(), isValid(), and threeCharge().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( abspid(pid) <= 100 ) { return false; }
        if( fundamentalID(pid) <= 100 && fundamentalID(pid) > 0 ) { return false; }
        if( abspid(pid) == 2110 || abspid(pid) == 2210 ) { return true; }
        if(    digit(nj,pid) > 0  && digit(nq3,pid) > 0
            && digit(nq2,pid) > 0 && digit(nq1,pid) > 0 ) { return true; }
        return false;
    }

bool Rivet::PID::isDiQuark ( const Particle & p ) [inline]

Is this a valid diquark ID?

Definition at line 34 of file ParticleUtils.hh.

References isDiQuark(), and Particle::pdgId().

{ return isDiQuark(p.pdgId()); }

bool isDiQuark ( const int & pid )

Is this a valid diquark ID?

Definition at line 181 of file ParticleIdUtils.cc.

References abspid(), digit(), extraBits(), fundamentalID(), nj, nq1, nq2, and nq3.

Referenced by isDiQuark(), isValid(), and threeCharge().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( abspid(pid) <= 100 ) { return false; }
        if( fundamentalID(pid) <= 100 && fundamentalID(pid) > 0 ) { return false; }
        if(    digit(nj,pid) > 0  && digit(nq3,pid) == 0
            && digit(nq2,pid) > 0 && digit(nq1,pid) > 0 ) {  // diquark signature
           // EvtGen uses the diquarks for quark pairs, so, for instance,
           //   5501 is a valid "diquark" for EvtGen
           //if( digit(nj) == 1 && digit(nq2) == digit(nq1) ) {     // illegal
           //   return false;
           //} else {
              return true;
           //}
        }
        return false;
    }

bool Rivet::PID::isHadron ( const Particle & p ) [inline]

Is this a valid hadron ID?

Definition at line 36 of file ParticleUtils.hh.

References isHadron(), and Particle::pdgId().

{ return isHadron(p.pdgId()); }

bool isHadron ( const int & pid )

Is this a valid hadron ID?

Definition at line 200 of file ParticleIdUtils.cc.

References extraBits(), isBaryon(), isMeson(), and isPentaquark().

Referenced by ATLAS_2012_I1118269::analyze(), LHCB_2010_I867355::analyze(), CMS_2010_S8656010::analyze(), CMS_2010_S8547297::analyze(), ATLAS_2011_S9035664::analyze(), ATLAS_2012_I1188891::analyze(), CMS_2011_S8884919::analyze(), EXAMPLE::analyze(), ATLAS_2013_I1243871::analyze(), ATLAS_2012_I1094568::analyze(), Jet::containsBottom(), Jet::containsCharm(), LHCB_2011_I917009::getLifeTime(), LHCB_2012_I1119400::getLifeTime(), Rivet::hadronFilter(), Jet::hadronicEnergy(), isHadron(), Rivet::isInvisibleFilter(), Rivet::nonHadronFilter(), DISKinematics::project(), PrimaryHadrons::project(), and HeavyHadrons::project().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( isMeson(pid) )   { return true; }
        if( isBaryon(pid) )  { return true; }
        if( isPentaquark(pid) ) { return true; }
        return false;
    }

bool Rivet::PID::isLepton ( const Particle & p ) [inline]

Is this a valid lepton ID?

Definition at line 38 of file ParticleUtils.hh.

References isLepton(), and Particle::pdgId().

{ return isLepton(p.pdgId()); }

bool isLepton ( const int & pid )

Is this a valid lepton ID?

Definition at line 209 of file ParticleIdUtils.cc.

References extraBits(), and fundamentalID().

Referenced by isLepton(), ChargedLeptons::project(), and DISLepton::project().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) >= 11 && fundamentalID(pid) <= 18 ) { return true; }
        return false;
    }

bool Rivet::PID::isMeson ( const Particle & p ) [inline]

Is this a valid meson ID?

Definition at line 30 of file ParticleUtils.hh.

References isMeson(), and Particle::pdgId().

{ return isMeson(p.pdgId()); }

bool isMeson ( const int & pid )

Is this a valid meson ID?

Definition at line 145 of file ParticleIdUtils.cc.

References abspid(), digit(), extraBits(), fundamentalID(), nj, nq1, nq2, and nq3.

Referenced by isHadron(), isMeson(), isValid(), lSpin(), sSpin(), and threeCharge().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( abspid(pid) <= 100 ) { return false; }
        if( fundamentalID(pid) <= 100 && fundamentalID(pid) > 0 ) { return false; }
        int aid = abspid(pid);
        if( aid == 130 || aid == 310 || aid == 210 ) { return true; }
        // EvtGen uses some odd numbers
        if( aid == 150 || aid == 350 || aid == 510 || aid == 530 ) { return true; }
        // pomeron, etc.
        if( pid == 110 || pid == 990 || pid == 9990 ) { return true; }
        if(    digit(nj,pid) > 0 && digit(nq3,pid) > 0
            && digit(nq2,pid) > 0 && digit(nq1,pid) == 0 ) {
            // check for illegal antiparticles
            if( digit(nq3,pid) == digit(nq2,pid) && pid < 0 ) {
                return false;
            } else {
                return true;
            }
        }
        return false;
    }

bool isNeutrino ( const int & pid )

Is this a neutrino ID?

Definition at line 216 of file ParticleIdUtils.cc.

References extraBits(), and fundamentalID().

    {
        if( extraBits(pid) > 0 ) { return false; }
        if( fundamentalID(pid) == 12 || fundamentalID(pid) == 14 || fundamentalID(pid) == 16 ) { return true; }
        return false;
    }

bool Rivet::PID::isNucleus ( const Particle & p ) [inline]

Is this a valid ion ID?

Definition at line 40 of file ParticleUtils.hh.

References isNucleus(), and Particle::pdgId().

{ return isNucleus(p.pdgId()); }

bool isNucleus ( const int & pid )

Is this a valid ion ID?

Definition at line 230 of file ParticleIdUtils.cc.

References abspid(), digit(), n10, and n9.

Referenced by A(), isNucleus(), isValid(), lambda(), and Z().

    {
         // a proton can also be a Hydrogen nucleus
         if( abspid(pid) == 2212 ) { return true; }
         // new standard: +/- 10LZZZAAAI
         if( ( digit(n10,pid) == 1 ) && ( digit(n9,pid) == 0 ) ) {
            // charge should always be less than or equal to baryon number
        // the following line is A >= Z
            if( (abspid(pid)/10)%1000 >= (abspid(pid)/10000)%1000 ) { return true; }
         }
         return false;
    }

bool Rivet::PID::isPentaquark ( const Particle & p ) [inline]

Is this a valid pentaquark ID?

Definition at line 42 of file ParticleUtils.hh.

References isPentaquark(), and Particle::pdgId().

{ return isPentaquark(p.pdgId()); }

bool isPentaquark ( const int & pid )

Is this a valid pentaquark ID?

Definition at line 244 of file ParticleIdUtils.cc.

References digit(), extraBits(), n, nj, nl, nq1, nq2, nq3, and nr.

Referenced by isHadron(), isPentaquark(), and isValid().

    {
        // a pentaquark is of the form 9abcdej,
        // where j is the spin and a, b, c, d, and e are quarks
        if( extraBits(pid) > 0 ) { return false; }
        if( digit(n,pid) != 9 )  { return false; }
        if( digit(nr,pid) == 9 || digit(nr,pid) == 0 )  { return false; }
        if( digit(nj,pid) == 9 || digit(nl,pid) == 0 )  { return false; }
        if( digit(nq1,pid) == 0 )  { return false; }
        if( digit(nq2,pid) == 0 )  { return false; }
        if( digit(nq3,pid) == 0 )  { return false; }
        if( digit(nj,pid) == 0 )  { return false; }
        // check ordering
        if( digit(nq2,pid) > digit(nq1,pid) )  { return false; }
        if( digit(nq1,pid) > digit(nl,pid) )  { return false; }
        if( digit(nl,pid) > digit(nr,pid) )  { return false; }
        return true;
    }

bool Rivet::PID::isRhadron ( const Particle & p ) [inline]

Is this a valid R-hadron ID?

Definition at line 46 of file ParticleUtils.hh.

References isRhadron(), and Particle::pdgId().

{ return isRhadron(p.pdgId()); }

bool isRhadron ( const int & pid )

Is this a valid R-hadron ID?

Definition at line 276 of file ParticleIdUtils.cc.

References digit(), extraBits(), isSUSY(), n, nj, nq2, nq3, and nr.

Referenced by isRhadron(), and isValid().

    {
        // an R-hadron is of the form 10abcdj,
        // where j is the spin and a, b, c, and d are quarks or gluons
        if( extraBits(pid) > 0 ) { return false; }
        if( digit(n,pid) != 1 )  { return false; }
        if( digit(nr,pid) != 0 )  { return false; }
        // make sure this isn't a SUSY particle
        if( isSUSY(pid) ) { return false; }
        // All R-hadrons have at least 3 core digits
        if( digit(nq2,pid) == 0 )  { return false; }
        if( digit(nq3,pid) == 0 )  { return false; }
        if( digit(nj,pid) == 0 )  { return false; }
        return true;
    }

bool Rivet::PID::isSUSY ( const Particle & p ) [inline]

Is this a valid SUSY ID?

Definition at line 44 of file ParticleUtils.hh.

References isSUSY(), and Particle::pdgId().

{ return isSUSY(p.pdgId()); }

bool isSUSY ( const int & pid )

Is this a valid SUSY ID?

Definition at line 264 of file ParticleIdUtils.cc.

References digit(), extraBits(), fundamentalID(), n, and nr.

Referenced by isRhadron(), isSUSY(), and isValid().

    {
        // fundamental SUSY particles have n = 1 or 2
        if( extraBits(pid) > 0 ) { return false; }
        if( digit(n,pid) != 1 && digit(n,pid) != 2 )  { return false; }
        if( digit(nr,pid) != 0 )  { return false; }
        // check fundamental part
        if( fundamentalID(pid) == 0 )  { return false; }
        return true;
    }

bool isValid ( const int & pid )

Is this a valid ID?

Definition at line 102 of file ParticleIdUtils.cc.

References extraBits(), fundamentalID(), isBaryon(), isDiQuark(), isMeson(), isNucleus(), isPentaquark(), isRhadron(), and isSUSY().

    {
        if( extraBits(pid) > 0 ) {
            if( isNucleus(pid) )   { return true; }
            return false;
        }
        if( isSUSY(pid) ) { return true; }
        if( isRhadron(pid) ) { return true; }
        // Meson signature
        if( isMeson(pid) )   { return true; }
        // Baryon signature
        if( isBaryon(pid) )  { return true; }
        // DiQuark signature
        if( isDiQuark(pid) ) { return true; }
        // fundamental particle
        if( fundamentalID(pid) > 0 ) {
          if(pid > 0 ) {
            return true;
          } else {
            // AB - disabled this to remove need for PID -> name lookup.
            //if( hasFundamentalAnti(pid) ) { return true; }
            return false;
          }
        }
        // pentaquark
        if( isPentaquark(pid) ) { return true; }
        // don't recognize this number
        return false;
    }

int Rivet::PID::jSpin ( const Particle & p ) [inline]

jSpin returns 2J+1, where J is the total spin

Definition at line 62 of file ParticleUtils.hh.

References jSpin(), and Particle::pdgId().

{ return jSpin(p.pdgId()); }

int jSpin ( const int & pid )

jSpin returns 2J+1, where J is the total spin

Definition at line 344 of file ParticleIdUtils.cc.

References abspid(), extraBits(), and fundamentalID().

Referenced by jSpin().

    {
        if( fundamentalID(pid) > 0 ) {
        // some of these are known
        int fund = fundamentalID(pid);
        if( fund > 0 && fund < 7 ) return 2;
        if( fund == 9 ) return 3;
        if( fund > 10 && fund < 17 ) return 2;
        if( fund > 20 && fund < 25 ) return 3;
            return 0;
        } else if( extraBits(pid) > 0 ) {
            return 0;
        }
        return abspid(pid)%10;
    }

int Rivet::PID::lambda ( const int & pid )

Definition at line 89 of file ParticleIdUtils.cc.

References abspid(), digit(), isNucleus(), and n8.

    {
        // a proton can also be a Hydrogen nucleus
        if( abspid(pid) == 2212 ) { return 0; }
        if( isNucleus(pid) ) return digit(n8,pid);
        return 0;
    }

int Rivet::PID::lSpin ( const Particle & p ) [inline]

lSpin returns 2L+1, where L is the orbital angular momentum

Definition at line 66 of file ParticleUtils.hh.

References lSpin(), and Particle::pdgId().

{ return lSpin(p.pdgId()); }

int lSpin ( const int & pid )

lSpin returns 2L+1, where L is the orbital angular momentum

Definition at line 385 of file ParticleIdUtils.cc.

References digit(), isMeson(), n, nj, and nl.

Referenced by lSpin().

    {
        if( !isMeson(pid) ) { return 0; }
        int inl = digit(nl,pid);
        //int tent = digit(n,pid);
        int js = digit(nj,pid);
        if( digit(n,pid) == 9 ) { return 0; }   // tentative ID
        if( inl == 0 && js == 3 ) {
            return 0;
        } else if( inl == 0 && js == 5 ) {
            return 1;
        } else if( inl == 0 && js == 7 ) {
            return 2;
        } else if( inl == 0 && js == 9 ) {
            return 3;
        } else if( inl == 0  && js == 1 ) {
            return 0;
        } else if( inl == 1  && js == 3 ) {
            return 1;
        } else if( inl == 1  && js == 5 ) {
            return 2;
        } else if( inl == 1  && js == 7 ) {
            return 3;
        } else if( inl == 1  && js == 9 ) {
            return 4;
        } else if( inl == 2  && js == 3 ) {
            return 1;
        } else if( inl == 2  && js == 5 ) {
            return 2;
        } else if( inl == 2  && js == 7 ) {
            return 3;
        } else if( inl == 2  && js == 9 ) {
            return 4;
        } else if( inl == 1  && js == 1 ) {
            return 1;
        } else if( inl == 3  && js == 3 ) {
            return 2;
        } else if( inl == 3  && js == 5 ) {
            return 3;
        } else if( inl == 3  && js == 7 ) {
            return 4;
        } else if( inl == 3  && js == 9 ) {
            return 5;
        }
        // default to zero
        return 0;
    }

std::pair<PdgId,PdgId> Rivet::PID::make_pdgid_pair	(	PdgId	a,
		PdgId	b
	)		`[inline]`

Convenience maker of particle ID pairs from PdgIds.

Definition at line 233 of file ParticleName.hh.

Referenced by Rivet::compatible(), and AnalysisInfo::make().

                                                                  {
      return make_pair(a, b);
    }

std::pair<PdgId,PdgId> Rivet::PID::make_pdgid_pair	(	const std::string &	a,
		const std::string &	b
	)		`[inline]`

Convenience maker of particle ID pairs from particle names.

Definition at line 239 of file ParticleName.hh.

References toParticleId().

                                                                                        {
      const PdgId pa = toParticleId(a);
      const PdgId pb = toParticleId(b);
      return make_pair(pa, pb);
    }

int Rivet::PID::sSpin ( const Particle & p ) [inline]

sSpin returns 2S+1, where S is the spin

Definition at line 64 of file ParticleUtils.hh.

References Particle::pdgId(), and sSpin().

{ return sSpin(p.pdgId()); }

int sSpin ( const int & pid )

sSpin returns 2S+1, where S is the spin

Definition at line 360 of file ParticleIdUtils.cc.

References digit(), isMeson(), n, nj, and nl.

Referenced by sSpin().

    {
        if( !isMeson(pid) ) { return 0; }
        int inl = digit(nl,pid);
        //int tent = digit(n,pid);
        int js = digit(nj,pid);
        if( digit(n,pid) == 9 ) { return 0; }   // tentative ID
        //if( tent == 9 ) { return 0; } // tentative assignment
        if( inl == 0 && js >= 3 ) {
            return 1;
        } else if( inl == 0  && js == 1 ) {
            return 0;
        } else if( inl == 1  && js >= 3 ) {
            return 0;
        } else if( inl == 2  && js >= 3 ) {
            return 1;
        } else if( inl == 1  && js == 1 ) {
            return 1;
        } else if( inl == 3  && js >= 3 ) {
            return 1;
        }
        // default to zero
        return 0;
    }

int Rivet::PID::threeCharge ( const Particle & p ) [inline]

Return 3 times the charge (3 x quark charge is an int)

Definition at line 69 of file ParticleUtils.hh.

References Particle::pdgId(), and threeCharge().

{ return threeCharge(p.pdgId()); }

int threeCharge ( const int & pid )

Return 3 times the charge (3 x quark charge is an int)

Definition at line 434 of file ParticleIdUtils.cc.

References abspid(), charge(), digit(), extraBits(), fundamentalID(), isBaryon(), isDiQuark(), isMeson(), nj, nq1, nq2, and nq3.

Referenced by H1_1994_S2919893::analyze(), CDF_1993_S2742446::analyze(), MC_WINC::analyze(), D0_2010_S8821313::analyze(), ATLAS_2012_I1183818::analyze(), MC_WPOL::analyze(), ATLAS_2012_I1126136::analyze(), ATLAS_2012_I1095236::analyze(), ATLAS_2012_CONF_2012_109::analyze(), MC_SUSY::analyze(), charge(), ATLAS_2011_I944826::daughtersSurviveCuts(), Rivet::isInvisibleFilter(), Jet::neutralEnergy(), ChargedFinalState::project(), NeutralFinalState::project(), DressedLeptons::project(), ZFinder::project(), WFinder::project(), and threeCharge().

    {
        int charge=0;
        int ida, sid;
        unsigned short q1, q2, q3;
        static int ch100[100] = { -1, 2,-1, 2,-1, 2,-1, 2, 0, 0,
                           -3, 0,-3, 0,-3, 0,-3, 0, 0, 0,
                            0, 0, 0, 3, 0, 0, 0, 0, 0, 0,
                            0, 0, 0, 3, 0, 0, 3, 0, 0, 0,
                            0, -1, 0, 0, 0, 0, 0, 0, 0, 0,
                            0, 6, 3, 6, 0, 0, 0, 0, 0, 0,
                            0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
                            0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
                            0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
                            0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
        q1 = digit(nq1,pid);
        q2 = digit(nq2,pid);
        q3 = digit(nq3,pid);
        ida = abspid(pid);
        sid = fundamentalID(pid);
        if( ida == 0 || extraBits(pid) > 0 ) {      // ion or illegal
            return 0;
        } else if( sid > 0 && sid <= 100 ) {    // use table
            charge = ch100[sid-1];
            if(ida==1000017 || ida==1000018) { charge = 0; }
            if(ida==1000034 || ida==1000052) { charge = 0; }
            if(ida==1000053 || ida==1000054) { charge = 0; }
            if(ida==5100061 || ida==5100062) { charge = 6; }
        } else if( digit(nj,pid) == 0 ) {       // KL, Ks, or undefined
            return 0;
        } else if( isMeson(pid) ) {         // mesons
                if( q2 == 3 || q2 == 5 ) {
                    charge = ch100[q3-1] - ch100[q2-1];
                } else {
                    charge = ch100[q2-1] - ch100[q3-1];
                }
        } else if( isDiQuark(pid) ) {           // diquarks
            charge = ch100[q2-1] + ch100[q1-1];
        } else if( isBaryon(pid) ) {            // baryons
            charge = ch100[q3-1] + ch100[q2-1] + ch100[q1-1];
        } else {        // unknown
            return 0;
        }
        if( charge == 0 ) {
            return 0;
        } else if( pid < 0 ) {
            charge = -charge;
        }
        return charge;
    }

std::string Rivet::PID::toBeamsString ( const PdgIdPair & pair ) [inline]

Print a PdgIdPair as a string.

Definition at line 247 of file ParticleName.hh.

References toParticleName().

Referenced by AnalysisHandler::analyze().

                                                          {
      string out = "[" +
        toParticleName(pair.first) + ", " +
        toParticleName(pair.second) + "]";
      return out;
    }

PdgId Rivet::PID::toParticleId ( const std::string & pname ) [inline]

Print a PdgId as a named string.

Definition at line 227 of file ParticleName.hh.

References ParticleNames::particleId().

Referenced by make_pdgid_pair().

                                                      {
      return ParticleNames::particleId(pname);
    }

const std::string& Rivet::PID::toParticleName ( PdgId p ) [inline]

Print a PdgId as a named string.

Definition at line 221 of file ParticleName.hh.

References ParticleNames::particleName().

Referenced by toBeamsString(), and Rivet::toString().

                                                    {
      return ParticleNames::particleName(p);
    }

int Rivet::PID::Z ( const int & pid )

Definition at line 70 of file ParticleIdUtils.cc.

References abspid(), and isNucleus().

    {
        // a proton can also be a Hydrogen nucleus
        if( abspid(pid) == 2212 ) { return 1; }
        if( isNucleus(pid) ) return (abspid(pid)/10000)%1000;
        return 0;
    }