l1ct::ParticleID Struct Reference

#include <datatypes.h>

Public Types
enum	PID {   NONE = 0, HADZERO = 0, PHOTON = 1, HADMINUS = 2,   HADPLUS = 3, ELEMINUS = 4, ELEPLUS = 5, MUMINUS = 6,   MUPLUS = 7 }
enum	PTYPE { HAD = 0, EM = 1, MU = 2 }

Public Member Functions
bool	charge () const
bool	charged () const
bool	chargeOrNull () const
void	clear ()
int	intCharge () const
bool	isChargedHadron () const
bool	isElectron () const
bool	isMuon () const
bool	isPhoton () const
bool	neutral () const
int	oldId () const
ParticleID &	operator= (PID val)
bool	operator== (const ParticleID &other) const
	ParticleID (PID val=NONE)
int	pdgId () const
int	rawId () const

Static Public Member Functions
static ParticleID	mkChHad (bool charge)
static ParticleID	mkElectron (bool charge)
static ParticleID	mkMuon (bool charge)

Public Attributes
ap_uint< 3 >	bits

Detailed Description

Definition at line 42 of file datatypes.h.

Member Enumeration Documentation

PID

enum l1ct::ParticleID::PID

Enumerator
NONE
HADZERO
PHOTON
HADMINUS
HADPLUS
ELEMINUS
ELEPLUS
MUMINUS
MUPLUS

Definition at line 44 of file datatypes.h.

             {
      NONE = 0,
      HADZERO = 0,
      PHOTON = 1,
      HADMINUS = 2,
      HADPLUS = 3,
      ELEMINUS = 4,
      ELEPLUS = 5,
      MUMINUS = 6,
      MUPLUS = 7
    };

PTYPE

enum l1ct::ParticleID::PTYPE

Enumerator
HAD
EM
MU

Definition at line 55 of file datatypes.h.

{ HAD = 0, EM = 1, MU = 2 };

Constructor & Destructor Documentation

ParticleID()

l1ct::ParticleID::ParticleID ( PID  val = NONE )

inline

Definition at line 57 of file datatypes.h.

Referenced by mkChHad(), mkElectron(), and mkMuon().

: bits(val) {}

Member Function Documentation

charge()

bool l1ct::ParticleID::charge ( ) const

inline

Definition at line 73 of file datatypes.h.

References cms::cuda::assert(), bits, and charged().

Referenced by intCharge(), mkChHad(), mkElectron(), and mkMuon().

                        {
#ifndef __SYNTHESIS__
      assert(charged());
#endif
      return bits[0]; /* 1 if positive, 0 if negative */
    }

charged()

bool l1ct::ParticleID::charged ( ) const

inline

Definition at line 83 of file datatypes.h.

References bits.

Referenced by charge(), l1ct::PuppiObj::hwDxy(), l1ct::PuppiObj::hwTkQuality(), l1ct::PuppiObj::hwZ0(), intCharge(), neutral(), l1ct::PuppiObj::setHwDxy(), l1ct::PuppiObj::setHwTkQuality(), and l1ct::PuppiObj::setHwZ0().

{ return bits[1] || bits[2]; };

chargeOrNull()

bool l1ct::ParticleID::chargeOrNull ( ) const

inline

Definition at line 80 of file datatypes.h.

References bits.

Referenced by l1ct::PFChargedObj::hwVtxPhi().

                              {  // doesn't throw on null id
      return bits[0];
    }

clear()

void l1ct::ParticleID::clear ( void  )

inline

Definition at line 87 of file datatypes.h.

References bits.

Referenced by l1ct::PFChargedObj::clear(), l1ct::PuppiObj::clear(), and l1ct::PFNeutralObj::clear().

{ bits = 0; }

intCharge()

int l1ct::ParticleID::intCharge ( ) const

inline

Definition at line 85 of file datatypes.h.

References charge(), and charged().

Referenced by l1ct::PFCommonObj::intCharge(), and l1ct::PuppiObj::intCharge().

{ return charged() ? (charge() ? +1 : -1) : 0; }

isChargedHadron()

bool l1ct::ParticleID::isChargedHadron ( ) const

inline

Definition at line 72 of file datatypes.h.

References bits.

{ return !bits[2] && bits[1]; }

isElectron()

bool l1ct::ParticleID::isElectron ( ) const

inline

Definition at line 71 of file datatypes.h.

References bits.

{ return bits[2] && !bits[1]; }

isMuon()

bool l1ct::ParticleID::isMuon ( ) const

inline

Definition at line 70 of file datatypes.h.

References bits.

{ return bits[2] && bits[1]; }

