PulseShapeFunctor.cc

Go to the documentation of this file.

#include <iostream>
#include <cmath>
#include <climits>
#include "RecoLocalCalo/HcalRecAlgos/interface/PulseShapeFunctor.h"
#include "FWCore/Utilities/interface/isFinite.h"

namespace FitterFuncs {

  //Decalare the Pulse object take it in from Hcal and set some options
  PulseShapeFunctor::PulseShapeFunctor(const HcalPulseShapes::Shape &pulse,
                                       bool iPedestalConstraint,
                                       bool iTimeConstraint,
                                       bool iAddPulseJitter,
                                       double iPulseJitter,
                                       double iTimeMean,
                                       double iPedMean,
                                       unsigned nSamplesToFit)
      : cntNANinfit(0),
        acc25nsVec_(hcal::constants::maxPSshapeBin),
        diff25nsItvlVec_(hcal::constants::maxPSshapeBin),
        accVarLenIdxZEROVec_(hcal::constants::nsPerBX),
        diffVarItvlIdxZEROVec_(hcal::constants::nsPerBX),
        accVarLenIdxMinusOneVec_(hcal::constants::nsPerBX),
        diffVarItvlIdxMinusOneVec_(hcal::constants::nsPerBX) {
    //The raw pulse
    for (int i = 0; i < hcal::constants::maxPSshapeBin; ++i)
      pulse_hist[i] = pulse(i);
    // Accumulate 25ns for each starting point of 0, 1, 2, 3...
    for (int i = 0; i < hcal::constants::maxPSshapeBin; ++i) {
      for (int j = i; j < i + hcal::constants::nsPerBX; ++j) {  //sum over hcal::constants::nsPerBXns from point i
        acc25nsVec_[i] +=
            (j < hcal::constants::maxPSshapeBin ? pulse_hist[j] : pulse_hist[hcal::constants::maxPSshapeBin - 1]);
      }
      diff25nsItvlVec_[i] = (i + hcal::constants::nsPerBX < hcal::constants::maxPSshapeBin
                                 ? pulse_hist[i + hcal::constants::nsPerBX] - pulse_hist[i]
                                 : pulse_hist[hcal::constants::maxPSshapeBin - 1] - pulse_hist[i]);
    }
    // Accumulate different ns for starting point of index either 0 or -1
    for (int i = 0; i < hcal::constants::nsPerBX; ++i) {
      if (i == 0) {
        accVarLenIdxZEROVec_[0] = pulse_hist[0];
        accVarLenIdxMinusOneVec_[i] = pulse_hist[0];
      } else {
        accVarLenIdxZEROVec_[i] = accVarLenIdxZEROVec_[i - 1] + pulse_hist[i];
        accVarLenIdxMinusOneVec_[i] = accVarLenIdxMinusOneVec_[i - 1] + pulse_hist[i - 1];
      }
      diffVarItvlIdxZEROVec_[i] = pulse_hist[i + 1] - pulse_hist[0];
      diffVarItvlIdxMinusOneVec_[i] = pulse_hist[i] - pulse_hist[0];
    }
    for (int i = 0; i < hcal::constants::maxSamples; i++) {
      psFit_x[i] = 0;
      psFit_y[i] = 0;
      psFit_erry[i] = 1.;
      psFit_erry2[i] = 1.;
      psFit_slew[i] = 0.;
    }
    //Constraints
    pedestalConstraint_ = iPedestalConstraint;
    timeConstraint_ = iTimeConstraint;
    addPulseJitter_ = iAddPulseJitter;
    pulseJitter_ = iPulseJitter * iPulseJitter;

    // for M2
    timeMean_ = iTimeMean;
    pedMean_ = iPedMean;
    timeShift_ = 100.;
    timeShift_ += 12.5;  //we are trying to get BX

    nSamplesToFit_ = nSamplesToFit;
  }

  void PulseShapeFunctor::funcShape(std::array<double, hcal::constants::maxSamples> &ntmpbin,
                                    const double pulseTime,
                                    const double pulseHeight,
                                    const double slew,
                                    bool scalePulse) {
    // pulse shape components over a range of time 0 ns to 255 ns in 1 ns steps
    constexpr int ns_per_bx = hcal::constants::nsPerBX;
    //Get the starting time
    int i_start = (-hcal::constants::iniTimeShift - pulseTime - slew > 0
                       ? 0
                       : (int)std::abs(-hcal::constants::iniTimeShift - pulseTime - slew) + 1);
    double offset_start = i_start - hcal::constants::iniTimeShift - pulseTime -
                          slew;  //-199-2*pars[0]-2.*slew (for pars[0] > 98.5) or just -98.5-pars[0]-slew;
    // zeroing output binned pulse shape
    ntmpbin.fill(0.0f);

    if (edm::isNotFinite(offset_start)) {  //Check for nan
      ++cntNANinfit;
    } else {
      if (offset_start == 1.0) {
        offset_start = 0.;
        i_start -= 1;
      }  //Deal with boundary

      const int bin_start = (int)offset_start;                                               //bin off to integer
      const int bin_0_start = (offset_start < bin_start + 0.5 ? bin_start - 1 : bin_start);  //Round it
      const int iTS_start = i_start / ns_per_bx;                                             //Time Slice for time shift
      const int distTo25ns_start = ns_per_bx - 1 - i_start % ns_per_bx;                      //Delta ns
      const double factor = offset_start - bin_0_start - 0.5;                                //Small correction?

      //Build the new pulse
      ntmpbin[iTS_start] =
          (bin_0_start == -1
               ?  // Initial bin (I'm assuming this is ok)
               accVarLenIdxMinusOneVec_[distTo25ns_start] + factor * diffVarItvlIdxMinusOneVec_[distTo25ns_start]
               : accVarLenIdxZEROVec_[distTo25ns_start] + factor * diffVarItvlIdxZEROVec_[distTo25ns_start]);
      //Fill the rest of the bins
      for (int iTS = iTS_start + 1; iTS < hcal::constants::maxSamples; ++iTS) {
        int bin_idx = distTo25ns_start + 1 + (iTS - iTS_start - 1) * ns_per_bx + bin_0_start;
        ntmpbin[iTS] = acc25nsVec_[bin_idx] + factor * diff25nsItvlVec_[bin_idx];
      }
      //Scale the pulse
      if (scalePulse) {
        for (int i = iTS_start; i < hcal::constants::maxSamples; ++i) {
          ntmpbin[i] *= pulseHeight;
        }
      }
    }

    return;
  }

