SimpleHBHEPhase1Algo Class Reference

#include <SimpleHBHEPhase1Algo.h>

Inheritance diagram for SimpleHBHEPhase1Algo:

Public Member Functions
virtual void	beginRun (const edm::Run &, const edm::EventSetup &) override
virtual void	endRun () override
int	getFirstSampleShift () const
float	getPhaseNS () const
int	getRunNumber () const
int	getSamplesToAdd () const
float	getTimeShift () const
virtual bool	isConfigurable () const override
bool	isCorrectingForPhaseContainment () const
virtual 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, std::unique_ptr< PulseShapeFitOOTPileupCorrection > m2, std::unique_ptr< HcalDeterministicFit > detFit)
virtual	~SimpleHBHEPhase1Algo ()
Public Member Functions inherited from AbsHBHEPhase1Algo
virtual bool	configure (const AbsHcalAlgoData *)
virtual	~AbsHBHEPhase1Algo ()

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, const HcalCalibrations &calibs, int nSamplesToExamine) const

Private Attributes
bool	corrFPC_
int	firstSampleShift_
std::unique_ptr< HcalDeterministicFit >	hltOOTpuCorr_
float	phaseNS_
std::unique_ptr< PulseShapeFitOOTPileupCorrection >	psFitOOTpuCorr_
HcalPulseContainmentManager	pulseCorr_
int	runnum_
int	samplesToAdd_
HcalPulseShapes	theHcalPulseShapes_
float	timeShift_

Detailed Description

Definition at line 17 of file SimpleHBHEPhase1Algo.h.

Constructor & Destructor Documentation

SimpleHBHEPhase1Algo::SimpleHBHEPhase1Algo	(	int	firstSampleShift,
		int	samplesToAdd,
		float	phaseNS,
		float	timeShift,
		bool	correctForPhaseContainment,
		std::unique_ptr< PulseShapeFitOOTPileupCorrection >	m2,
		std::unique_ptr< HcalDeterministicFit >	detFit
	)

Definition at line 18 of file SimpleHBHEPhase1Algo.cc.

    : pulseCorr_(PulseContainmentFractionalError),
      firstSampleShift_(firstSampleShift),
      samplesToAdd_(samplesToAdd),
      phaseNS_(phaseNS),
      timeShift_(timeShift),
      runnum_(0),
      corrFPC_(correctForPhaseContainment),
      psFitOOTpuCorr_(std::move(m2)),
      hltOOTpuCorr_(std::move(detFit))
{
}

virtual SimpleHBHEPhase1Algo::~SimpleHBHEPhase1Algo ( )

inlinevirtual

Definition at line 50 of file SimpleHBHEPhase1Algo.h.

References beginRun(), and endRun().

{}

Member Function Documentation

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

overridevirtual

Reimplemented from AbsHBHEPhase1Algo.

Definition at line 38 of file SimpleHBHEPhase1Algo.cc.

References HcalPulseContainmentManager::beginRun(), pulseCorr_, edm::RunBase::run(), and runnum_.

Referenced by ~SimpleHBHEPhase1Algo().

{
    runnum_ = r.run();
    pulseCorr_.beginRun(es);
}

void SimpleHBHEPhase1Algo::endRun ( )

overridevirtual

Reimplemented from AbsHBHEPhase1Algo.

Definition at line 45 of file SimpleHBHEPhase1Algo.cc.

References HcalPulseContainmentManager::endRun(), pulseCorr_, and runnum_.

Referenced by ~SimpleHBHEPhase1Algo().

{
    runnum_ = 0;
    pulseCorr_.endRun();
}

int SimpleHBHEPhase1Algo::getFirstSampleShift ( ) const

inline

Definition at line 63 of file SimpleHBHEPhase1Algo.h.

References firstSampleShift_.

{return firstSampleShift_;}

float SimpleHBHEPhase1Algo::getPhaseNS ( ) const

inline

Definition at line 65 of file SimpleHBHEPhase1Algo.h.

References phaseNS_.

