CMS 3D CMS Logo
List of all members | Public Member Functions | Public Attributes
SiPixelRecHitQuality::Packing Class Reference

#include <SiPixelRecHitQuality.h>

Public Member Functions

bool hasBadPixels (QualWordType qualWord) const
 
bool hasFilledProb (QualWordType qualWord) const
 
bool isOnEdge (QualWordType qualWord) const
 
 Packing ()
 
float probabilityQ (QualWordType qualWord) const
 
float probabilityX (QualWordType qualWord) const
 
float probabilityXY (QualWordType qualWord) const
 
float probabilityY (QualWordType qualWord) const
 
int qBin (QualWordType qualWord) const
 
void setHasBadPixels (bool flag, QualWordType &qualWord) const
 
void setHasFilledProb (bool flag, QualWordType &qualWord) const
 
void setIsOnEdge (bool flag, QualWordType &qualWord) const
 
void setProbabilityQ (float prob, QualWordType &qualWord) const
 
void setProbabilityXY (float prob, QualWordType &qualWord) const
 
void setQBin (int qbin, QualWordType &qualWord) const
 
void setSpansTwoROCs (bool flag, QualWordType &qualWord) const
 
bool spansTwoROCs (QualWordType qualWord) const
 

Public Attributes

QualWordType bad_mask
 
int bad_shift
 
char bad_width
 
QualWordType edge_mask
 
int edge_shift
 
char edge_width
 
QualWordType hasFilledProb_mask
 
int hasFilledProb_shift
 
char hasFilledProb_width
 
double probX_1_over_log_units
 
QualWordType probX_mask
 
int probX_shift
 
float probX_units
 
char probX_width
 
double probY_1_over_log_units
 
QualWordType probY_mask
 
int probY_shift
 
float probY_units
 
char probY_width
 
QualWordType qBin_mask
 
int qBin_shift
 
char qBin_width
 
char spare_width
 
QualWordType twoROC_mask
 
int twoROC_shift
 
char twoROC_width
 

Detailed Description

Definition at line 16 of file SiPixelRecHitQuality.h.

Constructor & Destructor Documentation

SiPixelRecHitQuality::Packing::Packing ( )

Definition at line 5 of file SiPixelRecHitQuality.cc.

References bad_mask, bad_shift, bad_width, edge_mask, edge_shift, edge_width, Exception, hasFilledProb_mask, hasFilledProb_shift, hasFilledProb_width, cmsBatch::log, probX_1_over_log_units, probX_mask, probX_shift, probX_units, probX_width, probY_1_over_log_units, probY_mask, probY_shift, probY_units, probY_width, qBin_mask, qBin_shift, qBin_width, spare_width, SiPixelRecHitQuality::thePacking, twoROC_mask, twoROC_shift, and twoROC_width.

6 {
7  // Constructor: pre-computes masks and shifts from field widths
8  // X is now XY
9  // Y is now Q
10  probX_width = 14;
11  probY_width = 8;
12  qBin_width = 3;
13  edge_width = 1;
14  bad_width = 1;
15  twoROC_width = 1;
16  hasFilledProb_width = 1;
17  spare_width = 3;
18 
19  if ( probX_width + probY_width + qBin_width + edge_width +
20  bad_width + twoROC_width + hasFilledProb_width + spare_width
21  != 32 ) {
22  throw cms::Exception("SiPixelRecHitQuality::Packing: ")
23  << "\nERROR: The allocated bits for the quality word to not sum to 32."
24  << "\n\n";
25  }
26 
27  probX_units = 1.0018;
28  probY_units = 1.0461;
29  probX_1_over_log_units = 1.0 / log( probX_units );
30  probY_1_over_log_units = 1.0 / log( probY_units );
31 
32  // Fields are counted from right to left!
33  probX_shift = 0;
34  probY_shift = probX_shift + probX_width;
35  qBin_shift = probY_shift + probY_width;
36  edge_shift = qBin_shift + qBin_width;
37  bad_shift = edge_shift + edge_width;
38  twoROC_shift = bad_shift + bad_width;
39  hasFilledProb_shift = twoROC_shift + twoROC_width;
40 
41  // Ensure the complement of the correct
42  // number of bits:
43  QualWordType zero32 = 0; // 32-bit wide set of 0's
44 
45  probX_mask = ~(~zero32 << probX_width);
46  probY_mask = ~(~zero32 << probY_width);
47  qBin_mask = ~(~zero32 << qBin_width);
48  edge_mask = ~(~zero32 << edge_width);
49  bad_mask = ~(~zero32 << bad_width);
50  twoROC_mask = ~(~zero32 << twoROC_width);
51  hasFilledProb_mask = ~(~zero32 << hasFilledProb_width);
52 }

