#include <SimpleHBHEPhase1Algo.h>

Inheritance diagram for SimpleHBHEPhase1Algo:

Public Member Functions
void	beginRun (const edm::Run &, const edm::EventSetup &) override

void	endRun () override

int	getFirstSampleShift () const

float	getPhaseNS () const

int	getRunNumber () const

int	getSamplesToAdd () const

float	getTimeShift () const

bool	isConfigurable () const override

bool	isCorrectingForPhaseContainment () const

HBHERecHit	reconstruct (const HBHEChannelInfo &info, const HcalRecoParam *params, const HcalCalibrations &calibs, bool isRealData) override

	SimpleHBHEPhase1Algo (int firstSampleShift, int samplesToAdd, float phaseNS, float timeShift, bool correctForPhaseContainment, bool applyLegacyHBMCorrection, std::unique_ptr< PulseShapeFitOOTPileupCorrection > m2, std::unique_ptr< HcalDeterministicFit > detFit, std::unique_ptr< MahiFit > mahi, edm::ConsumesCollector iC)

	~SimpleHBHEPhase1Algo () override

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

virtual	~AbsHBHEPhase1Algo ()

Public Attributes
edm::ESGetToken< HcalTimeSlew, HcalTimeSlewRecord >	delayToken_

const HcalTimeSlew *	hcalTimeSlew_delay_

Protected Member Functions
float	hbminusCorrectionFactor (const HcalDetId &cell, float energy, bool isRealData) const

float	m0Energy (const HBHEChannelInfo &info, double reconstructedCharge, bool applyContainmentCorrection, double phaseNS, int nSamplesToAdd)

float	m0Time (const HBHEChannelInfo &info, double reconstructedCharge, int nSamplesToExamine) const

Private Attributes
bool	applyLegacyHBMCorrection_

bool	corrFPC_

int	firstSampleShift_

std::unique_ptr< HcalDeterministicFit >	hltOOTpuCorr_

std::unique_ptr< MahiFit >	mahiOOTpuCorr_

float	phaseNS_

std::unique_ptr< PulseShapeFitOOTPileupCorrection >	psFitOOTpuCorr_

HcalPulseContainmentManager	pulseCorr_

int	runnum_

int	samplesToAdd_

HcalPulseShapes	theHcalPulseShapes_

float	timeShift_

Detailed Description

Definition at line 18 of file SimpleHBHEPhase1Algo.h.

Constructor & Destructor Documentation

◆ SimpleHBHEPhase1Algo()

SimpleHBHEPhase1Algo::SimpleHBHEPhase1Algo	(	int	firstSampleShift,
		int	samplesToAdd,
		float	phaseNS,
		float	timeShift,
		bool	correctForPhaseContainment,
		bool	applyLegacyHBMCorrection,
		std::unique_ptr< PulseShapeFitOOTPileupCorrection >	m2,
		std::unique_ptr< HcalDeterministicFit >	detFit,
		std::unique_ptr< MahiFit >	mahi,
		edm::ConsumesCollector	iC
	)

Definition at line 22 of file SimpleHBHEPhase1Algo.cc.

     : delayToken_(iC.esConsumes<edm::Transition::BeginRun>(edm::ESInputTag("", "HBHE"))),
       pulseCorr_(PulseContainmentFractionalError, iC),
       firstSampleShift_(firstSampleShift),
       samplesToAdd_(samplesToAdd),
       phaseNS_(phaseNS),
       timeShift_(timeShift),
       runnum_(0),
       corrFPC_(correctForPhaseContainment),
       applyLegacyHBMCorrection_(applyLegacyHBMCorrection),
       psFitOOTpuCorr_(std::move(m2)),
       hltOOTpuCorr_(std::move(detFit)),
       mahiOOTpuCorr_(std::move(mahi)) {
   hcalTimeSlew_delay_ = nullptr;
 }

References hcalTimeSlew_delay_.

◆ ~SimpleHBHEPhase1Algo()

SimpleHBHEPhase1Algo::~SimpleHBHEPhase1Algo ( )

inlineoverride

Definition at line 53 of file SimpleHBHEPhase1Algo.h.

53 {}