{return phaseNS_;}

int SimpleHBHEPhase1Algo::getRunNumber ( ) const

inline

Definition at line 68 of file SimpleHBHEPhase1Algo.h.

References hbminusCorrectionFactor(), m0Energy(), m0Time(), and runnum_.

{return runnum_;}

int SimpleHBHEPhase1Algo::getSamplesToAdd ( ) const

inline

Definition at line 64 of file SimpleHBHEPhase1Algo.h.

References samplesToAdd_.

{return samplesToAdd_;}

float SimpleHBHEPhase1Algo::getTimeShift ( ) const

inline

Definition at line 66 of file SimpleHBHEPhase1Algo.h.

References timeShift_.

{return timeShift_;}

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

protected

Definition at line 130 of file SimpleHBHEPhase1Algo.cc.

References corr, hbminus_special_ecorr(), HcalBarrel, HcalDetId::ieta(), HcalDetId::iphi(), runnum_, and HcalDetId::subdet().

Referenced by getRunNumber(), and reconstruct().

{
    float corr = 1.f;
    if (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;
}

virtual bool SimpleHBHEPhase1Algo::isConfigurable ( ) const

inlineoverridevirtual

Implements AbsHBHEPhase1Algo.

Definition at line 56 of file SimpleHBHEPhase1Algo.h.

References info(), and reconstruct().

{return false;}

bool SimpleHBHEPhase1Algo::isCorrectingForPhaseContainment ( ) const

inline

Definition at line 67 of file SimpleHBHEPhase1Algo.h.

References corrFPC_.

{return corrFPC_;}

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

protected

Definition at line 145 of file SimpleHBHEPhase1Algo.cc.

References MillePedeFileConverter_cfg::e, HBHEChannelInfo::energyInWindow(), firstSampleShift_, HcalPulseContainmentManager::get(), HBHEChannelInfo::id(), pulseCorr_, and HBHEChannelInfo::soi().

Referenced by getRunNumber(), and reconstruct().

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

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

protected

Definition at line 167 of file SimpleHBHEPhase1Algo.cc.

References HcalTimeSlew::delay(), f, firstSampleShift_, hpstanc_transforms::max, findQualityFiles::maxI, HBHEChannelInfo::MAXSAMPLES, HcalTimeSlew::Medium, hgc_digi::nSamples, HBHEChannelInfo::nSamples(), HBHEChannelInfo::peakEnergyTS(), HBHEChannelInfo::soi(), cscNeutronWriter_cfi::t0, reco::t2, ntuplemaker::time, HcalCalibrations::timecorr(), timeshift_ns_hbheho(), HBHEChannelInfo::tsEnergy(), and mitigatedMETSequence_cff::U.

Referenced by getRunNumber(), and reconstruct().

{
    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 = ibeg + nSamplesToExamine;
        unsigned maxI = info.peakEnergyTS(ibeg, iend);
        if (maxI < HBHEChannelInfo::MAXSAMPLES)
        {
            if (!maxI)
                maxI = 1U;
            else if (maxI >= nSamples - 1U)
                maxI = nSamples - 2U;

            // The remaining code in this scope emulates
            // the historic algorithm
            float t0 = info.tsEnergy(maxI - 1U);
            float maxA = info.tsEnergy(maxI);
            float t2 = info.tsEnergy(maxI + 1U);

            // Handle negative excursions by moving "zero"
            float minA = t0;
            if (maxA < minA) minA = maxA;
            if (t2 < minA)   minA=t2;
            if (minA < 0.f) { maxA-=minA; t0-=minA; t2-=minA; }
            float wpksamp = (t0 + maxA + t2);
            if (wpksamp) wpksamp = (maxA + 2.f*t2) / wpksamp;
            time = (maxI - soi)*25.f + timeshift_ns_hbheho(wpksamp);

            // Legacy QIE8 timing correction
            time -= HcalTimeSlew::delay(std::max(1.0, fc_ampl),
                                        HcalTimeSlew::Medium);
            // Time calibration
            time -= calibs.timecorr();
        }
    }
    return time;
}

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

