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 13 of file SiPixelRecHitQuality.h.

Constructor & Destructor Documentation

Packing()

SiPixelRecHitQuality::Packing::Packing

(

)

Definition at line 5 of file SiPixelRecHitQuality.cc.

                                     {
  // Constructor: pre-computes masks and shifts from field widths
  // X is now XY
  // Y is now Q
  probX_width = 14;
  probY_width = 8;
  qBin_width = 3;
  edge_width = 1;
  bad_width = 1;
  twoROC_width = 1;
  hasFilledProb_width = 1;
  spare_width = 3;
 
  if (probX_width + probY_width + qBin_width + edge_width + bad_width + twoROC_width + hasFilledProb_width +
          spare_width !=
      32) {
    throw cms::Exception("SiPixelRecHitQuality::Packing: ")
        << "\nERROR: The allocated bits for the quality word to not sum to 32."
        << "\n\n";
  }
 
  probX_units = 1.0018;
  probY_units = 1.0461;
  probX_1_over_log_units = 1.0 / log(probX_units);
  probY_1_over_log_units = 1.0 / log(probY_units);
 
  // Fields are counted from right to left!
  probX_shift = 0;
  probY_shift = probX_shift + probX_width;
  qBin_shift = probY_shift + probY_width;
  edge_shift = qBin_shift + qBin_width;
  bad_shift = edge_shift + edge_width;
  twoROC_shift = bad_shift + bad_width;
  hasFilledProb_shift = twoROC_shift + twoROC_width;
 
  // Ensure the complement of the correct
  // number of bits:
  QualWordType zero32 = 0;  // 32-bit wide set of 0's
 
  probX_mask = ~(~zero32 << probX_width);
  probY_mask = ~(~zero32 << probY_width);
  qBin_mask = ~(~zero32 << qBin_width);
  edge_mask = ~(~zero32 << edge_width);
  bad_mask = ~(~zero32 << bad_width);
  twoROC_mask = ~(~zero32 << twoROC_width);
  hasFilledProb_mask = ~(~zero32 << hasFilledProb_width);
}

References bad_mask, bad_shift, bad_width, edge_mask, edge_shift, edge_width, Exception, hasFilledProb_mask, hasFilledProb_shift, hasFilledProb_width, dqm-mbProfile::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, twoROC_mask, twoROC_shift, and twoROC_width.

Member Function Documentation

hasBadPixels()

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

inline

Definition at line 108 of file SiPixelRecHitQuality.h.

{ return (qualWord >> bad_shift) & bad_mask; }

References bad_mask, and bad_shift.

Referenced by SiPixelRecHit::hasBadPixels().

hasFilledProb()

bool SiPixelRecHitQuality::Packing::hasFilledProb ( QualWordType  qualWord ) const

inline

Definition at line 112 of file SiPixelRecHitQuality.h.

                                                           {
      return (qualWord >> hasFilledProb_shift) & hasFilledProb_mask;
    }

References hasFilledProb_mask, and hasFilledProb_shift.

Referenced by SiPixelRecHit::hasFilledProb().

isOnEdge()

bool SiPixelRecHitQuality::Packing::isOnEdge ( QualWordType  qualWord ) const

inline

Definition at line 106 of file SiPixelRecHitQuality.h.

{ return (qualWord >> edge_shift) & edge_mask; }

References edge_mask, and edge_shift.

Referenced by SiPixelRecHit::isOnEdge().

probabilityQ()

float SiPixelRecHitQuality::Packing::probabilityQ ( QualWordType  qualWord ) const

inline

Definition at line 81 of file SiPixelRecHitQuality.h.

                                                           {
      int raw = (qualWord >> probY_shift) & probY_mask;
      if (raw < 0 || raw > 255) {
        edm::LogWarning("OutOfBounds")
            << "Probability Q outside the bounds of the quality word. Defaulting to Prob=0. Raw = " << raw
            << " QualityWord = " << qualWord;
        raw = 255;
      }
      float prob = (raw == 255) ? 0 : pow(probY_units, (float)(-raw));
      // cout << "Bits = " << raw << " --> Prob = " << prob << endl;
      return prob;
    }

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

