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 DetId &	detid () const
	EcalRecHit ()
	EcalRecHit (const DetId &id, float energy, float time, uint32_t extra=0, uint32_t flagBits=0)
float	energy () const
float	energyError () const
uint32_t	flagsBits () const
DetId	id () const
	get the id More...
bool	isRecovered () const
bool	isTimeErrorValid () const
bool	isTimeValid () const
float	nonCorrectedTime () 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	setTime (float time)
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 16 of file EcalRecHit.h.

Member Typedef Documentation

key_type

typedef DetId EcalRecHit::key_type

Definition at line 18 of file EcalRecHit.h.

Member Enumeration Documentation

ESFlags

enum EcalRecHit::ESFlags

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

Definition at line 45 of file EcalRecHit.h.

               {
    kESGood,
    kESDead,
    kESHot,
    kESPassBX,
    kESTwoGoodRatios,
    kESBadRatioFor12,
    kESBadRatioFor23Upper,
    kESBadRatioFor23Lower,
    kESTS1Largest,
    kESTS3Largest,
    kESTS3Negative,
    kESSaturated,
    kESTS2Saturated,
    kESTS3Saturated,
    kESTS13Sigmas,
    kESTS15Sigmas
  };

Flags

enum EcalRecHit::Flags

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

Definition at line 21 of file EcalRecHit.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)
    kLeadingEdgeRecovered,  // saturated channel: energy estimated from the leading edge before saturation
    kNeighboursRecovered,   // saturated/isolated dead: energy estimated from neighbours
    kTowerRecovered,        // channel in TT with no data link, info retrieved from Trigger Primitive
    kDead,                  // channel is dead and any recovery fails
    kKilled,                // MC only flag: the channel is killed in the real detector
    kTPSaturated,           // the channel is in a region with saturated TP
    kL1SpikeFlag,           // the channel is in a region with TP with sFGVB = 0
    kWeird,                 // the signal is believed to originate from an anomalous deposit (spike)
    kDiWeird,               // the signal is anomalous, and neighbors another anomalous signal
    kHasSwitchToGain6,      // at least one data frame is in G6
    kHasSwitchToGain1,      // at least one data frame is in G1
                            //
    kUnknown                // to ease the interface with functions returning flags.
  };

Constructor & Destructor Documentation

EcalRecHit() [1/2]

EcalRecHit::EcalRecHit ( )

inline

Definition at line 64 of file EcalRecHit.h.

: energy_(0), time_(0), flagBits_(0) {}

EcalRecHit() [2/2]

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

inlineexplicit

Definition at line 66 of file EcalRecHit.h.

      : id_(id), energy_(energy), time_(time), flagBits_(flagBits), extra_(extra) {}

Member Function Documentation

checkFlag()

bool EcalRecHit::checkFlag ( int  flag ) const

inline

check if the flag is true

Definition at line 188 of file EcalRecHit.h.

References RemoveAddSevLevel::flag, and flagBits_.

Referenced by checkFlags(), isRecovered(), EgammaIsoDetIdCollectionProducer< T1 >::produce(), recoFlag(), EEBadScFilter::scan5x5(), EcalSeverityLevelAlgo::severityLevel(), PFRecHitQTestECAL::test(), and PFRecHitQTestES::test().

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

checkFlagMask()

bool EcalRecHit::checkFlagMask ( uint32_t  mask ) const

inline

apply a bitmask to our flags. Experts only

Definition at line 205 of file EcalRecHit.h.

References flagBits_, and gpuClustering::pixelStatus::mask.

Referenced by EcalSeverityLevelAlgo::severityLevel().

{ return flagBits_ & mask; }

checkFlags()

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.

References checkFlag().

Referenced by EgammaIsoDetIdCollectionProducer< T1 >::produce().

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

chi2()

float EcalRecHit::chi2 ( void  ) const

inline

Definition at line 121 of file EcalRecHit.h.

References extra_, nano_mu_digi_cff::float, and getMasked().

Referenced by setChi2().

                     {
    uint32_t rawChi2 = getMasked(extra_, 0, 7);
    return (float)rawChi2 / (float)((1 << 7) - 1) * 64.;
  }

detid()

const DetId& EcalRecHit::detid ( ) const

inline

Definition at line 73 of file EcalRecHit.h.

References id_.

