l1t::VertexWord Class Reference

#include <VertexWord.h>

Public Types
enum	VertexBitLocations {   kValidLSB = 0, kValidMSB = kValidLSB + VertexBitWidths::kValidSize - 1, kZ0LSB = kValidMSB + 1, kZ0MSB = kZ0LSB + VertexBitWidths::kZ0Size - 1,   kNTrackInPVLSB = kZ0MSB + 1, kNTrackInPVMSB = kNTrackInPVLSB + VertexBitWidths::kNTrackInPVSize - 1, kSumPtLSB = kNTrackInPVMSB + 1, kSumPtMSB = kSumPtLSB + VertexBitWidths::kSumPtSize - 1,   kQualityLSB = kSumPtMSB + 1, kQualityMSB = kQualityLSB + VertexBitWidths::kQualitySize - 1, kNTrackOutPVLSB = kQualityMSB + 1, kNTrackOutPVMSB = kNTrackOutPVLSB + VertexBitWidths::kNTrackOutPVSize - 1,   kUnassignedLSB = kNTrackOutPVMSB + 1, kUnassignedMSB = kUnassignedLSB + VertexBitWidths::kUnassignedSize - 1 }
enum	VertexBitWidths {   kValidSize = 1, kZ0Size = 15, kZ0MagSize = 6, kNTrackInPVSize = 8,   kSumPtSize = 10, kSumPtMagSize = 8, kQualitySize = 3, kNTrackOutPVSize = 10,   kUnassignedSize = 17, kVertexWordSize }
typedef edm::Ref< l1t::VertexCollection >	VertexRef
typedef ap_ufixed< VertexBitWidths::kNTrackOutPVSize, VertexBitWidths::kNTrackOutPVSize, AP_RND_CONV, AP_SAT >	vtxinversemult_t
typedef ap_ufixed< VertexBitWidths::kNTrackInPVSize, VertexBitWidths::kNTrackInPVSize, AP_RND_CONV, AP_SAT >	vtxmultiplicity_t
typedef ap_uint< VertexBitWidths::kQualitySize >	vtxquality_t
typedef ap_ufixed< VertexBitWidths::kSumPtSize, VertexBitWidths::kSumPtMagSize, AP_RND_CONV, AP_SAT >	vtxsumpt_t
typedef ap_uint< VertexBitWidths::kUnassignedSize >	vtxunassigned_t
typedef ap_uint< VertexBitWidths::kValidSize >	vtxvalid_t
typedef std::bitset< VertexBitWidths::kVertexWordSize >	vtxword_bs_t
typedef ap_uint< VertexBitWidths::kVertexWordSize >	vtxword_t
typedef ap_fixed< VertexBitWidths::kZ0Size, VertexBitWidths::kZ0MagSize, AP_RND_CONV, AP_SAT >	vtxz0_t

Public Member Functions
unsigned int	inverseMultiplicity () const
unsigned int	inverseMultiplicityBits () const
vtxinversemult_t	inverseMultiplicityWord () const
unsigned int	multiplicity () const
unsigned int	multiplicityBits () const
vtxmultiplicity_t	multiplicityWord () const
VertexWord &	operator= (const VertexWord &word)
double	pt () const
unsigned int	ptBits () const
vtxsumpt_t	ptWord () const
unsigned int	quality () const
unsigned int	qualityBits () const
vtxquality_t	qualityWord () const
void	setVertexRef (const VertexRef &ref)
void	setVertexWord (vtxvalid_t valid, vtxz0_t z0, vtxmultiplicity_t multiplicity, vtxsumpt_t pt, vtxquality_t quality, vtxinversemult_t inverseMultiplicity, vtxunassigned_t unassigned)
unsigned int	unassigned () const
unsigned int	unassignedBits () const
vtxunassigned_t	unassignedWord () const
bool	valid () const
unsigned int	validBits () const
vtxvalid_t	validWord () const
VertexRef	vertexRef () const
	VertexWord ()
	VertexWord (unsigned int valid, double z0, unsigned int multiplicity, double pt, unsigned int quality, unsigned int inverseMultiplicity, unsigned int unassigned)
	VertexWord (unsigned int valid, unsigned int z0, unsigned int multiplicity, unsigned int pt, unsigned int quality, unsigned int inverseMultiplicity, unsigned int unassigned)
	VertexWord (vtxvalid_t valid, vtxz0_t z0, vtxmultiplicity_t multiplicity, vtxsumpt_t pt, vtxquality_t quality, vtxinversemult_t inverseMultiplicity, vtxunassigned_t unassigned)
	VertexWord (const VertexWord &word)