Member Function Documentation

◆ beginRun()

void SimpleHBHEPhase1Algo::beginRun	(	const edm::Run &	r,
		const edm::EventSetup &	es
	)

overridevirtual

Reimplemented from AbsHBHEPhase1Algo.

Definition at line 47 of file SimpleHBHEPhase1Algo.cc.

                                                                             {
   hcalTimeSlew_delay_ = &es.getData(delayToken_);
  
   runnum_ = r.run();
   pulseCorr_.beginRun(es);
 }

References HcalPulseContainmentManager::beginRun(), delayToken_, edm::EventSetup::getData(), hcalTimeSlew_delay_, pulseCorr_, alignCSCRings::r, and runnum_.

◆ endRun()

void SimpleHBHEPhase1Algo::endRun ( )

overridevirtual

Reimplemented from AbsHBHEPhase1Algo.

Definition at line 54 of file SimpleHBHEPhase1Algo.cc.

54 { runnum_ = 0; }

References runnum_.

◆ getFirstSampleShift()

int SimpleHBHEPhase1Algo::getFirstSampleShift ( ) const

inline

Definition at line 66 of file SimpleHBHEPhase1Algo.h.

66 { return firstSampleShift_; }

References firstSampleShift_.

◆ getPhaseNS()

float SimpleHBHEPhase1Algo::getPhaseNS ( ) const

inline

Definition at line 68 of file SimpleHBHEPhase1Algo.h.

68 { return phaseNS_; }

References phaseNS_.

◆ getRunNumber()

int SimpleHBHEPhase1Algo::getRunNumber ( ) const

inline

Definition at line 71 of file SimpleHBHEPhase1Algo.h.

71 { return runnum_; }

References runnum_.

◆ getSamplesToAdd()

int SimpleHBHEPhase1Algo::getSamplesToAdd ( ) const

inline

Definition at line 67 of file SimpleHBHEPhase1Algo.h.

67 { return samplesToAdd_; }

References samplesToAdd_.

◆ getTimeShift()

float SimpleHBHEPhase1Algo::getTimeShift ( ) const

inline

Definition at line 69 of file SimpleHBHEPhase1Algo.h.

69 { return timeShift_; }

References timeShift_.

◆ hbminusCorrectionFactor()

float SimpleHBHEPhase1Algo::hbminusCorrectionFactor	(	const HcalDetId &	cell,
		float	energy,
		bool	isRealData
	)		const

protected

Definition at line 149 of file SimpleHBHEPhase1Algo.cc.

                                                                                  {
   float corr = 1.f;
   if (applyLegacyHBMCorrection_ && isRealData && runnum_ > 0)
     if (cell.subdet() == HcalBarrel) {
       const int ieta = cell.ieta();
       const int iphi = cell.iphi();
       corr = hbminus_special_ecorr(ieta, iphi, energy, runnum_);
     }
   return corr;
 }

References applyLegacyHBMCorrection_, alignCSCRings::corr, HCALHighEnergyHPDFilter_cfi::energy, hbminus_special_ecorr(), HcalBarrel, LEDCalibrationChannels::ieta, HcalDetId::ieta(), LEDCalibrationChannels::iphi, HcalDetId::iphi(), runnum_, and HcalDetId::subdet().

Referenced by reconstruct().

◆ isConfigurable()

bool SimpleHBHEPhase1Algo::isConfigurable ( ) const

inlineoverridevirtual

Implements AbsHBHEPhase1Algo.

Definition at line 59 of file SimpleHBHEPhase1Algo.h.

59 { return false; }

◆ isCorrectingForPhaseContainment()

bool SimpleHBHEPhase1Algo::isCorrectingForPhaseContainment ( ) const

inline

Definition at line 70 of file SimpleHBHEPhase1Algo.h.

70 { return corrFPC_; }

References corrFPC_.

◆ m0Energy()

float SimpleHBHEPhase1Algo::m0Energy	(	const HBHEChannelInfo &	info,
		double	reconstructedCharge,
		bool	applyContainmentCorrection,
		double	phaseNS,
		int	nSamplesToAdd
	)

protected