Referenced by FWPFEcalRecHitRPProxyBuilder::build(), FWPFEcalRecHitLegoProxyBuilder::build(), EcalClusterToolsT< noZS >::cluster2ndMoments(), muonisolation::CaloExtractorByAssociator::deposits(), EcalClusterToolsT< noZS >::getSeedPosition(), id(), EgammaIsoDetIdCollectionProducer< T1 >::produce(), CaloRecHitsBeamHaloCleaned::produce(), and EcalClusterToolsT< noZS >::roundnessSelectedBarrelRecHits().

{ return id_; }

energy()

float EcalRecHit::energy ( ) const

inline

Definition at line 69 of file EcalRecHit.h.

References energy_.

Referenced by AlCaElectronsTest::analyze(), EcalCosmicsHists::analyze(), EcalBoundaryInfoCalculator< EBDetId >::boundaryRecHits(), FWPFEcalRecHitRPProxyBuilder::build(), FWPFEcalRecHitLegoProxyBuilder::build(), ClusterShapeAlgo::Calculate_2ndEnergy(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), ClusterShapeAlgo::Calculate_TopEnergy(), EcalClusterToolsT< noZS >::cluster2ndMoments(), ClusterShapeAlgo::Create_Map(), muonisolation::CaloExtractorByAssociator::deposits(), CSCHaloAlgo::ECALSegmentMatching(), EcalBoundaryInfoCalculator< EBDetId >::gapRecHits(), calib::CalibElectron::getCalibModulesWeights(), EcalClusterToolsT< noZS >::getEnergyDepTopology(), EcalHaloAlgo::GetHaloClusterCandidateEB(), EcalHaloAlgo::GetHaloClusterCandidateEE(), HcalHaloAlgo::GetHaloClusterCandidateHB(), HcalHaloAlgo::GetHaloClusterCandidateHE(), ZeeCalibration::getHottestDetId(), EcalClusterToolsT< noZS >::getSeedPosition(), IslandClusterAlgo::makeCluster(), CosmicClusterAlgo::makeCluster(), Multi5x5ClusterAlgo::makeCluster(), HybridClusterAlgo::makeDomino(), EgammaIsoDetIdCollectionProducer< T1 >::produce(), Jet.Jet::rawEnergy(), Multi5x5ClusterAlgo::ProtoBasicCluster::removeHit(), EcalClusterToolsT< noZS >::roundnessSelectedBarrelRecHits(), EEBadScFilter::scan5x5(), setEnergy(), setEnergyError(), EcalSeverityLevelAlgo::severityLevel(), PFRecHitQTestECAL::test(), and PFRecHitQTestES::test().

{ return energy_; }

energyError()

float EcalRecHit::energyError ( ) const

inline

Definition at line 136 of file EcalRecHit.h.

References HLT_2023v12_cff::exponent, extra_, getMasked(), and conifer::pow().

                            {
    uint32_t rawEnergy = getMasked(extra_, 8, 13);
    uint16_t exponent = rawEnergy >> 10;
    uint16_t significand = ~(0xE << 9) & rawEnergy;
    return (float)significand * pow(10, exponent - 5);
  }

flagsBits()

uint32_t EcalRecHit::flagsBits ( ) const

inline

Definition at line 202 of file EcalRecHit.h.

References flagBits_.

{ return flagBits_; }

getMasked()

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

inlinestatic

Definition at line 96 of file EcalRecHit.h.

References hltrates_dqm_sourceclient-live_cfg::offset, and ApeEstimator_cff::width.

Referenced by chi2(), energyError(), nonCorrectedTime(), and timeError().

                                                                                    {
    return (value >> offset) & ((1 << width) - 1);
  }

getPower10()

static int EcalRecHit::getPower10 ( float  e )

inlinestatic

Definition at line 107 of file EcalRecHit.h.

References b, MillePedeFileConverter_cfg::e, and f.

Referenced by setEnergyError().

                                        {
    static constexpr float p10[] = {1.e-2f, 1.e-1f, 1.f, 1.e1f, 1.e2f, 1.e3f, 1.e4f, 1.e5f, 1.e6f};
    int b = e < p10[4] ? 0 : 5;
    for (; b < 9; ++b)
      if (e < p10[b])
        break;
    return b;
  }

id()

DetId EcalRecHit::id ( ) const

inline

get the id

Definition at line 78 of file EcalRecHit.h.

References detid().

