CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
EcalRecHit Class Reference

#include <EcalRecHit.h>

Public Types

enum  ESFlags {
  kESGood, kESDead, kESHot, kESPassBX,
  kESTwoGoodRatios, kESBadRatioFor12, kESBadRatioFor23Upper, kESBadRatioFor23Lower,
  kESTS1Largest, kESTS3Largest, kESTS3Negative, kESSaturated,
  kESTS2Saturated, kESTS3Saturated, kESTS13Sigmas, kESTS15Sigmas
}
 
enum  Flags {
  kGood =0, kPoorReco, kOutOfTime, kFaultyHardware,
  kNoisy, kPoorCalib, kSaturated, kLeadingEdgeRecovered,
  kNeighboursRecovered, kTowerRecovered, kDead, kKilled,
  kTPSaturated, kL1SpikeFlag, kWeird, kDiWeird,
  kHasSwitchToGain6, kHasSwitchToGain1, kUnknown
}
 
typedef DetId key_type
 

Public Member Functions

bool checkFlag (int flag) const
 check if the flag is true More...
 
bool checkFlagMask (uint32_t mask) const
 apply a bitmask to our flags. Experts only More...
 
bool checkFlags (const std::vector< int > &flagsvec) const
 check if one of the flags in a set is true More...
 
float chi2 () const
 
const DetIddetid () const
 
 EcalRecHit ()
 
 EcalRecHit (const DetId &id, float energy, float time, uint32_t extra=0, uint32_t flagBits=0)
 
float energy () const
 
float energyError () const
 
DetId id () const
 get the id More...
 
bool isRecovered () const
 
bool isTimeErrorValid () const
 
bool isTimeValid () const
 
Flags recoFlag () const
 DEPRECATED provided for temporary backward compatibility. More...
 
void setChi2 (float chi2)
 
void setEnergy (float energy)
 
void setEnergyError (float energy)
 
void setFlag (int flag)
 set the flags (from Flags or ESFlags) More...
 
void setTimeError (uint8_t timeErrBits)
 
float time () const
 
float timeError () const
 
void unsetFlag (int flag)
 

Static Public Member Functions

static uint32_t getMasked (uint32_t value, uint32_t offset, uint32_t width)
 
static int getPower10 (float e)
 
static uint32_t setMasked (uint32_t value, uint32_t x, uint32_t offset, uint32_t width)
 

Private Attributes

float energy_
 
uint32_t extra_
 
uint32_t flagBits_
 store rechit condition (see Flags enum) in a bit-wise way More...
 
DetId id_
 
float time_
 

Detailed Description

Author
P. Meridiani INFN Roma1

Definition at line 15 of file EcalRecHit.h.

Member Typedef Documentation

Definition at line 17 of file EcalRecHit.h.

Member Enumeration Documentation

Enumerator
kESGood 
kESDead 
kESHot 
kESPassBX 
kESTwoGoodRatios 
kESBadRatioFor12 
kESBadRatioFor23Upper 
kESBadRatioFor23Lower 
kESTS1Largest 
kESTS3Largest 
kESTS3Negative 
kESSaturated 
kESTS2Saturated 
kESTS3Saturated 
kESTS13Sigmas 
kESTS15Sigmas 

Definition at line 44 of file EcalRecHit.h.

Enumerator
kGood 
kPoorReco 
kOutOfTime 
kFaultyHardware 
kNoisy 
kPoorCalib 
kSaturated 
kLeadingEdgeRecovered 
kNeighboursRecovered 
kTowerRecovered 
kDead 
kKilled 
kTPSaturated 
kL1SpikeFlag 
kWeird 
kDiWeird 
kHasSwitchToGain6 
kHasSwitchToGain1 
kUnknown 

Definition at line 20 of file EcalRecHit.h.

Constructor & Destructor Documentation

EcalRecHit::EcalRecHit ( )
inline

Definition at line 63 of file EcalRecHit.h.

EcalRecHit::EcalRecHit ( const DetId id,
float  energy,
float  time,
uint32_t  extra = 0,
uint32_t  flagBits = 0 
)
inlineexplicit