Definition at line 162 of file SimpleHBHEPhase1Algo.cc.

                                                               {
   int ibeg = static_cast<int>(info.soi()) + firstSampleShift_;
   if (ibeg < 0)
     ibeg = 0;
   double e = info.energyInWindow(ibeg, ibeg + nSamplesToAdd);
  
   // Pulse containment correction
   {
     double corrFactor = 1.0;
     if (applyContainmentCorrection)
       corrFactor = pulseCorr_.get(info.id(), nSamplesToAdd, phaseNs)->getCorrection(fc_ampl);
     e *= corrFactor;
   }
  
   return e;
 }

References MillePedeFileConverter_cfg::e, firstSampleShift_, HcalPulseContainmentManager::get(), info(), and pulseCorr_.

Referenced by reconstruct().

◆ m0Time()

float SimpleHBHEPhase1Algo::m0Time	(	const HBHEChannelInfo &	info,
		double	reconstructedCharge,
		int	nSamplesToExamine
	)		const

protected

Definition at line 183 of file SimpleHBHEPhase1Algo.cc.

                                                                       {
   float time = -9999.f;  // historic value
  
   const unsigned nSamples = info.nSamples();
   if (nSamples > 2U) {
     const int soi = info.soi();
     int ibeg = soi + firstSampleShift_;
     if (ibeg < 0)
       ibeg = 0;
     const int iend = std::min(ibeg + nSamplesToExamine, (int)nSamples - 1);  // actual array
  
     unsigned maxI = info.peakEnergyTS((unsigned)ibeg, (unsigned)iend);  // requires unsigned params
     if (maxI < HBHEChannelInfo::MAXSAMPLES) {
       if (maxI >= nSamples)
         maxI = nSamples - 1U;  // just in case
  
       // Simplified evaluation for Phase1
       float emax0 = info.tsEnergy(maxI);
       float emax1 = 0.f;
       if (maxI < (nSamples - 1U))
         emax1 = info.tsEnergy(maxI + 1U);
  
       // consider soi reference for collisions
       int position = (int)maxI;
       if (nSamplesToExamine < (int)nSamples)
         position -= soi;
  
       time = 25.f * (float)position;
       if (emax0 > 0.f && emax1 > 0.f)
         time += 25.f * emax1 / (emax0 + emax1);  // 1st order corr.
  
       // TimeSlew correction
       time -= hcalTimeSlew_delay_->delay(std::max(1.0, fc_ampl), HcalTimeSlew::Medium);
     }
   }
   return time;
 }

References HcalTimeSlew::delay(), f, firstSampleShift_, dqmMemoryStats::float, hcalTimeSlew_delay_, info(), createfilelist::int, SiStripPI::max, findQualityFiles::maxI, HBHEChannelInfo::MAXSAMPLES, HcalTimeSlew::Medium, min(), PresampleTask_cfi::nSamples, position, protons_cff::time, and mitigatedMETSequence_cff::U.

Referenced by reconstruct().

◆ reconstruct()

HBHERecHit SimpleHBHEPhase1Algo::reconstruct	(	const HBHEChannelInfo &	info,
		const HcalRecoParam *	params,
		const HcalCalibrations &	calibs,
		bool	isRealData
	)

overridevirtual

Implements AbsHBHEPhase1Algo.

