#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.

 {
   // 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);
 }

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().

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

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

inline

Definition at line 115 of file SiPixelRecHitQuality.h.

References hasFilledProb_mask.

Referenced by SiPixelRecHit::hasFilledProb().

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

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

inline

Definition at line 103 of file SiPixelRecHitQuality.h.

References edge_mask.

Referenced by SiPixelRecHit::isOnEdge().

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

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().

                                                                  {
       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;
     }

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

inline

Definition at line 62 of file SiPixelRecHitQuality.h.

Referenced by SiPixelRecHit::probabilityX().

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

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().

                                                                   {
       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;
     }

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

inline

Definition at line 66 of file SiPixelRecHitQuality.h.

Referenced by SiPixelRecHit::probabilityY().

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

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

inline

Definition at line 93 of file SiPixelRecHitQuality.h.

References qBin_shift.

Referenced by SiPixelRecHit::qBin().

                                                        {
       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;
     }

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().

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

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().

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

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().

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

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

inline

Definition at line 133 of file SiPixelRecHitQuality.h.

References createfilelist::int, cmsBatch::log, TtFullHadEvtBuilder_cfi::prob, and probY_mask.

Referenced by PixelCPEBase::rawQualityWord().

                                                                              {
       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);
     }

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

inline

Definition at line 123 of file SiPixelRecHitQuality.h.

References createfilelist::int, cmsBatch::log, TtFullHadEvtBuilder_cfi::prob, and probX_mask.

Referenced by PixelCPEBase::rawQualityWord().

                                                                               {
       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);
     }

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().

                                                                    {
       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);
     }

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().

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

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

inline

Definition at line 111 of file SiPixelRecHitQuality.h.

References twoROC_mask.

Referenced by SiPixelRecHit::spansTwoROCs().

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

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().

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation