#include <HFSimpleTimeCheck.h>

Inheritance diagram for HFSimpleTimeCheck:

Public Member Functions
bool	alwaysCalculatingQAsym () const

	HFSimpleTimeCheck (const std::pair< float, float > tlimits[2], const float energyWeights[2 *HFAnodeStatus::N_POSSIBLE_STATES - 1][2], unsigned soiPhase, float timeShift, float triseIfNoTDC, float tfallIfNoTDC, float minChargeForUndershoot, float minChargeForOvershoot, bool rejectAllFailures=true, bool alwaysCalculateChargeAsymmetry=true)

bool	isConfigurable () const override

float	minChargeForOvershoot () const

float	minChargeForUndershoot () const

HFRecHit	reconstruct (const HFPreRecHit &prehit, const HcalCalibrations &calibs, const bool flaggedBadInDB[2], bool expectSingleAnodePMT) override

bool	rejectingAllFailures () const

unsigned	soiPhase () const

float	tfallIfNoTDC () const

float	timeShift () const

float	triseIfNoTDC () const

	~HFSimpleTimeCheck () override

Public Member Functions inherited from AbsHFPhase1Algo
virtual bool	configure (const AbsHcalAlgoData *)

virtual	~AbsHFPhase1Algo ()

Protected Member Functions
virtual unsigned	determineAnodeStatus (unsigned anodeNumber, const HFQIE10Info &anode, bool *isTimingReliable) const

Private Member Functions
unsigned	mapStatusIntoIndex (const unsigned states[2]) const

Private Attributes
bool	alwaysQAsym_

float	energyWeights_ [2 *HFAnodeStatus::N_POSSIBLE_STATES - 1][2]

float	minChargeForOvershoot_

float	minChargeForUndershoot_

bool	rejectAllFailures_

unsigned	soiPhase_

float	tfallIfNoTDC_

float	timeShift_

std::pair< float, float >	tlimits_ [2]

float	triseIfNoTDC_

Detailed Description

Definition at line 9 of file HFSimpleTimeCheck.h.

Constructor & Destructor Documentation

◆ HFSimpleTimeCheck()

HFSimpleTimeCheck::HFSimpleTimeCheck	(	const std::pair< float, float >	tlimits[2],
		const float	energyWeights[2 *HFAnodeStatus::N_POSSIBLE_STATES - 1][2],
		unsigned	soiPhase,
		float	timeShift,
		float	triseIfNoTDC,
		float	tfallIfNoTDC,
		float	minChargeForUndershoot,
		float	minChargeForOvershoot,
		bool	rejectAllFailures = `true`,
		bool	alwaysCalculateChargeAsymmetry = `true`
	)

Definition at line 32 of file HFSimpleTimeCheck.cc.

     : soiPhase_(i_soiPhase),
       timeShift_(i_timeShift),
       triseIfNoTDC_(i_triseIfNoTDC),
       tfallIfNoTDC_(i_tfallIfNoTDC),
       minChargeForUndershoot_(i_minChargeForUndershoot),
       minChargeForOvershoot_(i_minChargeForOvershoot),
       rejectAllFailures_(rejectAllFailures),
       alwaysQAsym_(alwaysCalculateQAsymmetry) {
   tlimits_[0] = tlimits[0];
   tlimits_[1] = tlimits[1];
   float* to = &energyWeights_[0][0];
   const float* from = &energyWeights[0][0];
   memcpy(to, from, sizeof(energyWeights_));
 }

References HLT_2018_cff::energyWeights, energyWeights_, HLT_2018_cff::tlimits, and tlimits_.

◆ ~HFSimpleTimeCheck()

HFSimpleTimeCheck::~HFSimpleTimeCheck ( )

inlineoverride

Definition at line 71 of file HFSimpleTimeCheck.h.

71 {}

Member Function Documentation

◆ alwaysCalculatingQAsym()

bool HFSimpleTimeCheck::alwaysCalculatingQAsym ( ) const

inline

Definition at line 87 of file HFSimpleTimeCheck.h.

87 { return alwaysQAsym_; }

References alwaysQAsym_.

Referenced by HFFlexibleTimeCheck::reconstruct().

◆ determineAnodeStatus()