vtxword_t	vertexWord () const
double	z0 () const
unsigned int	z0Bits () const
vtxz0_t	z0Word () const
	~VertexWord ()

Private Member Functions
double	unpackSignedValue (unsigned int bits, unsigned int nBits, double lsb) const

Private Attributes
VertexRef	vertexRef_
vtxword_bs_t	vertexWord_

Detailed Description

Definition at line 24 of file VertexWord.h.

Member Typedef Documentation

VertexRef

typedef edm::Ref<l1t::VertexCollection> l1t::VertexWord::VertexRef

Definition at line 78 of file VertexWord.h.

vtxinversemult_t

typedef ap_ufixed<VertexBitWidths::kNTrackOutPVSize, VertexBitWidths::kNTrackOutPVSize, AP_RND_CONV, AP_SAT> l1t::VertexWord::vtxinversemult_t

Definition at line 70 of file VertexWord.h.

vtxmultiplicity_t

typedef ap_ufixed<VertexBitWidths::kNTrackInPVSize, VertexBitWidths::kNTrackInPVSize, AP_RND_CONV, AP_SAT> l1t::VertexWord::vtxmultiplicity_t

Definition at line 65 of file VertexWord.h.

vtxquality_t

typedef ap_uint<VertexBitWidths::kQualitySize> l1t::VertexWord::vtxquality_t

Definition at line 68 of file VertexWord.h.

vtxsumpt_t

typedef ap_ufixed<VertexBitWidths::kSumPtSize, VertexBitWidths::kSumPtMagSize, AP_RND_CONV, AP_SAT> l1t::VertexWord::vtxsumpt_t

Definition at line 67 of file VertexWord.h.

vtxunassigned_t

typedef ap_uint<VertexBitWidths::kUnassignedSize> l1t::VertexWord::vtxunassigned_t

Definition at line 71 of file VertexWord.h.

vtxvalid_t

typedef ap_uint<VertexBitWidths::kValidSize> l1t::VertexWord::vtxvalid_t

Definition at line 62 of file VertexWord.h.

vtxword_bs_t

typedef std::bitset<VertexBitWidths::kVertexWordSize> l1t::VertexWord::vtxword_bs_t

Definition at line 74 of file VertexWord.h.

vtxword_t

typedef ap_uint<VertexBitWidths::kVertexWordSize> l1t::VertexWord::vtxword_t

Definition at line 75 of file VertexWord.h.

vtxz0_t

typedef ap_fixed<VertexBitWidths::kZ0Size, VertexBitWidths::kZ0MagSize, AP_RND_CONV, AP_SAT> l1t::VertexWord::vtxz0_t

Definition at line 63 of file VertexWord.h.

Member Enumeration Documentation

VertexBitLocations

enum l1t::VertexWord::VertexBitLocations

Enumerator
kValidLSB
kValidMSB
kZ0LSB
kZ0MSB
kNTrackInPVLSB
kNTrackInPVMSB
kSumPtLSB
kSumPtMSB
kQualityLSB
kQualityMSB
kNTrackOutPVLSB
kNTrackOutPVMSB
kUnassignedLSB
kUnassignedMSB

