#include <HGCRecHit.h>

Inheritance diagram for HGCRecHit:

Public Types
enum	Flags { kGood = 0, kPoorReco, kOutOfTime, kFaultyHardware, kNoisy, kPoorCalib, kSaturated, kDead, kKilled, kWeird, kDiWeird, kUnknown }

enum	HFNoseFlags { kHFNoseGood, kHFNosePoorReco, kHFNoseOutOfTime, kHFNoseFaultyHardware, kHFNoseNoisy, kHFNosePoorCalib, kHFNoseSaturated, kHFNoseDead, kHFNoseKilled, kHFNoseWeird, kHFNoseDiWeird, kHFNoseUnknown }

enum	HGCbheFlags { kHGCbheGood, kHGCbheDead, kHGCbheHot, kHGCbhePassBX, kHGCbheSaturated }

enum	HGCfheFlags { kHGCfheGood, kHGCfheDead, kHGCfheHot, kHGCfhePassBX, kHGCfheSaturated }

typedef DetId	key_type

Public Member Functions
bool	checkFlag (int flag) const
	check if the flag is true More...

bool	checkFlags (const std::vector< int > &flagsvec) const
	check if one of the flags in a set is true More...

float	chi2 () const

	HGCRecHit ()

	HGCRecHit (const DetId &id, float energy, float time, uint32_t flags=0, uint32_t flagBits=0)

DetId	id () const
	get the id More...

bool	isTimeErrorValid () const

bool	isTimeValid () const

float	outOfTimeChi2 () const

float	outOfTimeEnergy () const

void	setChi2 (float chi2)

void	setFlag (int flag)
	set the flags (from Flags or ESFlags) More...

void	setOutOfTimeChi2 (float chi2)

void	setOutOfTimeEnergy (float energy)

void	setSignalOverSigmaNoise (float sOverNoise)

void	setTimeError (float timeErr)

float	signalOverSigmaNoise () const

float	timeError () const

void	unsetFlag (int flag)

Public Member Functions inherited from CaloRecHit
constexpr uint32_t	aux () const

constexpr	CaloRecHit ()

constexpr	CaloRecHit (const DetId &id, float energy, float time, uint32_t flags=0, uint32_t aux=0)

constexpr const DetId &	detid () const

constexpr float	energy () const

constexpr uint32_t	flagField (int base, int width=1) const

constexpr uint32_t	flags () const

constexpr void	setAux (uint32_t value)

constexpr void	setEnergy (float energy)

constexpr void	setFlagField (uint32_t value, int base, int width=1)

constexpr void	setFlags (uint32_t flags)

constexpr void	setTime (float time)

constexpr float	time () const

Private Attributes
uint32_t	flagBits_
	store rechit condition (see Flags enum) in a bit-wise way More...

uint8_t	signalOverSigmaNoise_

float	timeError_

Detailed Description

based on EcalRecHit

Author: Valeri Andreev

Definition at line 14 of file HGCRecHit.h.

Member Typedef Documentation

◆ key_type

typedef DetId HGCRecHit::key_type

Definition at line 16 of file HGCRecHit.h.

Member Enumeration Documentation

◆ Flags

enum HGCRecHit::Flags

Enumerator
kGood
kPoorReco
kOutOfTime
kFaultyHardware
kNoisy
kPoorCalib
kSaturated
kDead
kKilled
kWeird
kDiWeird
kUnknown

Definition at line 19 of file HGCRecHit.h.

              {
     kGood = 0,   // channel ok, the energy and time measurement are reliable
     kPoorReco,   // the energy is available from the UncalibRecHit, but approximate (bad shape, large chi2)
     kOutOfTime,  // the energy is available from the UncalibRecHit (sync reco), but the event is out of time
     kFaultyHardware,  // The energy is available from the UncalibRecHit, channel is faulty at some hardware level (e.g. noisy)
     kNoisy,           // the channel is very noisy
     kPoorCalib,  // the energy is available from the UncalibRecHit, but the calibration of the channel is poor
     kSaturated,  // saturated channel (recovery not tried)
     kDead,       // channel is dead and any recovery fails
     kKilled,     // MC only flag: the channel is killed in the real detector
     kWeird,      // the signal is believed to originate from an anomalous deposit (spike)
     kDiWeird,    // the signal is anomalous, and neighbors another anomalous signal
                  //
     kUnknown     // to ease the interface with functions returning flags.
   };