Member Function Documentation

bool SiPixelRecHitQuality::Packing::hasBadPixels ( QualWordType  qualWord) const
inline

Definition at line 107 of file SiPixelRecHitQuality.h.

References bad_mask.

Referenced by SiPixelRecHit::hasBadPixels().

107  {
108  return (qualWord >> bad_shift) & bad_mask;
109  }
bool SiPixelRecHitQuality::Packing::hasFilledProb ( QualWordType  qualWord) const
inline

Definition at line 115 of file SiPixelRecHitQuality.h.

References hasFilledProb_mask.

Referenced by SiPixelRecHit::hasFilledProb().

115  {
116  return (qualWord >> hasFilledProb_shift) & hasFilledProb_mask;
117  }
bool SiPixelRecHitQuality::Packing::isOnEdge ( QualWordType  qualWord) const
inline

Definition at line 103 of file SiPixelRecHitQuality.h.

References edge_mask.

Referenced by SiPixelRecHit::isOnEdge().

103  {
104  return (qualWord >> edge_shift) & edge_mask;
105  }
float SiPixelRecHitQuality::Packing::probabilityQ ( QualWordType  qualWord) const
inline

Definition at line 81 of file SiPixelRecHitQuality.h.

References funct::pow(), TtFullHadEvtBuilder_cfi::prob, and probY_shift.

Referenced by SiPixelRecHit::probabilityQ().

81  {
82  int raw = (qualWord >> probY_shift) & probY_mask;
83  if(raw<0 || raw >255) {
84  edm::LogWarning("OutOfBounds") << "Probability Q outside the bounds of the quality word. Defaulting to Prob=0. Raw = " << raw << " QualityWord = " << qualWord;
85  raw = 255;
86  }
87  float prob = (raw==255) ? 0 : pow( probY_units, (float)( -raw) );
88  // cout << "Bits = " << raw << " --> Prob = " << prob << endl;
89  return prob;
90  }
TtFullHadEvtBuilder_cfi.prob
prob
Definition: TtFullHadEvtBuilder_cfi.py:33
funct::pow
Power< A, B >::type pow(const A &a, const B &b)
Definition: Power.h:40
float SiPixelRecHitQuality::Packing::probabilityX ( QualWordType  qualWord) const
inline

Definition at line 62 of file SiPixelRecHitQuality.h.

Referenced by SiPixelRecHit::probabilityX().

62  {
63  edm::LogWarning("ObsoleteVariable") << "Since 39x, probabilityX and probabilityY have been replaced by probabilityXY and probabilityQ";
64  return -10;
65  }
float SiPixelRecHitQuality::Packing::probabilityXY ( QualWordType  qualWord) const
inline

Definition at line 71 of file SiPixelRecHitQuality.h.

References funct::pow(), TtFullHadEvtBuilder_cfi::prob, and probX_shift.

Referenced by SiPixelRecHit::probabilityXY().

71  {
72  int raw = (qualWord >> probX_shift) & probX_mask;
73  if(raw<0 || raw >16383) {
74  edm::LogWarning("OutOfBounds") << "Probability XY outside the bounds of the quality word. Defaulting to Prob=0. Raw = " << raw << " QualityWord = " << qualWord;
75  raw = 16383;
76  }
77  float prob = (raw==16383) ? 0: pow( probX_units, (float)( -raw) );
78  // cout << "Bits = " << raw << " --> Prob = " << prob << endl;
79  return prob;
80  }
TtFullHadEvtBuilder_cfi.prob
prob
Definition: TtFullHadEvtBuilder_cfi.py:33
funct::pow
Power< A, B >::type pow(const A &a, const B &b)
Definition: Power.h:40
float SiPixelRecHitQuality::Packing::probabilityY ( QualWordType  qualWord) const
inline

Definition at line 66 of file SiPixelRecHitQuality.h.

Referenced by SiPixelRecHit::probabilityY().

66  {
67  edm::LogWarning("ObsoleteVariable") << "Since 39x, probabilityX and probabilityY have been replaced by probabilityXY and probabilityQ";
68  return -10;
69  }
int SiPixelRecHitQuality::Packing::qBin ( QualWordType  qualWord) const
inline

Definition at line 93 of file SiPixelRecHitQuality.h.

References qBin_shift.

Referenced by SiPixelRecHit::qBin().