Definition at line 43 of file VertexWord.h.

                            {
      // The location of the least significant bit (LSB) and most significant bit (MSB) in the vertex word for different fields
      kValidLSB = 0,
      kValidMSB = kValidLSB + VertexBitWidths::kValidSize - 1,
      kZ0LSB = kValidMSB + 1,
      kZ0MSB = kZ0LSB + VertexBitWidths::kZ0Size - 1,
      kNTrackInPVLSB = kZ0MSB + 1,
      kNTrackInPVMSB = kNTrackInPVLSB + VertexBitWidths::kNTrackInPVSize - 1,
      kSumPtLSB = kNTrackInPVMSB + 1,
      kSumPtMSB = kSumPtLSB + VertexBitWidths::kSumPtSize - 1,
      kQualityLSB = kSumPtMSB + 1,
      kQualityMSB = kQualityLSB + VertexBitWidths::kQualitySize - 1,
      kNTrackOutPVLSB = kQualityMSB + 1,
      kNTrackOutPVMSB = kNTrackOutPVLSB + VertexBitWidths::kNTrackOutPVSize - 1,
      kUnassignedLSB = kNTrackOutPVMSB + 1,
      kUnassignedMSB = kUnassignedLSB + VertexBitWidths::kUnassignedSize - 1
    };

VertexBitWidths

enum l1t::VertexWord::VertexBitWidths

Enumerator
kValidSize
kZ0Size
kZ0MagSize
kNTrackInPVSize
kSumPtSize
kSumPtMagSize
kQualitySize
kNTrackOutPVSize
kUnassignedSize
kVertexWordSize

Definition at line 27 of file VertexWord.h.

                         {
      // The sizes of the vertex word components and total word size
      kValidSize = 1,         // Width of the valid bit
      kZ0Size = 15,           // Width of z-position
      kZ0MagSize = 6,         // Width of z-position magnitude (signed)
      kNTrackInPVSize = 8,    // Width of the multiplicity in the PV (unsigned)
      kSumPtSize = 10,        // Width of pT
      kSumPtMagSize = 8,      // Width of pT magnitude (unsigned)
      kQualitySize = 3,       // Width of the quality field
      kNTrackOutPVSize = 10,  // Width of the multiplicity outside the PV (unsigned)
      kUnassignedSize = 17,   // Width of the unassigned bits

      kVertexWordSize = kValidSize + kZ0Size + kNTrackInPVSize + kSumPtSize + kQualitySize + kNTrackOutPVSize +
                        kUnassignedSize,  // Width of the vertex word in bits
    };

Constructor & Destructor Documentation

VertexWord() [1/5]

l1t::VertexWord::VertexWord ( )

inline

Definition at line 82 of file VertexWord.h.

{}

VertexWord() [2/5]

l1t::VertexWord::VertexWord	(	unsigned int	valid,
		double	z0,
		unsigned int	multiplicity,
		double	pt,
		unsigned int	quality,
		unsigned int	inverseMultiplicity,
		unsigned int	unassigned
	)

Definition at line 15 of file VertexWord.cc.

References inverseMultiplicity(), multiplicity(), pt(), quality(), setVertexWord(), unassigned(), valid(), and z0().

                                                  {
    // convert directly to AP types
    vtxvalid_t valid_ap = valid;
    vtxz0_t z0_ap = z0;
    vtxmultiplicity_t mult_ap = multiplicity;
    vtxsumpt_t pt_ap = pt;
    vtxquality_t quality_ap = quality;
    vtxinversemult_t invmult_ap = inverseMultiplicity;
    vtxunassigned_t unassigned_ap = unassigned;

    setVertexWord(valid_ap, z0_ap, mult_ap, pt_ap, quality_ap, invmult_ap, unassigned_ap);
  }

VertexWord() [3/5]

l1t::VertexWord::VertexWord	(	unsigned int	valid,
		unsigned int	z0,
		unsigned int	multiplicity,
		unsigned int	pt,
		unsigned int	quality,
		unsigned int	inverseMultiplicity,
		unsigned int	unassigned
	)

Definition at line 34 of file VertexWord.cc.