◆ HFNoseFlags

enum HGCRecHit::HFNoseFlags

Enumerator
kHFNoseGood
kHFNosePoorReco
kHFNoseOutOfTime
kHFNoseFaultyHardware
kHFNoseNoisy
kHFNosePoorCalib
kHFNoseSaturated
kHFNoseDead
kHFNoseKilled
kHFNoseWeird
kHFNoseDiWeird
kHFNoseUnknown

Definition at line 42 of file HGCRecHit.h.

                    {
     kHFNoseGood,
     kHFNosePoorReco,
     kHFNoseOutOfTime,
     kHFNoseFaultyHardware,
     kHFNoseNoisy,
     kHFNosePoorCalib,
     kHFNoseSaturated,
     kHFNoseDead,
     kHFNoseKilled,
     kHFNoseWeird,
     kHFNoseDiWeird,
     kHFNoseUnknown
   };

◆ HGCbheFlags

enum HGCRecHit::HGCbheFlags

Enumerator
kHGCbheGood
kHGCbheDead
kHGCbheHot
kHGCbhePassBX
kHGCbheSaturated

Definition at line 39 of file HGCRecHit.h.

39 { kHGCbheGood, kHGCbheDead, kHGCbheHot, kHGCbhePassBX, kHGCbheSaturated };

◆ HGCfheFlags

enum HGCRecHit::HGCfheFlags

Enumerator
kHGCfheGood
kHGCfheDead
kHGCfheHot
kHGCfhePassBX
kHGCfheSaturated

Definition at line 36 of file HGCRecHit.h.

36 { kHGCfheGood, kHGCfheDead, kHGCfheHot, kHGCfhePassBX, kHGCfheSaturated };

Constructor & Destructor Documentation

◆ HGCRecHit() [1/2]

HGCRecHit::HGCRecHit ( )

bit structure of CaloRecHit::flags_ used in EcalRecHit:

| 32 | 31...25 | 24...12 | 11...5 | 4...1 | | | | | | | | | | +--> reco flags ( 4 bits) | | | +--> chi2 for in time events ( 7 bits) | | +--> energy for out-of-time events (13 bits) | +--> chi2 for out-of-time events ( 7 bits) +--> spare ( 1 bit )

Definition at line 10 of file HGCRecHit.cc.

10 : CaloRecHit(), flagBits_(0) {}

◆ HGCRecHit() [2/2]

HGCRecHit::HGCRecHit	(	const DetId &	id,
		float	energy,
		float	time,
		uint32_t	flags = `0`,
		uint32_t	flagBits = `0`
	)

Definition at line 12 of file HGCRecHit.cc.

13 : CaloRecHit(id, energy, time, flags), flagBits_(flagBits) {}

Member Function Documentation

◆ checkFlag()

bool HGCRecHit::checkFlag ( int flag ) const

inline

check if the flag is true

Definition at line 99 of file HGCRecHit.h.

99 { return flagBits_ & (0x1 << flag); }

References RemoveAddSevLevel::flag, and flagBits_.

Referenced by checkFlags().

◆ checkFlags()

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

check if one of the flags in a set is true

Definition at line 97 of file HGCRecHit.cc.

                                                                {
   for (std::vector<int>::const_iterator flagPtr = flagsvec.begin(); flagPtr != flagsvec.end();
        ++flagPtr) {  // check if one of the flags is up
     if (checkFlag(*flagPtr))
       return true;
   }
   return false;
 }

References checkFlag().

