#include <HFFlexibleTimeCheck.h>

Inheritance diagram for HFFlexibleTimeCheck:

Public Member Functions
bool	configure (const AbsHcalAlgoData *config) override

	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

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

	~HFFlexibleTimeCheck () override

Public Member Functions inherited from HFSimpleTimeCheck
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	~AbsHFPhase1Algo ()

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

Private Attributes
const HFPhase1PMTParams *	algoConf_ = nullptr

const HFPhase1PMTData *	pmtInfo_ = nullptr

Detailed Description

Definition at line 7 of file HFFlexibleTimeCheck.h.

Constructor & Destructor Documentation

◆ ~HFFlexibleTimeCheck()

HFFlexibleTimeCheck::~HFFlexibleTimeCheck ( )

inlineoverride

Definition at line 11 of file HFFlexibleTimeCheck.h.

11 {}

Member Function Documentation

◆ configure()

bool HFFlexibleTimeCheck::configure ( const AbsHcalAlgoData * config )

inlineoverridevirtual

Reimplemented from AbsHFPhase1Algo.

Definition at line 15 of file HFFlexibleTimeCheck.h.

References algoConf_, and DiMuonV_cfg::config.

                                                                 {
     algoConf_ = dynamic_cast<const HFPhase1PMTParams*>(config);
     return algoConf_;
   }

◆ determineAnodeStatus()

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

overrideprotectedvirtual

Reimplemented from HFSimpleTimeCheck.

Definition at line 12 of file HFFlexibleTimeCheck.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, HFQIE10Info::charge(), HFPhase1PMTData::cut(), HFAnodeStatus::FAILED_TIMING, HFAnodeStatus::HARDWARE_ERROR, HFQIE10Info::isDataframeOK(), HcalSpecialTimes::isSpecial(), HFPhase1PMTData::minCharge0(), HFPhase1PMTData::minCharge1(), HFSimpleTimeCheck::minChargeForOvershoot(), HFSimpleTimeCheck::minChargeForUndershoot(), HFAnodeStatus::OK, pmtInfo_, HFPhase1PMTData::T_0_MAX, HFPhase1PMTData::T_0_MIN, HFPhase1PMTData::T_1_MAX, HFPhase1PMTData::T_1_MIN, HFQIE10Info::timeRising(), HFSimpleTimeCheck::timeShift(), HcalSpecialTimes::UNKNOWN_T_DLL_FAILURE, HcalSpecialTimes::UNKNOWN_T_OVERSHOOT, and HcalSpecialTimes::UNKNOWN_T_UNDERSHOOT.

                                                                                  {
   // Return quickly if this anode has a dataframe error
   if (!anode.isDataframeOK())
     return HFAnodeStatus::HARDWARE_ERROR;
 
   // Require minimum charge for reliable timing measurement
   const float charge = anode.charge();
   const float minCharge = ianode ? pmtInfo_->minCharge1() : pmtInfo_->minCharge0();
   if (charge < minCharge) {
     *isTimingReliable = false;
     return HFAnodeStatus::OK;
   }
 
   // Special handling of under/overshoot TDC values, as well
   // as of DLL failures
   float trise = anode.timeRising();
   if ((trise == HcalSpecialTimes::UNKNOWN_T_UNDERSHOOT && charge < minChargeForUndershoot()) ||
       (trise == HcalSpecialTimes::UNKNOWN_T_OVERSHOOT && charge < minChargeForOvershoot()) ||
       trise == HcalSpecialTimes::UNKNOWN_T_DLL_FAILURE) {
     *isTimingReliable = false;
     return HFAnodeStatus::OK;
   }
 
   // Check if the rise time information is meaningful
   if (HcalSpecialTimes::isSpecial(trise))
     return HFAnodeStatus::FAILED_TIMING;
 
   // Figure out the timing cuts for this PMT
   const AbsHcalFunctor& minTimeShape = pmtInfo_->cut(ianode ? HFPhase1PMTData::T_1_MIN : HFPhase1PMTData::T_0_MIN);
   const AbsHcalFunctor& maxTimeShape = pmtInfo_->cut(ianode ? HFPhase1PMTData::T_1_MAX : HFPhase1PMTData::T_0_MAX);
 
   // Apply the timing cuts
   trise += timeShift();
   if (minTimeShape(charge) <= trise && trise <= maxTimeShape(charge))
     return HFAnodeStatus::OK;
   else
     return HFAnodeStatus::FAILED_TIMING;
 }