References inverseMultiplicity(), multiplicity(), quality(), setVertexWord(), unassigned(), unpackSignedValue(), valid(), and z0().

                                                  {
    // convert to AP types
    vtxvalid_t valid_ap = valid;
    vtxz0_t z0_ap = unpackSignedValue(
        z0, VertexBitWidths::kZ0Size, 1.0 / (1 << (VertexBitWidths::kZ0Size - VertexBitWidths::kZ0MagSize)));
    vtxmultiplicity_t mult_ap = multiplicity;
    vtxsumpt_t pt_ap = unpackSignedValue(
        z0, VertexBitWidths::kSumPtSize, 1.0 / (1 << (VertexBitWidths::kSumPtSize - VertexBitWidths::kSumPtMagSize)));
    vtxquality_t quality_ap = quality;
    vtxinversemult_t invmult_ap = inverseMultiplicity;
    vtxunassigned_t unassigned_ap = unassigned;

    setVertexWord(valid_ap, z0_ap, mult_ap, pt_ap, quality_ap, invmult_ap, unassigned_ap);
  }

VertexWord() [4/5]

l1t::VertexWord::VertexWord	(	vtxvalid_t	valid,
		vtxz0_t	z0,
		vtxmultiplicity_t	multiplicity,
		vtxsumpt_t	pt,
		vtxquality_t	quality,
		vtxinversemult_t	inverseMultiplicity,
		vtxunassigned_t	unassigned
	)

Definition at line 55 of file VertexWord.cc.

References inverseMultiplicity(), multiplicity(), pt(), quality(), setVertexWord(), unassigned(), valid(), and z0().

                                                     {
    setVertexWord(valid, z0, multiplicity, pt, quality, inverseMultiplicity, unassigned);
  }

~VertexWord()

l1t::VertexWord::~VertexWord ( )

inline

Definition at line 105 of file VertexWord.h.

{}

VertexWord() [5/5]

l1t::VertexWord::VertexWord ( const VertexWord &  word )

inline

Definition at line 108 of file VertexWord.h.

References vertexWord_.

{ vertexWord_ = word.vertexWord_; }

Member Function Documentation

inverseMultiplicity()

unsigned int l1t::VertexWord::inverseMultiplicity ( ) const

inline

Definition at line 160 of file VertexWord.h.

References inverseMultiplicityWord().

Referenced by setVertexWord(), and VertexWord().

{ return inverseMultiplicityWord().to_uint(); }

inverseMultiplicityBits()

unsigned int l1t::VertexWord::inverseMultiplicityBits ( ) const

inline

Definition at line 150 of file VertexWord.h.

References inverseMultiplicityWord().

{ return inverseMultiplicityWord().to_uint(); }

inverseMultiplicityWord()

vtxinversemult_t l1t::VertexWord::inverseMultiplicityWord ( ) const

inline

Definition at line 135 of file VertexWord.h.

References vertexWord().

Referenced by inverseMultiplicity(), and inverseMultiplicityBits().

                                                     {
      return vertexWord()(VertexBitLocations::kNTrackOutPVMSB, VertexBitLocations::kNTrackOutPVLSB);
    }

multiplicity()

unsigned int l1t::VertexWord::multiplicity ( ) const

inline

Definition at line 157 of file VertexWord.h.

References multiplicityWord().

Referenced by setVertexWord(), and VertexWord().

{ return multiplicityWord().to_uint(); }

multiplicityBits()

unsigned int l1t::VertexWord::multiplicityBits ( ) const

inline

Definition at line 147 of file VertexWord.h.

References multiplicityWord().

{ return multiplicityWord().to_uint(); }

multiplicityWord()

vtxmultiplicity_t l1t::VertexWord::multiplicityWord ( ) const

inline

Definition at line 124 of file VertexWord.h.

References vertexWord().

Referenced by multiplicity(), and multiplicityBits().

                                               {
      return vertexWord()(VertexBitLocations::kNTrackInPVMSB, VertexBitLocations::kNTrackInPVLSB);
    }

operator=()

VertexWord& l1t::VertexWord::operator= ( const VertexWord &  word )

inline

Definition at line 111 of file VertexWord.h.

References vertexWord_.

                                                  {
      vertexWord_ = word.vertexWord_;
      return *this;
    }

pt()

double l1t::VertexWord::pt ( ) const

inline