Referenced by SiPixelRecHit::probabilityQ().

probabilityX()

float SiPixelRecHitQuality::Packing::probabilityX ( QualWordType  qualWord ) const

inline

Definition at line 58 of file SiPixelRecHitQuality.h.

                                                           {
      edm::LogWarning("ObsoleteVariable")
          << "Since 39x, probabilityX and probabilityY have been replaced by probabilityXY and probabilityQ";
      return -10;
    }

Referenced by SiPixelRecHit::probabilityX().

probabilityXY()

float SiPixelRecHitQuality::Packing::probabilityXY ( QualWordType  qualWord ) const

inline

Definition at line 69 of file SiPixelRecHitQuality.h.

                                                            {
      int raw = (qualWord >> probX_shift) & probX_mask;
      if (raw < 0 || raw > 16383) {
        edm::LogWarning("OutOfBounds")
            << "Probability XY outside the bounds of the quality word. Defaulting to Prob=0. Raw = " << raw
            << " QualityWord = " << qualWord;
        raw = 16383;
      }
      float prob = (raw == 16383) ? 0 : pow(probX_units, (float)(-raw));
      // cout << "Bits = " << raw << " --> Prob = " << prob << endl;
      return prob;
    }

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

Referenced by SiPixelRecHit::probabilityXY().

probabilityY()

float SiPixelRecHitQuality::Packing::probabilityY ( QualWordType  qualWord ) const

inline

Definition at line 63 of file SiPixelRecHitQuality.h.

                                                           {
      edm::LogWarning("ObsoleteVariable")
          << "Since 39x, probabilityX and probabilityY have been replaced by probabilityXY and probabilityQ";
      return -10;
    }

Referenced by SiPixelRecHit::probabilityY().

qBin()

int SiPixelRecHitQuality::Packing::qBin ( QualWordType  qualWord ) const

inline

Definition at line 95 of file SiPixelRecHitQuality.h.

                                                 {
      int qbin = (qualWord >> qBin_shift) & qBin_mask;
      if (qbin < 0 || qbin > 7) {
        edm::LogWarning("OutOfBounds") << "Qbin outside the bounds of the quality word. Defaulting to Qbin=0. Qbin = "
                                       << qbin << " QualityWord = " << qualWord;
        qbin = 0;
      }
      return qbin;
    }

References qBin_mask, and qBin_shift.

Referenced by SiPixelRecHit::qBin().

setHasBadPixels()

void SiPixelRecHitQuality::Packing::setHasBadPixels ( bool  flag, QualWordType &  qualWord  ) const

inline

Definition at line 154 of file SiPixelRecHitQuality.h.

                                                                         {
      qualWord |= ((flag & bad_mask) << bad_shift);
    }

References bad_mask, bad_shift, and RemoveAddSevLevel::flag.

Referenced by PixelCPEBase::rawQualityWord().

setHasFilledProb()

void SiPixelRecHitQuality::Packing::setHasFilledProb ( bool  flag, QualWordType &  qualWord  ) const

inline

Definition at line 160 of file SiPixelRecHitQuality.h.

                                                                          {
      qualWord |= ((flag & hasFilledProb_mask) << hasFilledProb_shift);
    }

References RemoveAddSevLevel::flag, hasFilledProb_mask, and hasFilledProb_shift.

Referenced by PixelCPEBase::rawQualityWord().

setIsOnEdge()

void SiPixelRecHitQuality::Packing::setIsOnEdge ( bool  flag, QualWordType &  qualWord  ) const

inline

Definition at line 153 of file SiPixelRecHitQuality.h.

{ qualWord |= ((flag & edge_mask) << edge_shift); }

References edge_mask, edge_shift, and RemoveAddSevLevel::flag.

Referenced by PixelCPEBase::rawQualityWord().

setProbabilityQ()

void SiPixelRecHitQuality::Packing::setProbabilityQ ( float  prob, QualWordType &  qualWord  ) const

inline