Referenced by AlCaElectronsTest::analyze(), ClusterShapeAlgo::Calculate_2ndEnergy(), ClusterShapeAlgo::Calculate_TopEnergy(), EgammaHLTNxNClusterProducer::checkStatusOfEcalRecHit(), HLTEcalResonanceFilter::checkStatusOfEcalRecHit(), HLTRegionalEcalResonanceFilter::checkStatusOfEcalRecHit(), ClusterShapeAlgo::Create_Map(), CSCHaloAlgo::ECALSegmentMatching(), EcalHaloAlgo::GetHaloClusterCandidateEB(), EcalHaloAlgo::GetHaloClusterCandidateEE(), HcalHaloAlgo::GetHaloClusterCandidateHB(), HcalHaloAlgo::GetHaloClusterCandidateHE(), ZeeCalibration::getHottestDetId(), Multi5x5ClusterAlgo::mainSearch(), CosmicClusterAlgo::makeCluster(), and Multi5x5ClusterAlgo::ProtoBasicCluster::removeHit().

{ return DetId(detid()); }

isRecovered()

bool EcalRecHit::isRecovered ( ) const

inline

Definition at line 80 of file EcalRecHit.h.

References checkFlag(), kLeadingEdgeRecovered, kNeighboursRecovered, and kTowerRecovered.

                           {
    return checkFlag(kLeadingEdgeRecovered) || checkFlag(kNeighboursRecovered) || checkFlag(kTowerRecovered);
  }

isTimeErrorValid()

bool EcalRecHit::isTimeErrorValid ( ) const

inline

Definition at line 86 of file EcalRecHit.h.

References isTimeValid(), and timeError().

                                {
    if (!isTimeValid())
      return false;

    if (timeError() >= 10000)
      return false;

    return true;
  }

isTimeValid()

bool EcalRecHit::isTimeValid ( ) const

inline

Definition at line 84 of file EcalRecHit.h.

References timeError().

Referenced by isTimeErrorValid().

{ return (this->timeError() > 0); }

nonCorrectedTime()

float EcalRecHit::nonCorrectedTime ( ) const

inline

Definition at line 221 of file EcalRecHit.h.

References ecalcctiming::clockToNS, ecalcctiming::encodingOffest, ecalcctiming::encodingValue, extra_, getMasked(), ecalcctiming::nonCorrectedSlope, and time_.

                                 {
    uint8_t jitterErrorBits = getMasked(extra_, 24, 8);
    float encBits = static_cast<float>(jitterErrorBits);
    float decTimeDif = ecalcctiming::clockToNS * (ecalcctiming::encodingOffest - encBits / ecalcctiming::encodingValue);
    float nonCorrectedTime =
        (encBits > 1 && encBits < 254) ? ecalcctiming::nonCorrectedSlope * time_ + decTimeDif : -30.0;
    return nonCorrectedTime;
  }

recoFlag()

Flags EcalRecHit::recoFlag ( ) const

inline

DEPRECATED provided for temporary backward compatibility.

Definition at line 208 of file EcalRecHit.h.

References checkFlag(), mps_fire::i, kGood, and kUnknown.

Referenced by EgammaHLTNxNClusterProducer::checkStatusOfEcalRecHit(), HLTEcalResonanceFilter::checkStatusOfEcalRecHit(), and HLTRegionalEcalResonanceFilter::checkStatusOfEcalRecHit().

                         {
    for (int i = kUnknown;; --i) {
      if (checkFlag(i))
        return Flags(i);
      if (i == 0)
        break;
    }

    // no flag assigned, assume good
    return kGood;
  }

setChi2()

void EcalRecHit::setChi2 ( float  chi2 )

inline

Definition at line 126 of file EcalRecHit.h.

References chi2(), extra_, and setMasked().

Referenced by EcalRecHitSimpleAlgo::makeRecHit().

                           {
    // bound the max value of the chi2
    if (chi2 > 64)
      chi2 = 64;

    // use 7 bits
    uint32_t rawChi2 = lround(chi2 / 64. * ((1 << 7) - 1));
    extra_ = setMasked(extra_, rawChi2, 0, 7);
  }

setEnergy()

void EcalRecHit::setEnergy ( float  energy )

inline

Definition at line 70 of file EcalRecHit.h.

References energy(), and energy_.

{ energy_ = energy; }

setEnergyError()

void EcalRecHit::setEnergyError ( float  energy )

inline

Definition at line 145 of file EcalRecHit.h.

References energy(), HLT_2023v12_cff::exponent, extra_, f, getPower10(), and setMasked().