Definition at line 158 of file VertexWord.h.

References ptWord().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), l1tVertexFinder::VertexFinder::findPrimaryVertex(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), Electron.Electron::ptErr(), ntupleDataFormat.Track::ptPull(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), Jet.Jet::setCorrP4(), setVertexWord(), l1tVertexFinder::VertexFinder::sortVerticesInPt(), and VertexWord().

{ return ptWord().to_double(); }

ptBits()

unsigned int l1t::VertexWord::ptBits ( ) const

inline

Definition at line 148 of file VertexWord.h.

References ptWord().

{ return ptWord().to_uint(); }

ptWord()

vtxsumpt_t l1t::VertexWord::ptWord ( ) const

inline

Definition at line 127 of file VertexWord.h.

References runTheMatrix::ret, and vertexWord().

Referenced by pt(), and ptBits().

                              {
      vtxsumpt_t ret;
      ret.V = vertexWord()(VertexBitLocations::kSumPtMSB, VertexBitLocations::kSumPtLSB);
      return ret;
    }

quality()

unsigned int l1t::VertexWord::quality ( ) const

inline

Definition at line 159 of file VertexWord.h.

References qualityWord().

Referenced by setVertexWord(), and VertexWord().

{ return qualityWord().to_uint(); }

qualityBits()

unsigned int l1t::VertexWord::qualityBits ( ) const

inline

Definition at line 149 of file VertexWord.h.

References qualityWord().

{ return qualityWord().to_uint(); }

qualityWord()

vtxquality_t l1t::VertexWord::qualityWord ( ) const

inline

Definition at line 132 of file VertexWord.h.

References vertexWord().

Referenced by quality(), and qualityBits().

                                     {
      return vertexWord()(VertexBitLocations::kQualityMSB, VertexBitLocations::kQualityLSB);
    }

setVertexRef()

void l1t::VertexWord::setVertexRef ( const VertexRef &  ref )

inline

Definition at line 176 of file VertexWord.h.

References vertexRef_.

{ vertexRef_ = ref; }

setVertexWord()

void l1t::VertexWord::setVertexWord	(	vtxvalid_t	valid,
		vtxz0_t	z0,
		vtxmultiplicity_t	multiplicity,
		vtxsumpt_t	pt,
		vtxquality_t	quality,
		vtxinversemult_t	inverseMultiplicity,
		vtxunassigned_t	unassigned
	)

Definition at line 65 of file VertexWord.cc.

References b, inverseMultiplicity(), multiplicity(), hltrates_dqm_sourceclient-live_cfg::offset, pt(), quality(), unassigned(), valid(), vertexWord_, and z0().

Referenced by VertexWord().

                                                             {
    // pack the vertex word
    unsigned int offset = 0;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kValidSize); b++) {
      vertexWord_.set(b, valid[b - offset]);
    }
    offset += VertexBitWidths::kValidSize;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kZ0Size); b++) {
      vertexWord_.set(b, z0[b - offset]);
    }
    offset += VertexBitWidths::kZ0Size;

    for (unsigned int b = offset; b < (offset + VertexBitWidths::kNTrackInPVSize); b++) {
      vertexWord_.set(b, multiplicity[b - offset]);
    }
    offset += VertexBitWidths::kNTrackInPVSize;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kSumPtSize); b++) {
      vertexWord_.set(b, pt[b - offset]);
    }
    offset += VertexBitWidths::kSumPtSize;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kQualitySize); b++) {
      vertexWord_.set(b, quality[b - offset]);
    }
    offset += VertexBitWidths::kQualitySize;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kNTrackOutPVSize); b++) {
      vertexWord_.set(b, inverseMultiplicity[b - offset]);
    }
    offset += VertexBitWidths::kNTrackOutPVSize;
    for (unsigned int b = offset; b < (offset + VertexBitWidths::kUnassignedSize); b++) {
      vertexWord_.set(b, unassigned[b - offset]);
    }
  }

unassigned()

unsigned int l1t::VertexWord::unassigned ( ) const

inline

Definition at line 161 of file VertexWord.h.