isPhoton()

bool l1ct::ParticleID::isPhoton ( ) const

inline

Definition at line 64 of file datatypes.h.

References cms::cuda::assert(), bits, and neutral().

                          {
#ifndef __SYNTHESIS__
      assert(neutral());
#endif
      return bits[0];
    }

mkChHad()

static ParticleID l1ct::ParticleID::mkChHad ( bool  charge )

inlinestatic

Definition at line 89 of file datatypes.h.

References charge(), HADMINUS, HADPLUS, and ParticleID().

{ return ParticleID(charge ? HADPLUS : HADMINUS); }

mkElectron()

static ParticleID l1ct::ParticleID::mkElectron ( bool  charge )

inlinestatic

Definition at line 90 of file datatypes.h.

References charge(), ELEMINUS, ELEPLUS, and ParticleID().

{ return ParticleID(charge ? ELEPLUS : ELEMINUS); }

mkMuon()

static ParticleID l1ct::ParticleID::mkMuon ( bool  charge )

inlinestatic

Definition at line 91 of file datatypes.h.

References charge(), MUMINUS, MUPLUS, and ParticleID().

{ return ParticleID(charge ? MUPLUS : MUMINUS); }

neutral()

bool l1ct::ParticleID::neutral ( ) const

inline

Definition at line 84 of file datatypes.h.

References charged().

Referenced by l1ct::PuppiObj::floatPuppiW(), l1ct::PuppiObj::hwEmID(), l1ct::PuppiObj::hwPuppiW(), isPhoton(), l1ct::PuppiObj::setHwEmID(), and l1ct::PuppiObj::setHwPuppiW().

{ return !charged(); }

oldId()

int l1ct::ParticleID::oldId ( ) const

inline

Definition at line 117 of file datatypes.h.

References bits, ELEMINUS, ELEPLUS, HADMINUS, HADPLUS, HADZERO, MUMINUS, MUPLUS, and PHOTON.

Referenced by l1ct::PFCommonObj::oldId(), and l1ct::PuppiObj::oldId().

                             {
      //{ PID_Charged=0, PID_Neutral=1, PID_Photon=2, PID_Electron=3, PID_Muon=4 };
      switch (bits.to_int()) {
        case HADZERO:
          return 1;
        case PHOTON:
          return 2;
        case HADMINUS:
          return 0;
        case HADPLUS:
          return 0;
        case ELEMINUS:
          return 3;
        case ELEPLUS:
          return 3;
        case MUMINUS:
          return 4;
        case MUPLUS:
          return 4;
      }
      return -1;
    }

operator=()

ParticleID& l1ct::ParticleID::operator= ( PID  val )

inline

Definition at line 58 of file datatypes.h.

References bits, and heppy_batch::val.

                                   {
      bits = val;
      return *this;
    }

operator==()

bool l1ct::ParticleID::operator== ( const ParticleID &  other ) const

inline

Definition at line 93 of file datatypes.h.

References bits, and trackingPlots::other.

{ return bits == other.bits; }

pdgId()

int l1ct::ParticleID::pdgId ( ) const

inline

Definition at line 95 of file datatypes.h.

References bits, ELEMINUS, ELEPLUS, HADMINUS, HADPLUS, HADZERO, MUMINUS, MUPLUS, and PHOTON.

Referenced by Particle.Particle::__str__(), l1ct::PFCommonObj::pdgId(), and l1ct::PuppiObj::pdgId().

                             {
      switch (bits.to_int()) {
        case HADZERO:
          return 130;
        case PHOTON:
          return 22;
        case HADMINUS:
          return -211;
        case HADPLUS:
          return +211;
        case ELEMINUS:
          return +11;
        case ELEPLUS:
          return -11;
        case MUMINUS:
          return +13;
        case MUPLUS:
          return -13;
      }
      return 0;
    }

rawId()

int l1ct::ParticleID::rawId ( ) const

inline

Definition at line 63 of file datatypes.h.

References bits.

Referenced by l1ct::PFCommonObj::intId(), and l1ct::PuppiObj::intId().

{ return bits.to_int(); }

Member Data Documentation

bits

ap_uint<3> l1ct::ParticleID::bits

Definition at line 43 of file datatypes.h.

Referenced by charge(), charged(), chargeOrNull(), clear(), l1ct::PuppiObj::initFromBits(), isChargedHadron(), isElectron(), isMuon(), isPhoton(), oldId(), operator=(), operator==(), l1ct::PuppiObj::pack(), l1ct::PFCommonObj::pack_common(), pdgId(), rawId(), and l1ct::PFCommonObj::unpack_common().