◆ chi2()

float HGCRecHit::chi2 ( void ) const

Definition at line 15 of file HGCRecHit.cc.

                             {
   uint32_t rawChi2 = 0x7F & (flags() >> 4);
   return (float)rawChi2 / (float)((1 << 7) - 1) * 64.f;
 }

References f, CaloRecHit::flags(), and dqmMemoryStats::float.

Referenced by setChi2(), and setOutOfTimeChi2().

◆ id()

DetId HGCRecHit::id ( ) const

inline

get the id

Definition at line 73 of file HGCRecHit.h.

73 { return DetId(detid()); }

References CaloRecHit::detid().

Referenced by FWHGCRecHitProxyBuilder::build().

◆ isTimeErrorValid()

bool HGCRecHit::isTimeErrorValid ( ) const

Definition at line 87 of file HGCRecHit.cc.

                                        {
   if (!isTimeValid())
     return false;
   if (timeError() >= 10000)
     return false;
  
   return true;
 }

References isTimeValid(), and timeError().

◆ isTimeValid()

bool HGCRecHit::isTimeValid ( ) const

Definition at line 80 of file HGCRecHit.cc.

                                   {
   if (timeError() <= 0)
     return false;
   else
     return true;
 }

References timeError().

Referenced by isTimeErrorValid().

◆ outOfTimeChi2()

float HGCRecHit::outOfTimeChi2 ( ) const

Definition at line 20 of file HGCRecHit.cc.

                                      {
   uint32_t rawChi2Prob = 0x7F & (flags() >> 24);
   return (float)rawChi2Prob / (float)((1 << 7) - 1) * 64.f;
 }

References f, CaloRecHit::flags(), and dqmMemoryStats::float.

◆ outOfTimeEnergy()

float HGCRecHit::outOfTimeEnergy ( ) const

Definition at line 25 of file HGCRecHit.cc.

                                        {
   uint32_t rawEnergy = (0x1FFF & flags() >> 11);
   uint16_t exponent = rawEnergy >> 10;
   uint16_t significand = ~(0xE << 9) & rawEnergy;
   return (float)significand * pow(10, exponent - 5);
 }

References HLT_2018_cff::exponent, CaloRecHit::flags(), and funct::pow().

◆ setChi2()

void HGCRecHit::setChi2 ( float chi2 )

Definition at line 32 of file HGCRecHit.cc.

                                   {
   // bound the max value of the chi2
   if (chi2 > 64)
     chi2 = 64;
   // use 7 bits
   uint32_t rawChi2 = lround(chi2 / 64.f * ((1 << 7) - 1));
   // shift by 4 bits (recoFlag)
   setFlags((~(0x7F << 4) & flags()) | ((rawChi2 & 0x7F) << 4));
 }

References chi2(), f, CaloRecHit::flags(), and CaloRecHit::setFlags().

◆ setFlag()

void HGCRecHit::setFlag ( int flag )

inline

set the flags (from Flags or ESFlags)

Definition at line 95 of file HGCRecHit.h.

95 { flagBits_ |= (0x1 << flag); }

References RemoveAddSevLevel::flag, and flagBits_.

Referenced by HGCalRecHitSimpleAlgo::makeRecHit().

◆ setOutOfTimeChi2()

void HGCRecHit::setOutOfTimeChi2 ( float chi2 )

Definition at line 53 of file HGCRecHit.cc.

                                            {
   // bound the max value of chi2
   if (chi2 > 64)
     chi2 = 64;
   // use 7 bits
   uint32_t rawChi2 = lround(chi2 / 64.f * ((1 << 7) - 1));
   // shift by 24 bits (recoFlag + chi2 + outOfTimeEnergy)
   setFlags((~(0x7F << 24) & flags()) | ((rawChi2 & 0x7F) << 24));
 }

References chi2(), f, CaloRecHit::flags(), and CaloRecHit::setFlags().

◆ setOutOfTimeEnergy()