References unassignedWord().

Referenced by setVertexWord(), and VertexWord().

{ return unassignedWord().to_uint(); }

unassignedBits()

unsigned int l1t::VertexWord::unassignedBits ( ) const

inline

Definition at line 151 of file VertexWord.h.

References unassignedWord().

{ return unassignedWord().to_uint(); }

unassignedWord()

vtxunassigned_t l1t::VertexWord::unassignedWord ( ) const

inline

Definition at line 138 of file VertexWord.h.

References vertexWord().

Referenced by unassigned(), and unassignedBits().

                                           {
      return vertexWord()(VertexBitLocations::kUnassignedMSB, VertexBitLocations::kUnassignedLSB);
    }

unpackSignedValue()

double l1t::VertexWord::unpackSignedValue ( unsigned int  bits, unsigned int  nBits, double  lsb  ) const

inlineprivate

Definition at line 180 of file VertexWord.h.

References hgcalVFEProducer_cfi::lsb.

Referenced by VertexWord().

                                                                                      {
      int isign = 1;
      unsigned int digitized_maximum = (1 << nBits) - 1;
      if (bits & (1 << (nBits - 1))) {  // check the sign
        isign = -1;
        bits = (1 << (nBits + 1)) - bits;  // if negative, flip everything for two's complement encoding
      }
      return (double(bits & digitized_maximum) + 0.5) * lsb * isign;
    }

valid()

bool l1t::VertexWord::valid ( ) const

inline

Definition at line 155 of file VertexWord.h.

References validWord().

Referenced by setVertexWord(), and VertexWord().

{ return validWord().to_bool(); }

validBits()

unsigned int l1t::VertexWord::validBits ( ) const

inline

Definition at line 145 of file VertexWord.h.

References validWord().

{ return validWord().to_uint(); }

validWord()

vtxvalid_t l1t::VertexWord::validWord ( ) const

inline

Definition at line 118 of file VertexWord.h.

References vertexWord().

Referenced by valid(), and validBits().

{ return vertexWord()(VertexBitLocations::kValidMSB, VertexBitLocations::kValidLSB); }

vertexRef()

VertexRef l1t::VertexWord::vertexRef ( ) const

inline

Definition at line 164 of file VertexWord.h.

References vertexRef_.

{ return vertexRef_; }

vertexWord()

vtxword_t l1t::VertexWord::vertexWord ( ) const

inline

Definition at line 141 of file VertexWord.h.

References vertexWord_.

Referenced by inverseMultiplicityWord(), multiplicityWord(), ptWord(), qualityWord(), unassignedWord(), validWord(), and z0Word().

{ return vtxword_t(vertexWord_.to_string().c_str(), 2); }

z0()

double l1t::VertexWord::z0 ( ) const

inline

Definition at line 156 of file VertexWord.h.

References z0Word().

Referenced by L1TrackSelectionProducer::produce(), setVertexWord(), l1tVertexFinder::VertexFinder::sortVerticesInZ0(), and VertexWord().

{ return z0Word().to_double(); }

z0Bits()

unsigned int l1t::VertexWord::z0Bits ( ) const

inline

Definition at line 146 of file VertexWord.h.

References z0Word().

{ return z0Word().to_uint(); }

z0Word()

vtxz0_t l1t::VertexWord::z0Word ( ) const

inline

Definition at line 119 of file VertexWord.h.

References runTheMatrix::ret, and vertexWord().

Referenced by z0(), and z0Bits().

                           {
      vtxz0_t ret;
      ret.V = vertexWord()(VertexBitLocations::kZ0MSB, VertexBitLocations::kZ0LSB);
      return ret;
    }

Member Data Documentation

vertexRef_

VertexRef l1t::VertexWord::vertexRef_

private

Definition at line 192 of file VertexWord.h.

Referenced by setVertexRef(), and vertexRef().

vertexWord_

vtxword_bs_t l1t::VertexWord::vertexWord_

private

Definition at line 191 of file VertexWord.h.

Referenced by operator=(), setVertexWord(), VertexWord(), and vertexWord().