overridevirtual

Implements AbsHBHEPhase1Algo.

Definition at line 51 of file SimpleHBHEPhase1Algo.cc.

References HBHEChannelInfo::chargeInWindow(), HiEvtPlane_cfi::chi2, HcalRecoParam::correctForPhaseContainment(), HcalRecoParam::correctionPhaseNS(), corrFPC_, firstSampleShift_, HcalPulseShapes::getShape(), HBHEChannelInfo::hasTimeInfo(), HcalPhase1FlagLabels::HBHEPulseFitBit, hbminusCorrectionFactor(), hltOOTpuCorr_, HBHEChannelInfo::id(), HcalSpecialTimes::isSpecial(), m0Energy(), m0Time(), HcalDeterministicFit::phase1Apply(), PulseShapeFitOOTPileupCorrection::phase1Apply(), phaseNS_, psFitOOTpuCorr_, HBHEChannelInfo::recoShape(), HcalRecoParam::samplesToAdd(), samplesToAdd_, HBHERecHitAuxSetter::setAux(), HBHERecHit::setAuxEnergy(), HBHERecHit::setChiSquared(), CaloRecHit::setFlagField(), HBHERecHit::setRawEnergy(), HBHEChannelInfo::soi(), HBHEChannelInfo::soiRiseTime(), theHcalPulseShapes_, and timeShift_.

Referenced by isConfigurable().

{
    HBHERecHit rh;

    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, calibs, 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());
        // "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);
        m3E *= hbminusCorrectionFactor(channelId, m3E, isData);
    }

    // Finally, construct the rechit
    float rhE = m0E;
    float rht = m0t;
    if (method2)
    {
        rhE = m2E;
        rht = m2t;
    }
    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(chi2);

    // Set rechit aux words
    HBHERecHitAuxSetter::setAux(info, &rh);

    // Set some rechit flags (here, for Method 2)
    if (useTriple)
       rh.setFlagField(1, HcalPhase1FlagLabels::HBHEPulseFitBit);

    return rh;
}

Member Data Documentation

bool SimpleHBHEPhase1Algo::corrFPC_

private

Definition at line 96 of file SimpleHBHEPhase1Algo.h.

Referenced by isCorrectingForPhaseContainment(), and reconstruct().

int SimpleHBHEPhase1Algo::firstSampleShift_

private

Definition at line 91 of file SimpleHBHEPhase1Algo.h.

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

std::unique_ptr<HcalDeterministicFit> SimpleHBHEPhase1Algo::hltOOTpuCorr_

private

Definition at line 102 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

float SimpleHBHEPhase1Algo::phaseNS_

private

Definition at line 93 of file SimpleHBHEPhase1Algo.h.

Referenced by getPhaseNS(), and reconstruct().

std::unique_ptr<PulseShapeFitOOTPileupCorrection> SimpleHBHEPhase1Algo::psFitOOTpuCorr_

private

Definition at line 99 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

HcalPulseContainmentManager SimpleHBHEPhase1Algo::pulseCorr_

private

Definition at line 89 of file SimpleHBHEPhase1Algo.h.

Referenced by beginRun(), endRun(), and m0Energy().

int SimpleHBHEPhase1Algo::runnum_

private

Definition at line 95 of file SimpleHBHEPhase1Algo.h.

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

int SimpleHBHEPhase1Algo::samplesToAdd_

private

Definition at line 92 of file SimpleHBHEPhase1Algo.h.

Referenced by getSamplesToAdd(), and reconstruct().

HcalPulseShapes SimpleHBHEPhase1Algo::theHcalPulseShapes_

private

Definition at line 104 of file SimpleHBHEPhase1Algo.h.

Referenced by reconstruct().

float SimpleHBHEPhase1Algo::timeShift_

private

Definition at line 94 of file SimpleHBHEPhase1Algo.h.

Referenced by getTimeShift(), and reconstruct().