unsigned HFSimpleTimeCheck::determineAnodeStatus	(	unsigned	anodeNumber,
		const HFQIE10Info &	anode,
		bool *	isTimingReliable
	)		const

protectedvirtual

Reimplemented in HFFlexibleTimeCheck.

Definition at line 57 of file HFSimpleTimeCheck.cc.

                                                                                                              {
   // Check if this anode has a dataframe error
   if (!anode.isDataframeOK())
     return HFAnodeStatus::HARDWARE_ERROR;
  
   // Check the time limits
   float trise = anode.timeRising();
   const bool timeIsKnown = !HcalSpecialTimes::isSpecial(trise);
   trise += timeShift_;
   if (timeIsKnown && tlimits_[ianode].first <= trise && trise <= tlimits_[ianode].second)
     return HFAnodeStatus::OK;
   else
     return HFAnodeStatus::FAILED_TIMING;
 }

References HFAnodeStatus::FAILED_TIMING, dqmdumpme::first, HFAnodeStatus::HARDWARE_ERROR, HFQIE10Info::isDataframeOK(), HcalSpecialTimes::isSpecial(), HFAnodeStatus::OK, edm::second(), HFQIE10Info::timeRising(), timeShift_, and tlimits_.

Referenced by reconstruct().

◆ isConfigurable()

bool HFSimpleTimeCheck::isConfigurable ( ) const

inlineoverridevirtual

Implements AbsHFPhase1Algo.

Definition at line 73 of file HFSimpleTimeCheck.h.

73 { return false; }

◆ mapStatusIntoIndex()

unsigned HFSimpleTimeCheck::mapStatusIntoIndex ( const unsigned states[2] ) const

private

Definition at line 72 of file HFSimpleTimeCheck.cc.

                                                                              {
   unsigned eStates[2];
   eStates[0] = states[0];
   eStates[1] = states[1];
   if (!rejectAllFailures_)
     for (unsigned i = 0; i < 2; ++i)
       if (eStates[i] == HFAnodeStatus::FAILED_TIMING || eStates[i] == HFAnodeStatus::FAILED_OTHER)
         eStates[i] = HFAnodeStatus::OK;
   if (eStates[0] == HFAnodeStatus::OK)
     return eStates[1];
   else if (eStates[1] == HFAnodeStatus::OK)
     return HFAnodeStatus::N_POSSIBLE_STATES + eStates[0] - 1;
   else
     return UINT_MAX;
 }

References HFAnodeStatus::FAILED_OTHER, HFAnodeStatus::FAILED_TIMING, mps_fire::i, HFAnodeStatus::N_POSSIBLE_STATES, HFAnodeStatus::OK, and rejectAllFailures_.

Referenced by reconstruct().

◆ minChargeForOvershoot()

float HFSimpleTimeCheck::minChargeForOvershoot ( ) const

inline

Definition at line 85 of file HFSimpleTimeCheck.h.

85 { return minChargeForOvershoot_; }

References minChargeForOvershoot_.

Referenced by HFFlexibleTimeCheck::determineAnodeStatus().

◆ minChargeForUndershoot()

float HFSimpleTimeCheck::minChargeForUndershoot ( ) const

inline

Definition at line 84 of file HFSimpleTimeCheck.h.

84 { return minChargeForUndershoot_; }

References minChargeForUndershoot_.

Referenced by HFFlexibleTimeCheck::determineAnodeStatus().

◆ reconstruct()

HFRecHit HFSimpleTimeCheck::reconstruct	(	const HFPreRecHit &	prehit,
		const HcalCalibrations &	calibs,
		const bool	flaggedBadInDB[2],
		bool	expectSingleAnodePMT
	)

overridevirtual

Implements AbsHFPhase1Algo.