Definition at line 132 of file SiPixelRecHitQuality.h.

                                                                          {
      if (prob < 0 || prob > 1) {
        edm::LogWarning("OutOfBounds") << "Prob Q outside the bounds of the quality word. Defaulting to Prob=0. Prob = "
                                       << prob << " QualityWord = " << qualWord;
        prob = 0;
      }
      double draw = (prob <= 1E-5) ? 255 : -log((double)prob) * probY_1_over_log_units;
      unsigned int raw = (int)(draw + 0.5);  // convert to integer, round correctly
      // cout << "Prob = " << prob << " --> Bits = " << raw << endl;
      qualWord |= ((raw & probY_mask) << probY_shift);
    }

References ntuplePlotting::draw(), createfilelist::int, dqm-mbProfile::log, TtFullHadEvtBuilder_cfi::prob, probY_1_over_log_units, probY_mask, and probY_shift.

Referenced by PixelCPEBase::rawQualityWord().

setProbabilityXY()

void SiPixelRecHitQuality::Packing::setProbabilityXY ( float  prob, QualWordType &  qualWord  ) const

inline

Definition at line 120 of file SiPixelRecHitQuality.h.

                                                                           {
      if (prob < 0 || prob > 1) {
        edm::LogWarning("OutOfBounds")
            << "Prob XY outside the bounds of the quality word. Defaulting to Prob=0. Prob = " << prob
            << " QualityWord = " << qualWord;
        prob = 0;
      }
      double draw = (prob <= 1.6E-13) ? 16383 : -log((double)prob) * probX_1_over_log_units;
      unsigned int raw = (int)(draw + 0.5);  // convert to integer, round correctly
      // cout << "Prob = " << prob << " --> Bits = " << raw << endl;
      qualWord |= ((raw & probX_mask) << probX_shift);
    }

References ntuplePlotting::draw(), createfilelist::int, dqm-mbProfile::log, TtFullHadEvtBuilder_cfi::prob, probX_1_over_log_units, probX_mask, and probX_shift.

Referenced by PixelCPEBase::rawQualityWord().

setQBin()

void SiPixelRecHitQuality::Packing::setQBin ( int  qbin, QualWordType &  qualWord  ) const

inline

Definition at line 144 of file SiPixelRecHitQuality.h.

                                                                {
      if (qbin < 0 || qbin > 7) {
        edm::LogWarning("OutOfBounds") << "Qbin outside the bounds of the quality word. Defaulting to Qbin=0. Qbin = "
                                       << qbin << " QualityWord = " << qualWord;
        qbin = 0;
      }
      qualWord |= ((qbin & qBin_mask) << qBin_shift);
    }

References qBin_mask, and qBin_shift.

Referenced by PixelCPEBase::rawQualityWord().

setSpansTwoROCs()

void SiPixelRecHitQuality::Packing::setSpansTwoROCs ( bool  flag, QualWordType &  qualWord  ) const

inline

Definition at line 157 of file SiPixelRecHitQuality.h.

                                                                         {
      qualWord |= ((flag & twoROC_mask) << twoROC_shift);
    }

References RemoveAddSevLevel::flag, twoROC_mask, and twoROC_shift.

Referenced by PixelCPEBase::rawQualityWord().

spansTwoROCs()

bool SiPixelRecHitQuality::Packing::spansTwoROCs ( QualWordType  qualWord ) const

inline

Definition at line 110 of file SiPixelRecHitQuality.h.

{ return (qualWord >> twoROC_shift) & twoROC_mask; }

References twoROC_mask, and twoROC_shift.

Referenced by SiPixelRecHit::spansTwoROCs().

Member Data Documentation

bad_mask

QualWordType SiPixelRecHitQuality::Packing::bad_mask

Definition at line 39 of file SiPixelRecHitQuality.h.

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

bad_shift

int SiPixelRecHitQuality::Packing::bad_shift

Definition at line 40 of file SiPixelRecHitQuality.h.

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

bad_width

char SiPixelRecHitQuality::Packing::bad_width

Definition at line 41 of file SiPixelRecHitQuality.h.