void HGCRecHit::setOutOfTimeEnergy ( float energy )

Definition at line 42 of file HGCRecHit.cc.

                                                {
   if (energy > 0.001f) {
     uint16_t exponent = lround(floor(log10(energy))) + 3;
     uint16_t significand = lround(energy / pow(10, exponent - 5));
     // use 13 bits (3 exponent, 10 significand)
     uint32_t rawEnergy = exponent << 10 | significand;
     // shift by 11 bits (recoFlag + chi2)
     setFlags((~(0x1FFF << 11) & flags()) | ((rawEnergy & 0x1FFF) << 11));
   }
 }

References CaloRecHit::energy(), HLT_2018_cff::exponent, f, CaloRecHit::flags(), funct::pow(), and CaloRecHit::setFlags().

◆ setSignalOverSigmaNoise()

void HGCRecHit::setSignalOverSigmaNoise ( float sOverNoise )

Definition at line 63 of file HGCRecHit.cc.

                                                         {
   // bound the max value of sOverNoise
   if (sOverNoise > 32.f)
     sOverNoise = 32.f;
   //use 8 bits
   signalOverSigmaNoise_ = lround(sOverNoise / 32.f * ((1 << 8) - 1));
 }

References f, and signalOverSigmaNoise_.

◆ setTimeError()

void HGCRecHit::setTimeError ( float timeErr )

Definition at line 73 of file HGCRecHit.cc.

                                           {
   //expected resolution on single cell for that given S/N
   timeError_ = timeErr;
 }

References timeError_.

◆ signalOverSigmaNoise()

float HGCRecHit::signalOverSigmaNoise ( ) const

Definition at line 71 of file HGCRecHit.cc.

71 { return (float)signalOverSigmaNoise_ * 0.125f; }

References signalOverSigmaNoise_.

Referenced by PFRecHitQTestHGCalThresholdSNR::test().

◆ timeError()

float HGCRecHit::timeError ( ) const

Definition at line 78 of file HGCRecHit.cc.

78 { return timeError_; }

References timeError_.

Referenced by isTimeErrorValid(), isTimeValid(), and HGCalLayerClusterProducer::produce().

◆ unsetFlag()

void HGCRecHit::unsetFlag ( int flag )

inline

Definition at line 96 of file HGCRecHit.h.

96 { flagBits_ &= ~(0x1 << flag); }

References RemoveAddSevLevel::flag, and flagBits_.

Member Data Documentation

◆ flagBits_

uint32_t HGCRecHit::flagBits_

private

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

Definition at line 106 of file HGCRecHit.h.

Referenced by checkFlag(), setFlag(), and unsetFlag().

◆ signalOverSigmaNoise_

uint8_t HGCRecHit::signalOverSigmaNoise_

private

Definition at line 107 of file HGCRecHit.h.

Referenced by setSignalOverSigmaNoise(), and signalOverSigmaNoise().

◆ timeError_

float HGCRecHit::timeError_

private

Definition at line 108 of file HGCRecHit.h.

Referenced by setTimeError(), and timeError().

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ key_type

Member Enumeration Documentation

◆ Flags

◆ HFNoseFlags

◆ HGCbheFlags

◆ HGCfheFlags

Constructor & Destructor Documentation

◆ HGCRecHit() [1/2]

◆ HGCRecHit() [2/2]

Member Function Documentation

◆ checkFlag()

◆ checkFlags()

◆ chi2()

◆ id()

◆ isTimeErrorValid()

◆ isTimeValid()

◆ outOfTimeChi2()

◆ outOfTimeEnergy()

◆ setChi2()

◆ setFlag()

◆ setOutOfTimeChi2()

◆ setOutOfTimeEnergy()

◆ setSignalOverSigmaNoise()

◆ setTimeError()

◆ signalOverSigmaNoise()

◆ timeError()

◆ unsetFlag()

Member Data Documentation

◆ flagBits_

◆ signalOverSigmaNoise_

◆ timeError_