Definition at line 56 of file SimpleHBHEPhase1Algo.cc.

                                                                 {
   const HcalDetId channelId(info.id());
  
   // Calculate "Method 0" quantities
   float m0t = 0.f, m0E = 0.f;
   {
     int ibeg = static_cast<int>(info.soi()) + firstSampleShift_;
     if (ibeg < 0)
       ibeg = 0;
     const int nSamplesToAdd = params ? params->samplesToAdd() : samplesToAdd_;
     const double fc_ampl = info.chargeInWindow(ibeg, ibeg + nSamplesToAdd);
     const bool applyContainment = params ? params->correctForPhaseContainment() : corrFPC_;
     const float phasens = params ? params->correctionPhaseNS() : phaseNS_;
     m0E = m0Energy(info, fc_ampl, applyContainment, phasens, nSamplesToAdd);
     m0E *= hbminusCorrectionFactor(channelId, m0E, isData);
     m0t = m0Time(info, fc_ampl, nSamplesToAdd);
   }
  
   // Run "Method 2"
   float m2t = 0.f, m2E = 0.f, chi2 = -1.f;
   bool useTriple = false;
   const PulseShapeFitOOTPileupCorrection* method2 = psFitOOTpuCorr_.get();
   if (method2) {
     psFitOOTpuCorr_->setPulseShapeTemplate(
         theHcalPulseShapes_.getShape(info.recoShape()), !info.hasTimeInfo(), info.nSamples(), hcalTimeSlew_delay_);
     // "phase1Apply" call below sets m2E, m2t, useTriple, and chi2.
     // These parameters are pased by non-const reference.
     method2->phase1Apply(info, m2E, m2t, useTriple, chi2);
     m2E *= hbminusCorrectionFactor(channelId, m2E, isData);
   }
  
   // Run "Method 3"
   float m3t = 0.f, m3E = 0.f;
   const HcalDeterministicFit* method3 = hltOOTpuCorr_.get();
   if (method3) {
     // "phase1Apply" sets m3E and m3t (pased by non-const reference)
     method3->phase1Apply(info, m3E, m3t, hcalTimeSlew_delay_);
     m3E *= hbminusCorrectionFactor(channelId, m3E, isData);
   }
  
   // Run Mahi
   float m4E = 0.f, m4chi2 = -1.f;
   float m4T = 0.f;
   bool m4UseTriple = false;
  
   const MahiFit* mahi = mahiOOTpuCorr_.get();
  
   if (mahi) {
     mahiOOTpuCorr_->setPulseShapeTemplate(
         info.recoShape(), theHcalPulseShapes_, info.hasTimeInfo(), hcalTimeSlew_delay_, info.nSamples());
     mahi->phase1Apply(info, m4E, m4T, m4UseTriple, m4chi2);
     m4E *= hbminusCorrectionFactor(channelId, m4E, isData);
   }
  
   // Finally, construct the rechit
   HBHERecHit rh;
  
   float rhE = m0E;
   float rht = m0t;
   float rhX = -1.f;
   if (mahi) {
     rhE = m4E;
     rht = m4T;
     rhX = m4chi2;
   } else if (method2) {
     rhE = m2E;
     rht = m2t;
     rhX = chi2;
   } else if (method3) {
     rhE = m3E;
     rht = m3t;
   }
   float tdcTime = info.soiRiseTime();
   if (!HcalSpecialTimes::isSpecial(tdcTime))
     tdcTime += timeShift_;
   rh = HBHERecHit(channelId, rhE, rht, tdcTime);
   rh.setRawEnergy(m0E);
   rh.setAuxEnergy(m3E);
   rh.setChiSquared(rhX);
  
   // Set rechit aux words
   HBHERecHitAuxSetter::setAux(info, &rh);
  
   // Set some rechit flags (here, for Method 2/Mahi)
   if (useTriple || m4UseTriple)
     rh.setFlagField(1, HcalPhase1FlagLabels::HBHEPulseFitBit);
  
   return rh;
 }

References hltPixelTracks_cff::chi2, corrFPC_, firstSampleShift_, HcalPulseShapes::getShape(), HcalPhase1FlagLabels::HBHEPulseFitBit, hbminusCorrectionFactor(), hcalTimeSlew_delay_, hltOOTpuCorr_, info(), HLTBitAnalyser_cfi::isData, HcalSpecialTimes::isSpecial(), m0Energy(), m0Time(), mahiOOTpuCorr_, CalibrationSummaryClient_cfi::params, HcalDeterministicFit::phase1Apply(), PulseShapeFitOOTPileupCorrection::phase1Apply(), MahiFit::phase1Apply(), phaseNS_, psFitOOTpuCorr_, samplesToAdd_, HBHERecHitAuxSetter::setAux(), HBHERecHit::setAuxEnergy(), HBHERecHit::setChiSquared(), CaloRecHit::setFlagField(), HBHERecHit::setRawEnergy(), theHcalPulseShapes_, and timeShift_.

Member Data Documentation

◆ applyLegacyHBMCorrection_