Definition at line 88 of file HFSimpleTimeCheck.cc.

                                                                          {
   HFRecHit rh;
  
   // Determine the status of each anode
   unsigned states[2] = {HFAnodeStatus::NOT_READ_OUT, HFAnodeStatus::NOT_READ_OUT};
   if (expectSingleAnodePMT)
     states[1] = HFAnodeStatus::NOT_DUAL;
  
   bool isTimingReliable[2] = {true, true};
   for (unsigned ianode = 0; ianode < 2; ++ianode) {
     if (flaggedBadInDB[ianode])
       states[ianode] = HFAnodeStatus::FLAGGED_BAD;
     else {
       const HFQIE10Info* anodeInfo = prehit.getHFQIE10Info(ianode);
       if (anodeInfo)
         states[ianode] = determineAnodeStatus(ianode, *anodeInfo, &isTimingReliable[ianode]);
     }
   }
  
   // Reconstruct energy and time
   const unsigned lookupInd = mapStatusIntoIndex(states);
   if (lookupInd != UINT_MAX) {
     // In this scope, at least one of states[i] is HFAnodeStatus::OK
     // or was mapped into that status by "mapStatusIntoIndex" method
     //
     const float* weights = &energyWeights_[lookupInd][0];
     float energy = 0.f, tfallWeightedEnergySum = 0.f, triseWeightedEnergySum = 0.f;
     float tfallWeightedSum = 0.f, triseWeightedSum = 0.f;
     float tfallSum = 0.f, triseSum = 0.f;
     unsigned tfallCount = 0, triseCount = 0;
  
     for (unsigned ianode = 0; ianode < 2; ++ianode) {
       const HFQIE10Info* anodeInfo = prehit.getHFQIE10Info(ianode);
       if (anodeInfo && weights[ianode] > 0.f) {
         const float weightedEnergy = weights[ianode] * anodeInfo->energy();
         energy += weightedEnergy;
  
         if (isTimingReliable[ianode] && states[ianode] != HFAnodeStatus::FAILED_TIMING) {
           float trise = anodeInfo->timeRising();
           if (!HcalSpecialTimes::isSpecial(trise)) {
             trise += timeShift_;
             triseSum += trise;
             ++triseCount;
             if (weightedEnergy > 0.f) {
               triseWeightedSum += trise * weightedEnergy;
               triseWeightedEnergySum += weightedEnergy;
             }
           }
  
           float tfall = anodeInfo->timeFalling();
           if (!HcalSpecialTimes::isSpecial(tfall)) {
             tfall += timeShift_;
             tfallSum += tfall;
             ++tfallCount;
             if (weightedEnergy > 0.f) {
               tfallWeightedSum += tfall * weightedEnergy;
               tfallWeightedEnergySum += weightedEnergy;
             }
           }
         }
       }
     }
  
     bool triseFromTDC = false;
     const float trise =
         build_rechit_time(triseWeightedEnergySum, triseWeightedSum, triseSum, triseCount, triseIfNoTDC_, &triseFromTDC);
  
     bool tfallFromTDC = false;
     const float tfall =
         build_rechit_time(tfallWeightedEnergySum, tfallWeightedSum, tfallSum, tfallCount, tfallIfNoTDC_, &tfallFromTDC);
  
     rh = HFRecHit(prehit.id(), energy, trise, tfall);
     HFRecHitAuxSetter::setAux(prehit, states, soiPhase_, &rh);
  
     // Set the "timing from TDC" flag
     const uint32_t flag = triseFromTDC ? 1U : 0U;
     rh.setFlagField(flag, HcalPhase1FlagLabels::TimingFromTDC);
   }
  
   return rh;
 }

References determineAnodeStatus(), HCALHighEnergyHPDFilter_cfi::energy, HFQIE10Info::energy(), energyWeights_, f, HFAnodeStatus::FAILED_TIMING, RemoveAddSevLevel::flag, HFAnodeStatus::FLAGGED_BAD, HFPreRecHit::getHFQIE10Info(), HFPreRecHit::id(), HcalSpecialTimes::isSpecial(), mapStatusIntoIndex(), HFAnodeStatus::NOT_DUAL, HFAnodeStatus::NOT_READ_OUT, HFRecHitAuxSetter::setAux(), CaloRecHit::setFlagField(), soiPhase_, tfallIfNoTDC_, HFQIE10Info::timeFalling(), HFQIE10Info::timeRising(), timeShift_, HcalPhase1FlagLabels::TimingFromTDC, triseIfNoTDC_, mitigatedMETSequence_cff::U, and HLT_2018_cff::weights.

Referenced by HFFlexibleTimeCheck::reconstruct().

◆ rejectingAllFailures()

bool HFSimpleTimeCheck::rejectingAllFailures ( ) const

inline

Definition at line 86 of file HFSimpleTimeCheck.h.

86 { return rejectAllFailures_; }

