CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Member Functions | Private Attributes
HFFlexibleTimeCheck Class Reference

#include <HFFlexibleTimeCheck.h>

Inheritance diagram for HFFlexibleTimeCheck:
HFSimpleTimeCheck AbsHFPhase1Algo

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 HFPhase1PMTParamsalgoConf_ = nullptr
 
const HFPhase1PMTDatapmtInfo_ = 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 submitPVResolutionJobs::config.

15  {
16  algoConf_ = dynamic_cast<const HFPhase1PMTParams*>(config);
17  return algoConf_;
18  }
const HFPhase1PMTParams * algoConf_
config
parse the configuration file

◆ 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.

14  {
15  // Return quickly if this anode has a dataframe error
16  if (!anode.isDataframeOK())
18 
19  // Require minimum charge for reliable timing measurement
20  const float charge = anode.charge();
21  const float minCharge = ianode ? pmtInfo_->minCharge1() : pmtInfo_->minCharge0();
22  if (charge < minCharge) {
23  *isTimingReliable = false;
24  return HFAnodeStatus::OK;
25  }
26 
27  // Special handling of under/overshoot TDC values, as well
28  // as of DLL failures
29  float trise = anode.timeRising();
33  *isTimingReliable = false;
34  return HFAnodeStatus::OK;
35  }
36 
37  // Check if the rise time information is meaningful
38  if (HcalSpecialTimes::isSpecial(trise))
40 
41  // Figure out the timing cuts for this PMT
44 
45  // Apply the timing cuts
46  trise += timeShift();
47  if (minTimeShape(charge) <= trise && trise <= maxTimeShape(charge))
48  return HFAnodeStatus::OK;
49  else
51 }
constexpr float charge() const
Definition: HFQIE10Info.h:79
const AbsHcalFunctor & cut(const unsigned which) const
constexpr float UNKNOWN_T_DLL_FAILURE
float timeShift() const
constexpr float UNKNOWN_T_UNDERSHOOT
constexpr float UNKNOWN_T_OVERSHOOT
constexpr float timeRising() const
Definition: HFQIE10Info.h:81
float minCharge1() const
constexpr bool isSpecial(const float t)
float minChargeForOvershoot() const
float minChargeForUndershoot() const
bool isDataframeOK(bool checkAllTimeSlices=false) const
Definition: HFQIE10Info.h:94
const HFPhase1PMTData * pmtInfo_
float minCharge0() const

◆ HFSimpleTimeCheck()

HFSimpleTimeCheck::HFSimpleTimeCheck

Definition at line 32 of file HFSimpleTimeCheck.cc.

42  : soiPhase_(i_soiPhase),
43  timeShift_(i_timeShift),
44  triseIfNoTDC_(i_triseIfNoTDC),
45  tfallIfNoTDC_(i_tfallIfNoTDC),
46  minChargeForUndershoot_(i_minChargeForUndershoot),
47  minChargeForOvershoot_(i_minChargeForOvershoot),
50  tlimits_[0] = tlimits[0];
51  tlimits_[1] = tlimits[1];
52  float* to = &energyWeights_[0][0];
53  const float* from = &energyWeights[0][0];
54  memcpy(to, from, sizeof(energyWeights_));
55 }
std::pair< float, float > tlimits_[2]
float energyWeights_[2 *HFAnodeStatus::N_POSSIBLE_STATES - 1][2]
alwaysCalculateQAsymmetry
Definition: hfreco_cfi.py:113

◆ 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.

56  {
57  // The algorithm must be configured by now
58  if (!algoConf_)
59  throw cms::Exception("HFPhase1BadConfig") << "In HFFlexibleTimeCheck::reconstruct: algorithm is not configured";
60 
61  // Fetch the algorithm configuration data for this PMT
62  pmtInfo_ = &algoConf_->at(prehit.id());
63 
64  // Run the reconstruction algorithm from the base class
65  HFRecHit rh = HFSimpleTimeCheck::reconstruct(prehit, calibs, flaggedBadInDB, expectSingleAnodePMT);
66 
67  if (rh.id().rawId()) {
68  // Check the charge asymmetry between the two anodes
69  bool setAsymmetryFlag = true;
70  if (!alwaysCalculatingQAsym()) {
71  using namespace CaloRecHitAuxSetter;
72 
75  setAsymmetryFlag = st0 == HFAnodeStatus::OK && st1 == HFAnodeStatus::OK;
76  }
77 
78  if (setAsymmetryFlag) {
79  bool passesAsymmetryCut = true;
80  const std::pair<float, bool> qAsymm = prehit.chargeAsymmetry(pmtInfo_->minChargeAsymm());
81  if (qAsymm.second) {
82  const float q = prehit.charge();
83  const float minAsymm = (pmtInfo_->cut(HFPhase1PMTData::ASYMM_MIN))(q);
84  const float maxAsymm = (pmtInfo_->cut(HFPhase1PMTData::ASYMM_MAX))(q);
85  passesAsymmetryCut = minAsymm <= qAsymm.first && qAsymm.first <= maxAsymm;
86  }
87  if (!passesAsymmetryCut)
89  }
90  }
91 
92  return rh;
93 }
const AbsHcalFunctor & cut(const unsigned which) const
const HFPhase1PMTParams * algoConf_
bool alwaysCalculatingQAsym() const
constexpr void setFlagField(uint32_t value, int base, int width=1)
Definition: CaloRecHit.h:36
static const unsigned OFF_STATUS
constexpr uint32_t aux() const
Definition: CaloRecHit.h:50
constexpr HcalDetId id() const
Definition: HFRecHit.h:26
static const unsigned MASK_STATUS
constexpr unsigned getField(const uint32_t u, const unsigned mask, const unsigned offset)
constexpr float charge() const
Definition: HFPreRecHit.h:47
const Item & at(const HcalDetId &id) const
HFRecHit reconstruct(const HFPreRecHit &prehit, const HcalCalibrations &calibs, const bool flaggedBadInDB[2], bool expectSingleAnodePMT) override
constexpr uint32_t rawId() const
get the raw id
Definition: DetId.h:57
constexpr HcalDetId id() const
Definition: HFPreRecHit.h:34
constexpr uint32_t getAuxHF() const
Definition: HFRecHit.h:29
const HFPhase1PMTData * pmtInfo_
float minChargeAsymm() const
std::pair< float, bool > chargeAsymmetry(float chargeThreshold) const
Definition: HFPreRecHit.cc:3

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
private

Definition at line 31 of file HFFlexibleTimeCheck.h.

Referenced by determineAnodeStatus(), and reconstruct().