  PulseShapeFunctor::~PulseShapeFunctor() {}

  void PulseShapeFunctor::EvalPulse(const float *pars) {
    int time = (pars[0] + timeShift_ - timeMean_) * hcal::constants::invertnsPerBx;
    float dummyPulseHeight = 0.f;
    funcShape(pulse_shape_, pars[0], dummyPulseHeight, psFit_slew[time], false);
    return;
  }

  double PulseShapeFunctor::EvalPulseM2(const double *pars, const unsigned nPars) {
    unsigned i = 0, j = 0;

    const double pedestal = pars[nPars - 1];

    //Stop crashes
    for (i = 0; i < nPars; ++i)
      if (edm::isNotFinite(pars[i])) {
        ++cntNANinfit;
        return 1e10;
      }

    //calculate chisquare
    double chisq = 0;
    const unsigned parBy2 = (nPars - 1) / 2;
    //      std::array<float,hcal::constants::maxSamples> pulse_shape_;

    if (addPulseJitter_) {
      int time = (pars[0] + timeShift_ - timeMean_) * hcal::constants::invertnsPerBx;
      //Interpolate the fit (Quickly)
      funcShape(pulse_shape_, pars[0], pars[1], psFit_slew[time], true);
      for (j = 0; j < nSamplesToFit_; ++j) {
        psFit_erry2[j] += pulse_shape_[j] * pulse_shape_[j] * pulseJitter_;
        pulse_shape_sum_[j] = pulse_shape_[j] + pedestal;
      }

      for (i = 1; i < parBy2; ++i) {
        time = (pars[i * 2] + timeShift_ - timeMean_) * hcal::constants::invertnsPerBx;
        //Interpolate the fit (Quickly)
        funcShape(pulse_shape_, pars[i * 2], pars[i * 2 + 1], psFit_slew[time], true);
        // add an uncertainty from the pulse (currently noise * pulse height =>Ecal uses full cov)
        for (j = 0; j < nSamplesToFit_; ++j) {
          psFit_erry2[j] += pulse_shape_[j] * pulse_shape_[j] * pulseJitter_;
          pulse_shape_sum_[j] += pulse_shape_[j];
        }
      }
    } else {
      int time = (pars[0] + timeShift_ - timeMean_) * hcal::constants::invertnsPerBx;
      //Interpolate the fit (Quickly)
      funcShape(pulse_shape_, pars[0], pars[1], psFit_slew[time], true);
      for (j = 0; j < nSamplesToFit_; ++j)
        pulse_shape_sum_[j] = pulse_shape_[j] + pedestal;

      for (i = 1; i < parBy2; ++i) {
        time = (pars[i * 2] + timeShift_ - timeMean_) * hcal::constants::invertnsPerBx;
        //Interpolate the fit (Quickly)
        funcShape(pulse_shape_, pars[i * 2], pars[i * 2 + 1], psFit_slew[time], true);
        // add an uncertainty from the pulse (currently noise * pulse height =>Ecal uses full cov)
        for (j = 0; j < nSamplesToFit_; ++j)
          pulse_shape_sum_[j] += pulse_shape_[j];
      }
    }

    for (i = 0; i < nSamplesToFit_; ++i) {
      const double d = psFit_y[i] - pulse_shape_sum_[i];
      chisq += d * d / psFit_erry2[i];
    }

    if (pedestalConstraint_) {
      //Add the pedestal Constraint to chi2
      chisq += invertpedSig2_ * (pedestal - pedMean_) * (pedestal - pedMean_);
    }
    //Add the time Constraint to chi2
    if (timeConstraint_) {
      for (j = 0; j < parBy2; ++j) {
        int time = (pars[j * 2] + timeShift_ - timeMean_) * (double)hcal::constants::invertnsPerBx;
        double time1 = -100. + time * hcal::constants::nsPerBX;
        chisq += inverttimeSig2_ * (pars[j * 2] - timeMean_ - time1) * (pars[j * 2] - timeMean_ - time1);
      }
    }
    return chisq;
  }
}  // namespace FitterFuncs