References rejectAllFailures_.

◆ soiPhase()

unsigned HFSimpleTimeCheck::soiPhase ( ) const

inline

Definition at line 80 of file HFSimpleTimeCheck.h.

80 { return soiPhase_; }

References soiPhase_.

◆ tfallIfNoTDC()

float HFSimpleTimeCheck::tfallIfNoTDC ( ) const

inline

Definition at line 83 of file HFSimpleTimeCheck.h.

83 { return tfallIfNoTDC_; }

References tfallIfNoTDC_.

◆ timeShift()

float HFSimpleTimeCheck::timeShift ( ) const

inline

Definition at line 81 of file HFSimpleTimeCheck.h.

81 { return timeShift_; }

References timeShift_.

Referenced by HFFlexibleTimeCheck::determineAnodeStatus().

◆ triseIfNoTDC()

float HFSimpleTimeCheck::triseIfNoTDC ( ) const

inline

Definition at line 82 of file HFSimpleTimeCheck.h.

82 { return triseIfNoTDC_; }

References triseIfNoTDC_.

Member Data Documentation

◆ alwaysQAsym_

bool HFSimpleTimeCheck::alwaysQAsym_

private

Definition at line 105 of file HFSimpleTimeCheck.h.

Referenced by alwaysCalculatingQAsym().

◆ energyWeights_

float HFSimpleTimeCheck::energyWeights_[2 *HFAnodeStatus::N_POSSIBLE_STATES - 1][2]

private

Definition at line 97 of file HFSimpleTimeCheck.h.

Referenced by HFSimpleTimeCheck(), and reconstruct().

◆ minChargeForOvershoot_

float HFSimpleTimeCheck::minChargeForOvershoot_

private

Definition at line 103 of file HFSimpleTimeCheck.h.

Referenced by minChargeForOvershoot().

◆ minChargeForUndershoot_

float HFSimpleTimeCheck::minChargeForUndershoot_

private

Definition at line 102 of file HFSimpleTimeCheck.h.

Referenced by minChargeForUndershoot().

◆ rejectAllFailures_

bool HFSimpleTimeCheck::rejectAllFailures_

private

Definition at line 104 of file HFSimpleTimeCheck.h.

Referenced by mapStatusIntoIndex(), and rejectingAllFailures().

◆ soiPhase_

unsigned HFSimpleTimeCheck::soiPhase_

private

Definition at line 98 of file HFSimpleTimeCheck.h.

Referenced by reconstruct(), and soiPhase().

◆ tfallIfNoTDC_

float HFSimpleTimeCheck::tfallIfNoTDC_

private

Definition at line 101 of file HFSimpleTimeCheck.h.

Referenced by reconstruct(), and tfallIfNoTDC().

◆ timeShift_

float HFSimpleTimeCheck::timeShift_

private

Definition at line 99 of file HFSimpleTimeCheck.h.

Referenced by determineAnodeStatus(), reconstruct(), and timeShift().

◆ tlimits_

std::pair<float, float> HFSimpleTimeCheck::tlimits_[2]

private

Definition at line 96 of file HFSimpleTimeCheck.h.

Referenced by determineAnodeStatus(), and HFSimpleTimeCheck().

◆ triseIfNoTDC_

float HFSimpleTimeCheck::triseIfNoTDC_

private

Definition at line 100 of file HFSimpleTimeCheck.h.

Referenced by reconstruct(), and triseIfNoTDC().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HFSimpleTimeCheck()

◆ ~HFSimpleTimeCheck()

Member Function Documentation

◆ alwaysCalculatingQAsym()

◆ determineAnodeStatus()

◆ isConfigurable()

◆ mapStatusIntoIndex()

◆ minChargeForOvershoot()

◆ minChargeForUndershoot()

◆ reconstruct()

◆ rejectingAllFailures()

◆ soiPhase()

◆ tfallIfNoTDC()

◆ timeShift()

◆ triseIfNoTDC()

Member Data Documentation

◆ alwaysQAsym_

◆ energyWeights_

◆ minChargeForOvershoot_

◆ minChargeForUndershoot_

◆ rejectAllFailures_

◆ soiPhase_

◆ tfallIfNoTDC_

◆ timeShift_

◆ tlimits_

◆ triseIfNoTDC_