93  {
94  int qbin = (qualWord >> qBin_shift) & qBin_mask;
95  if(qbin<0 || qbin >7) {
96  edm::LogWarning("OutOfBounds") << "Qbin outside the bounds of the quality word. Defaulting to Qbin=0. Qbin = " << qbin << " QualityWord = " << qualWord;
97  qbin=0;
98  }
99  return qbin;
100  }
void SiPixelRecHitQuality::Packing::setHasBadPixels ( bool  flag,
QualWordType &  qualWord 
) const
inline

Definition at line 156 of file SiPixelRecHitQuality.h.

References bad_mask.

Referenced by PixelCPEBase::rawQualityWord().

156  {
157  qualWord |= ((flag & bad_mask) << bad_shift);
158  }
void SiPixelRecHitQuality::Packing::setHasFilledProb ( bool  flag,
QualWordType &  qualWord 
) const
inline

Definition at line 162 of file SiPixelRecHitQuality.h.

References hasFilledProb_mask.

Referenced by PixelCPEBase::rawQualityWord().

162  {
163  qualWord |= ((flag & hasFilledProb_mask) << hasFilledProb_shift);
164  }
void SiPixelRecHitQuality::Packing::setIsOnEdge ( bool  flag,
QualWordType &  qualWord 
) const
inline

Definition at line 153 of file SiPixelRecHitQuality.h.

References edge_mask.

Referenced by PixelCPEBase::rawQualityWord().

153  {
154  qualWord |= ((flag & edge_mask) << edge_shift);
155  }
void SiPixelRecHitQuality::Packing::setProbabilityQ ( float  prob,
QualWordType &  qualWord 
) const
inline

Definition at line 133 of file SiPixelRecHitQuality.h.

References ntuplePlotting::draw(), createfilelist::int, cmsBatch::log, TtFullHadEvtBuilder_cfi::prob, and probY_mask.

Referenced by PixelCPEBase::rawQualityWord().

133  {
134  if(prob<0 || prob>1) {
135  edm::LogWarning("OutOfBounds") << "Prob Q outside the bounds of the quality word. Defaulting to Prob=0. Prob = " << prob << " QualityWord = " << qualWord;
136  prob=0;
137  }
138  double draw = (prob<=1E-5) ? 255 : - log( (double) prob ) * probY_1_over_log_units;
139  unsigned int raw = (int) (draw+0.5); // convert to integer, round correctly
140  // cout << "Prob = " << prob << " --> Bits = " << raw << endl;
141  qualWord |= ((raw & probY_mask) << probY_shift);
142  }
TtFullHadEvtBuilder_cfi.prob
prob
Definition: TtFullHadEvtBuilder_cfi.py:33
ntuplePlotting.draw
def draw(name, histos, styles, legendLabels=[], xtitle=None, ytitle=None, drawOpt="HIST", legendDx=0, legendDy=0, legendDw=0, legendDh=0, xmin=None, ymin=0, xmax=None, ymax=None, xlog=False, ylog=False, xgrid=True, ygrid=True, ratio=False, ratioYmin=0.5, ratioYmax=1.5, ratioYTitle=plotting._ratioYTitle)
Definition: ntuplePlotting.py:23
void SiPixelRecHitQuality::Packing::setProbabilityXY ( float  prob,
QualWordType &  qualWord 
) const
inline

Definition at line 123 of file SiPixelRecHitQuality.h.

References ntuplePlotting::draw(), createfilelist::int, cmsBatch::log, TtFullHadEvtBuilder_cfi::prob, and probX_mask.

Referenced by PixelCPEBase::rawQualityWord().

123  {
124  if(prob<0 || prob>1) {
125  edm::LogWarning("OutOfBounds") << "Prob XY outside the bounds of the quality word. Defaulting to Prob=0. Prob = " << prob << " QualityWord = " << qualWord;
126  prob=0;
127  }
128  double draw = (prob<=1.6E-13) ? 16383 : - log( (double) prob ) * probX_1_over_log_units;
129  unsigned int raw = (int) (draw+0.5); // convert to integer, round correctly
130  // cout << "Prob = " << prob << " --> Bits = " << raw << endl;
131  qualWord |= ((raw & probX_mask) << probX_shift);
132  }
TtFullHadEvtBuilder_cfi.prob
prob
Definition: TtFullHadEvtBuilder_cfi.py:33
ntuplePlotting.draw
def draw(name, histos, styles, legendLabels=[], xtitle=None, ytitle=None, drawOpt="HIST", legendDx=0, legendDy=0, legendDw=0, legendDh=0, xmin=None, ymin=0, xmax=None, ymax=None, xlog=False, ylog=False, xgrid=True, ygrid=True, ratio=False, ratioYmin=0.5, ratioYmax=1.5, ratioYTitle=plotting._ratioYTitle)
Definition: ntuplePlotting.py:23
void SiPixelRecHitQuality::Packing::setQBin ( int  qbin,
QualWordType &  qualWord 
) const
inline