◆ HFSimpleTimeCheck()

HFSimpleTimeCheck::HFSimpleTimeCheck

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

◆ isConfigurable()

bool HFFlexibleTimeCheck::isConfigurable ( ) const

inlineoverridevirtual

Implements AbsHFPhase1Algo.

Definition at line 14 of file HFFlexibleTimeCheck.h.

14 { return true; }

◆ reconstruct()

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

overridevirtual

Implements AbsHFPhase1Algo.

Definition at line 53 of file HFFlexibleTimeCheck.cc.

References algoConf_, HFSimpleTimeCheck::alwaysCalculatingQAsym(), HFPhase1PMTData::ASYMM_MAX, HFPhase1PMTData::ASYMM_MIN, HcalItemCollById< Item >::at(), CaloRecHit::aux(), HFPreRecHit::charge(), HFPreRecHit::chargeAsymmetry(), HFPhase1PMTData::cut(), Exception, HFRecHit::getAuxHF(), CaloRecHitAuxSetter::getField(), HcalPhase1FlagLabels::HFSignalAsymmetry, HFRecHit::id(), HFPreRecHit::id(), HFRecHitAuxSetter::MASK_STATUS, HFPhase1PMTData::minChargeAsymm(), HFRecHitAuxSetter::OFF_STATUS, HFAnodeStatus::OK, pmtInfo_, submitPVResolutionJobs::q, DetId::rawId(), HFSimpleTimeCheck::reconstruct(), CaloRecHit::setFlagField(), and mitigatedMETSequence_cff::U.

                                                                            {
   // The algorithm must be configured by now
   if (!algoConf_)
     throw cms::Exception("HFPhase1BadConfig") << "In HFFlexibleTimeCheck::reconstruct: algorithm is not configured";
 
   // Fetch the algorithm configuration data for this PMT
   pmtInfo_ = &algoConf_->at(prehit.id());
 
   // Run the reconstruction algorithm from the base class
   HFRecHit rh = HFSimpleTimeCheck::reconstruct(prehit, calibs, flaggedBadInDB, expectSingleAnodePMT);
 
   if (rh.id().rawId()) {
     // Check the charge asymmetry between the two anodes
     bool setAsymmetryFlag = true;
     if (!alwaysCalculatingQAsym()) {
       using namespace CaloRecHitAuxSetter;
 
       const unsigned st0 = getField(rh.aux(), HFRecHitAuxSetter::MASK_STATUS, HFRecHitAuxSetter::OFF_STATUS);
       const unsigned st1 = getField(rh.getAuxHF(), HFRecHitAuxSetter::MASK_STATUS, HFRecHitAuxSetter::OFF_STATUS);
       setAsymmetryFlag = st0 == HFAnodeStatus::OK && st1 == HFAnodeStatus::OK;
     }
 
     if (setAsymmetryFlag) {
       bool passesAsymmetryCut = true;
       const std::pair<float, bool> qAsymm = prehit.chargeAsymmetry(pmtInfo_->minChargeAsymm());
       if (qAsymm.second) {
         const float q = prehit.charge();
         const float minAsymm = (pmtInfo_->cut(HFPhase1PMTData::ASYMM_MIN))(q);
         const float maxAsymm = (pmtInfo_->cut(HFPhase1PMTData::ASYMM_MAX))(q);
         passesAsymmetryCut = minAsymm <= qAsymm.first && qAsymm.first <= maxAsymm;
       }
       if (!passesAsymmetryCut)
         rh.setFlagField(1U, HcalPhase1FlagLabels::HFSignalAsymmetry);
     }
   }
 
   return rh;
 }

Member Data Documentation

◆ algoConf_

const HFPhase1PMTParams* HFFlexibleTimeCheck::algoConf_ = nullptr

private

Definition at line 30 of file HFFlexibleTimeCheck.h.

Referenced by configure(), and reconstruct().

◆ pmtInfo_

const HFPhase1PMTData* HFFlexibleTimeCheck::pmtInfo_ = nullptr