Definition at line 65 of file EcalRecHit.h.

Member Function Documentation

bool EcalRecHit::checkFlag ( int  flag) const
inline

check if the flag is true

Definition at line 188 of file EcalRecHit.h.

Referenced by EcalSeverityLevelAlgo::severityLevel().

bool EcalRecHit::checkFlagMask ( uint32_t  mask) const
inline

apply a bitmask to our flags. Experts only

Definition at line 202 of file EcalRecHit.h.

Referenced by EcalSeverityLevelAlgo::severityLevel().

bool EcalRecHit::checkFlags ( const std::vector< int > &  flagsvec) const
inline

check if one of the flags in a set is true

Definition at line 191 of file EcalRecHit.h.

float EcalRecHit::chi2 ( void  ) const
inline

Definition at line 120 of file EcalRecHit.h.

const DetId& EcalRecHit::detid ( ) const
inline
float EcalRecHit::energy ( ) const
inline
float EcalRecHit::energyError ( ) const
inline

Definition at line 134 of file EcalRecHit.h.

static uint32_t EcalRecHit::getMasked ( uint32_t  value,
uint32_t  offset,
uint32_t  width 
)
inlinestatic

Definition at line 96 of file EcalRecHit.h.

static int EcalRecHit::getPower10 ( float  e)
inlinestatic

Definition at line 107 of file EcalRecHit.h.

DetId EcalRecHit::id ( ) const
inline

get the id

Definition at line 76 of file EcalRecHit.h.

Referenced by EcalLaserCorrFilter::filter(), and EcalRecHitsFilter::filter().

bool EcalRecHit::isRecovered ( ) const
inline

Definition at line 78 of file EcalRecHit.h.

bool EcalRecHit::isTimeErrorValid ( ) const
inline

Definition at line 86 of file EcalRecHit.h.

bool EcalRecHit::isTimeValid ( ) const
inline

Definition at line 84 of file EcalRecHit.h.

Flags EcalRecHit::recoFlag ( ) const
inline

DEPRECATED provided for temporary backward compatibility.

Definition at line 205 of file EcalRecHit.h.

void EcalRecHit::setChi2 ( float  chi2)
inline

Definition at line 125 of file EcalRecHit.h.

Referenced by EcalRecHitSimpleAlgo::makeRecHit().

void EcalRecHit::setEnergy ( float  energy)
inline

Definition at line 69 of file EcalRecHit.h.

Referenced by CaloRecHitMixer< T >::buildRecHit().

void EcalRecHit::setEnergyError ( float  energy)
inline

Definition at line 143 of file EcalRecHit.h.

void EcalRecHit::setFlag ( int  flag)
inline

set the flags (from Flags or ESFlags)

Definition at line 184 of file EcalRecHit.h.

Referenced by ESRecHitAnalyticAlgo::reconstruct(), and ESRecHitFitAlgo::reconstruct().

static uint32_t EcalRecHit::setMasked ( uint32_t  value,
uint32_t  x,
uint32_t  offset,
uint32_t  width 
)
inlinestatic

Definition at line 100 of file EcalRecHit.h.

void EcalRecHit::setTimeError ( uint8_t  timeErrBits)
inline

Definition at line 179 of file EcalRecHit.h.

float EcalRecHit::time ( ) const
inline

Definition at line 70 of file EcalRecHit.h.

Referenced by operator<<().

float EcalRecHit::timeError ( ) const
inline

Definition at line 164 of file EcalRecHit.h.

void EcalRecHit::unsetFlag ( int  flag)
inline

Definition at line 185 of file EcalRecHit.h.

Member Data Documentation

float EcalRecHit::energy_
private

Definition at line 218 of file EcalRecHit.h.

uint32_t EcalRecHit::extra_
private

Definition at line 225 of file EcalRecHit.h.

uint32_t EcalRecHit::flagBits_
private

store rechit condition (see Flags enum) in a bit-wise way

Definition at line 222 of file EcalRecHit.h.

DetId EcalRecHit::id_
private

Definition at line 217 of file EcalRecHit.h.

float EcalRecHit::time_
private

Definition at line 219 of file EcalRecHit.h.