Referenced by ESRecHitSimAlgo::oldreconstruct(), and ESRecHitSimAlgo::reconstruct().

                                    {
    uint32_t rawEnergy = 0;
    if (energy > 0.001) {
      uint16_t exponent = getPower10(energy);
      static constexpr float ip10[] = {1.e5f, 1.e4f, 1.e3f, 1.e2f, 1.e1f, 1.e0f, 1.e-1f, 1.e-2f, 1.e-3f, 1.e-4};
      uint16_t significand = lround(energy * ip10[exponent]);
      // use 13 bits (3 exponent, 10 significand)
      rawEnergy = exponent << 10 | significand;
      /* here for doc and regression test
      uint16_t exponent_old = lround(floor(log10(energy))) + 3;  
      uint16_t significand_old = lround(energy/pow(10, exponent - 5));
      std::cout << energy << ' ' << exponent << ' ' << significand 
                          << ' ' << exponent_old << ' ' << significand_old << std::endl;
      assert(exponent==exponent_old);
      assert(significand==significand_old);
      */
    }

    extra_ = setMasked(extra_, rawEnergy, 8, 13);
  }

setFlag()

void EcalRecHit::setFlag ( int  flag )

inline

set the flags (from Flags or ESFlags)

Definition at line 184 of file EcalRecHit.h.

References RemoveAddSevLevel::flag, and flagBits_.

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

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

setMasked()

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.

References gpuClustering::pixelStatus::mask, hltrates_dqm_sourceclient-live_cfg::offset, mitigatedMETSequence_cff::U, relativeConstraints::value, ApeEstimator_cff::width, and x.

Referenced by setChi2(), setEnergyError(), and setTimeError().

                                                                                                {
    const uint32_t mask = ((1 << width) - 1) << offset;
    value &= ~mask;
    value |= (x & ((1U << width) - 1)) << offset;
    return value;
  }

setTime()

void EcalRecHit::setTime ( float  time )

inline

Definition at line 72 of file EcalRecHit.h.

References time(), and time_.

Referenced by EcalDetailedTimeRecHitProducer::produce().

{ time_ = time; }

setTimeError()

void EcalRecHit::setTimeError ( uint8_t  timeErrBits )

inline

Definition at line 181 of file EcalRecHit.h.

References extra_, and setMasked().

{ extra_ = setMasked(extra_, timeErrBits & 0xFF, 24, 8); }

time()

float EcalRecHit::time ( ) const

inline

Definition at line 71 of file EcalRecHit.h.

References time_.

Referenced by EcalCosmicsHists::analyze(), CSCHaloAlgo::ECALSegmentMatching(), EcalHaloAlgo::GetHaloClusterCandidateEB(), EcalHaloAlgo::GetHaloClusterCandidateEE(), and setTime().

{ return time_; }

timeError()

float EcalRecHit::timeError ( ) const

inline

Definition at line 166 of file EcalRecHit.h.

References HLT_2023v12_cff::exponent, extra_, getMasked(), and conifer::pow().

Referenced by isTimeErrorValid(), and isTimeValid().

                          {
    uint32_t timeErrorBits = getMasked(extra_, 24, 8);
    // all bits off --> time reco bailed out (return negative value)
    if ((0xFF & timeErrorBits) == 0x00)
      return -1;
    // all bits on --> time error over 5 ns (return large value)
    if ((0xFF & timeErrorBits) == 0xFF)
      return 10000;

    float LSB = 1.26008;
    uint8_t exponent = timeErrorBits >> 5;
    uint8_t significand = timeErrorBits & ~(0x7 << 5);
    return pow(2., exponent) * significand * LSB / 1000.;
  }

unsetFlag()

void EcalRecHit::unsetFlag ( int  flag )

inline

Definition at line 185 of file EcalRecHit.h.

References RemoveAddSevLevel::flag, and flagBits_.

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

Member Data Documentation

energy_

float EcalRecHit::energy_

private

Definition at line 233 of file EcalRecHit.h.

Referenced by energy(), and setEnergy().

extra_

uint32_t EcalRecHit::extra_

private

Definition at line 240 of file EcalRecHit.h.

Referenced by chi2(), energyError(), nonCorrectedTime(), setChi2(), setEnergyError(), setTimeError(), and timeError().

flagBits_

uint32_t EcalRecHit::flagBits_

private

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

Definition at line 237 of file EcalRecHit.h.

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

id_

DetId EcalRecHit::id_

private

Definition at line 232 of file EcalRecHit.h.

Referenced by detid().

time_

float EcalRecHit::time_

private

Definition at line 234 of file EcalRecHit.h.

Referenced by nonCorrectedTime(), setTime(), and time().