Definition at line 145 of file SiPixelRecHitQuality.h.

References qBin_mask.

Referenced by PixelCPEBase::rawQualityWord().

145  {
146  if(qbin<0 || qbin >7) {
147  edm::LogWarning("OutOfBounds") << "Qbin outside the bounds of the quality word. Defaulting to Qbin=0. Qbin = " << qbin << " QualityWord = " << qualWord;
148  qbin=0;
149  }
150  qualWord |= ((qbin & qBin_mask) << qBin_shift);
151  }
void SiPixelRecHitQuality::Packing::setSpansTwoROCs ( bool  flag,
QualWordType &  qualWord 
) const
inline

Definition at line 159 of file SiPixelRecHitQuality.h.

References twoROC_mask.

Referenced by PixelCPEBase::rawQualityWord().

159  {
160  qualWord |= ((flag & twoROC_mask) << twoROC_shift);
161  }
bool SiPixelRecHitQuality::Packing::spansTwoROCs ( QualWordType  qualWord) const
inline

Definition at line 111 of file SiPixelRecHitQuality.h.

References twoROC_mask.

Referenced by SiPixelRecHit::spansTwoROCs().

111  {
112  return (qualWord >> twoROC_shift) & twoROC_mask;
113  }

Member Data Documentation

QualWordType SiPixelRecHitQuality::Packing::bad_mask

Definition at line 43 of file SiPixelRecHitQuality.h.

Referenced by hasBadPixels(), Packing(), and setHasBadPixels().

int SiPixelRecHitQuality::Packing::bad_shift

Definition at line 44 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::bad_width

Definition at line 45 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::edge_mask

Definition at line 39 of file SiPixelRecHitQuality.h.

Referenced by isOnEdge(), Packing(), and setIsOnEdge().

int SiPixelRecHitQuality::Packing::edge_shift

Definition at line 40 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::edge_width

Definition at line 41 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::hasFilledProb_mask

Definition at line 51 of file SiPixelRecHitQuality.h.

Referenced by hasFilledProb(), Packing(), and setHasFilledProb().

int SiPixelRecHitQuality::Packing::hasFilledProb_shift

Definition at line 52 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::hasFilledProb_width

Definition at line 53 of file SiPixelRecHitQuality.h.

Referenced by Packing().

double SiPixelRecHitQuality::Packing::probX_1_over_log_units

Definition at line 26 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::probX_mask

Definition at line 23 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and setProbabilityXY().

int SiPixelRecHitQuality::Packing::probX_shift

Definition at line 24 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and probabilityXY().

float SiPixelRecHitQuality::Packing::probX_units

Definition at line 25 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::probX_width

Definition at line 27 of file SiPixelRecHitQuality.h.

Referenced by Packing().

double SiPixelRecHitQuality::Packing::probY_1_over_log_units

Definition at line 32 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::probY_mask

Definition at line 29 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and setProbabilityQ().

int SiPixelRecHitQuality::Packing::probY_shift

Definition at line 30 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and probabilityQ().

float SiPixelRecHitQuality::Packing::probY_units

Definition at line 31 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::probY_width

Definition at line 33 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::qBin_mask

Definition at line 35 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and setQBin().

int SiPixelRecHitQuality::Packing::qBin_shift

Definition at line 36 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and qBin().

char SiPixelRecHitQuality::Packing::qBin_width

Definition at line 37 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::spare_width

Definition at line 55 of file SiPixelRecHitQuality.h.

Referenced by Packing().

QualWordType SiPixelRecHitQuality::Packing::twoROC_mask

Definition at line 47 of file SiPixelRecHitQuality.h.

Referenced by Packing(), setSpansTwoROCs(), and spansTwoROCs().

int SiPixelRecHitQuality::Packing::twoROC_shift

Definition at line 48 of file SiPixelRecHitQuality.h.

Referenced by Packing().

char SiPixelRecHitQuality::Packing::twoROC_width

Definition at line 49 of file SiPixelRecHitQuality.h.

Referenced by Packing().

Generated for CMSSW Reference Manual by doxygen 1.8.11