Referenced by Packing().

edge_mask

QualWordType SiPixelRecHitQuality::Packing::edge_mask

Definition at line 35 of file SiPixelRecHitQuality.h.

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

edge_shift

int SiPixelRecHitQuality::Packing::edge_shift

Definition at line 36 of file SiPixelRecHitQuality.h.

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

edge_width

char SiPixelRecHitQuality::Packing::edge_width

Definition at line 37 of file SiPixelRecHitQuality.h.

Referenced by Packing().

hasFilledProb_mask

QualWordType SiPixelRecHitQuality::Packing::hasFilledProb_mask

Definition at line 47 of file SiPixelRecHitQuality.h.

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

hasFilledProb_shift

int SiPixelRecHitQuality::Packing::hasFilledProb_shift

Definition at line 48 of file SiPixelRecHitQuality.h.

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

hasFilledProb_width

char SiPixelRecHitQuality::Packing::hasFilledProb_width

Definition at line 49 of file SiPixelRecHitQuality.h.

Referenced by Packing().

probX_1_over_log_units

double SiPixelRecHitQuality::Packing::probX_1_over_log_units

Definition at line 22 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and setProbabilityXY().

probX_mask

QualWordType SiPixelRecHitQuality::Packing::probX_mask

Definition at line 19 of file SiPixelRecHitQuality.h.

Referenced by Packing(), probabilityXY(), and setProbabilityXY().

probX_shift

int SiPixelRecHitQuality::Packing::probX_shift

Definition at line 20 of file SiPixelRecHitQuality.h.

Referenced by Packing(), probabilityXY(), and setProbabilityXY().

probX_units

float SiPixelRecHitQuality::Packing::probX_units

Definition at line 21 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and probabilityXY().

probX_width

char SiPixelRecHitQuality::Packing::probX_width

Definition at line 23 of file SiPixelRecHitQuality.h.

Referenced by Packing().

probY_1_over_log_units

double SiPixelRecHitQuality::Packing::probY_1_over_log_units

Definition at line 28 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and setProbabilityQ().

probY_mask

QualWordType SiPixelRecHitQuality::Packing::probY_mask

Definition at line 25 of file SiPixelRecHitQuality.h.

Referenced by Packing(), probabilityQ(), and setProbabilityQ().

probY_shift

int SiPixelRecHitQuality::Packing::probY_shift

Definition at line 26 of file SiPixelRecHitQuality.h.

Referenced by Packing(), probabilityQ(), and setProbabilityQ().

probY_units

float SiPixelRecHitQuality::Packing::probY_units

Definition at line 27 of file SiPixelRecHitQuality.h.

Referenced by Packing(), and probabilityQ().

probY_width

char SiPixelRecHitQuality::Packing::probY_width

Definition at line 29 of file SiPixelRecHitQuality.h.

Referenced by Packing().

qBin_mask

QualWordType SiPixelRecHitQuality::Packing::qBin_mask

Definition at line 31 of file SiPixelRecHitQuality.h.

Referenced by Packing(), qBin(), and setQBin().

qBin_shift

int SiPixelRecHitQuality::Packing::qBin_shift

Definition at line 32 of file SiPixelRecHitQuality.h.

Referenced by Packing(), qBin(), and setQBin().

qBin_width

char SiPixelRecHitQuality::Packing::qBin_width

Definition at line 33 of file SiPixelRecHitQuality.h.

Referenced by Packing().

spare_width

char SiPixelRecHitQuality::Packing::spare_width

Definition at line 51 of file SiPixelRecHitQuality.h.

Referenced by Packing().

twoROC_mask

QualWordType SiPixelRecHitQuality::Packing::twoROC_mask

Definition at line 43 of file SiPixelRecHitQuality.h.

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

twoROC_shift

int SiPixelRecHitQuality::Packing::twoROC_shift

Definition at line 44 of file SiPixelRecHitQuality.h.

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

twoROC_width

char SiPixelRecHitQuality::Packing::twoROC_width

Definition at line 45 of file SiPixelRecHitQuality.h.

Referenced by Packing().