bool SimpleHBHEPhase1Algo::applyLegacyHBMCorrection_

private

Definition at line 101 of file SimpleHBHEPhase1Algo.h.

Referenced by hbminusCorrectionFactor().

◆ corrFPC_

bool SimpleHBHEPhase1Algo::corrFPC_

private

Definition at line 100 of file SimpleHBHEPhase1Algo.h.

Referenced by isCorrectingForPhaseContainment(), and reconstruct().

◆ delayToken_

edm::ESGetToken<HcalTimeSlew, HcalTimeSlewRecord> SimpleHBHEPhase1Algo::delayToken_

Definition at line 73 of file SimpleHBHEPhase1Algo.h.

Referenced by beginRun().

◆ firstSampleShift_

int SimpleHBHEPhase1Algo::firstSampleShift_

private

Definition at line 95 of file SimpleHBHEPhase1Algo.h.

Referenced by getFirstSampleShift(), m0Energy(), m0Time(), and reconstruct().

◆ hcalTimeSlew_delay_

const HcalTimeSlew* SimpleHBHEPhase1Algo::hcalTimeSlew_delay_

Definition at line 74 of file SimpleHBHEPhase1Algo.h.

Referenced by beginRun(), m0Time(), reconstruct(), and SimpleHBHEPhase1Algo().

◆ hltOOTpuCorr_

std::unique_ptr<HcalDeterministicFit> SimpleHBHEPhase1Algo::hltOOTpuCorr_

private

Definition at line 107 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

◆ mahiOOTpuCorr_

std::unique_ptr<MahiFit> SimpleHBHEPhase1Algo::mahiOOTpuCorr_

private

Definition at line 110 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

◆ phaseNS_

float SimpleHBHEPhase1Algo::phaseNS_

private

Definition at line 97 of file SimpleHBHEPhase1Algo.h.

Referenced by getPhaseNS(), and reconstruct().

◆ psFitOOTpuCorr_

std::unique_ptr<PulseShapeFitOOTPileupCorrection> SimpleHBHEPhase1Algo::psFitOOTpuCorr_

private

Definition at line 104 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

◆ pulseCorr_

HcalPulseContainmentManager SimpleHBHEPhase1Algo::pulseCorr_

private

Definition at line 93 of file SimpleHBHEPhase1Algo.h.

Referenced by beginRun(), and m0Energy().

◆ runnum_

int SimpleHBHEPhase1Algo::runnum_

private

Definition at line 99 of file SimpleHBHEPhase1Algo.h.

Referenced by beginRun(), endRun(), getRunNumber(), and hbminusCorrectionFactor().

◆ samplesToAdd_

int SimpleHBHEPhase1Algo::samplesToAdd_

private

Definition at line 96 of file SimpleHBHEPhase1Algo.h.

Referenced by getSamplesToAdd(), and reconstruct().

◆ theHcalPulseShapes_

HcalPulseShapes SimpleHBHEPhase1Algo::theHcalPulseShapes_

private

Definition at line 112 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

◆ timeShift_

float SimpleHBHEPhase1Algo::timeShift_

private

Definition at line 98 of file SimpleHBHEPhase1Algo.h.

Referenced by getTimeShift(), and reconstruct().

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimpleHBHEPhase1Algo()

◆ ~SimpleHBHEPhase1Algo()

Member Function Documentation

◆ beginRun()

◆ endRun()

◆ getFirstSampleShift()

◆ getPhaseNS()

◆ getRunNumber()

◆ getSamplesToAdd()

◆ getTimeShift()

◆ hbminusCorrectionFactor()

◆ isConfigurable()

◆ isCorrectingForPhaseContainment()

◆ m0Energy()

◆ m0Time()

◆ reconstruct()

Member Data Documentation

◆ applyLegacyHBMCorrection_

◆ corrFPC_

◆ delayToken_

◆ firstSampleShift_

◆ hcalTimeSlew_delay_

◆ hltOOTpuCorr_

◆ mahiOOTpuCorr_

◆ phaseNS_

◆ psFitOOTpuCorr_

◆ pulseCorr_

◆ runnum_

◆ samplesToAdd_

◆ theHcalPulseShapes_

◆ timeShift_