CalWire_module.cc

Go to the documentation of this file.

//
// CalWire class
//
// brebel@fnal.gov
//

// ROOT includes
#include <TComplex.h>
#include <TF1.h>
#include <TFile.h>
#include <TH1D.h>
#include <TH2D.h>

// Framework includes
#include "art/Framework/Core/EDProducer.h" // include the proper bit of the framework
#include "art/Framework/Core/ModuleMacros.h"
#include "art/Framework/Principal/Event.h"
#include "art/Framework/Principal/Handle.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "canvas/Persistency/Common/Assns.h"
#include "canvas/Persistency/Common/Ptr.h"
#include "cetlib/search_path.h"
#include "cetlib_except/exception.h"
#include "fhiclcpp/ParameterSet.h"
#include "messagefacility/MessageLogger/MessageLogger.h"

// LArSoft includes
#include "larcore/Geometry/WireReadout.h"
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "lardata/ArtDataHelper/WireCreator.h"
#include "lardata/Utilities/AssociationUtil.h"
#include "lardata/Utilities/LArFFT.h"
#include "lardataobj/RawData/RawDigit.h"
#include "lardataobj/RawData/raw.h"
#include "lardataobj/RecoBase/Wire.h"

namespace caldata {

  class CalWire : public art::EDProducer {
  public:
    // create calibrated signals on wires. this class runs an fft to remove the
    // electronics shaping.
    explicit CalWire(fhicl::ParameterSet const& pset);

  private:
    void produce(art::Event& evt) override;
    void beginJob() override;

    std::string fResponseFile;     
    int fExpEndBins;               
    int fPostsample;               
    std::string fDigitModuleLabel; 

    std::vector<std::vector<TComplex>> fKernelR; 
    std::vector<std::vector<TComplex>> fKernelS; 
    std::vector<double> fDecayConstsR;           
    std::vector<double> fDecayConstsS;           
    std::vector<int> fKernMapR;                  
    std::vector<int> fKernMapS;                  
  };                                             // class CalWire
}

namespace caldata {

  //-------------------------------------------------
  CalWire::CalWire(fhicl::ParameterSet const& pset) : EDProducer{pset}
  {
    fDigitModuleLabel = pset.get<std::string>("DigitModuleLabel", "daq");
    cet::search_path sp("FW_SEARCH_PATH");
    sp.find_file(pset.get<std::string>("ResponseFile"), fResponseFile);
    fExpEndBins = pset.get<int>("ExponentialEndBins");
    fPostsample = pset.get<int>("PostsampleBins");

    produces<std::vector<recob::Wire>>();
    produces<art::Assns<raw::RawDigit, recob::Wire>>();
  }

  //-------------------------------------------------
  void CalWire::beginJob()
  {
    MF_LOG_DEBUG("CalWire") << "CalWire_plugin: Opening  Electronics Response File: "
                            << fResponseFile.c_str();

    TFile f(fResponseFile.c_str());
    if (f.IsZombie())
      mf::LogWarning("CalWire") << "Cannot open response file " << fResponseFile.c_str();

    TH2D* respRe = dynamic_cast<TH2D*>(f.Get("real/RespRe"));
    TH2D* respIm = dynamic_cast<TH2D*>(f.Get("real/RespIm"));
    TH1D* decayHist = dynamic_cast<TH1D*>(f.Get("real/decayHist"));
    unsigned int wires = decayHist->GetNbinsX();
    unsigned int bins = respRe->GetYaxis()->GetNbins();
    unsigned int bin = 0;
    unsigned int wire = 0;
    fDecayConstsR.resize(wires);
    fKernMapR.resize(wires);
    fKernelR.resize(respRe->GetXaxis()->GetNbins());
    const TArrayD* edges = respRe->GetXaxis()->GetXbins();
    for (int i = 0; i < respRe->GetXaxis()->GetNbins(); ++i) {
      fKernelR[i].resize(bins);
      for (bin = 0; bin < bins; ++bin) {
        const TComplex a(respRe->GetBinContent(i + 1, bin + 1),
                         respIm->GetBinContent(i + 1, bin + 1));
        fKernelR[i][bin] = a;
      }
      for (; wire < (*edges)[i + 1]; ++wire) {
        fKernMapR[wire] = i;
        fDecayConstsR[wire] = decayHist->GetBinContent(wire + 1);
      }
    }
    respRe = dynamic_cast<TH2D*>(f.Get("sim/RespRe"));
    respIm = dynamic_cast<TH2D*>(f.Get("sim/RespIm"));
    decayHist = dynamic_cast<TH1D*>(f.Get("sim/decayHist"));
    wires = decayHist->GetNbinsX();
    bins = respRe->GetYaxis()->GetNbins();
    fDecayConstsS.resize(wires);
    fKernMapS.resize(wires);
    fKernelS.resize(respRe->GetXaxis()->GetNbins());
    const TArrayD* edges1 = respRe->GetXaxis()->GetXbins();
    wire = 0;
    for (int i = 0; i < respRe->GetXaxis()->GetNbins(); ++i) {
      fKernelS[i].resize(bins);
      for (bin = 0; bin < bins; ++bin) {
        const TComplex b(respRe->GetBinContent(i + 1, bin + 1),
                         respIm->GetBinContent(i + 1, bin + 1));
        fKernelS[i][bin] = b;
      }
      for (; wire < (*edges1)[i + 1]; ++wire) {
        fKernMapS[wire] = i;
        fDecayConstsS[wire] = decayHist->GetBinContent(wire + 1);
      }
    }

    f.Close();
  }

  void CalWire::produce(art::Event& evt)
  {
    art::ServiceHandle<geo::WireReadout const> geom;

    std::vector<double> decayConsts;
    std::vector<int> kernMap;
    std::vector<std::vector<TComplex>> kernel;
    //Put correct response functions and decay constants in place
    if (evt.isRealData()) {
      decayConsts = fDecayConstsR;
      kernMap = fKernMapR;
      kernel = fKernelR;
    }
    else {
      decayConsts = fDecayConstsS;
      kernMap = fKernMapS;
      kernel = fKernelS;
    }

    // get the FFT service to have access to the FFT size
    art::ServiceHandle<util::LArFFT> fFFT;

    // make a collection of Wires
    std::unique_ptr<std::vector<recob::Wire>> wirecol(new std::vector<recob::Wire>);
    // ... and an association set
    std::unique_ptr<art::Assns<raw::RawDigit, recob::Wire>> WireDigitAssn(
      new art::Assns<raw::RawDigit, recob::Wire>);

    // Read in the digit List object(s).
    art::Handle<std::vector<raw::RawDigit>> digitVecHandle;
    evt.getByLabel(fDigitModuleLabel, digitVecHandle);

    if (!digitVecHandle->size()) return;
    mf::LogInfo("CalWire") << "CalWire:: digitVecHandle size is " << digitVecHandle->size();

    // Use the handle to get a particular (0th) element of collection.
    art::Ptr<raw::RawDigit> digitVec0(digitVecHandle, 0);

    unsigned int dataSize = digitVec0->Samples(); //size of raw data vectors

    int transformSize = fFFT->FFTSize();
    raw::ChannelID_t channel(raw::InvalidChannelID); // channel number
    unsigned int bin(0);                             // time bin loop variable

    double decayConst = 0.;   // exponential decay constant of electronics shaping
    double fitAmplitude = 0.; //This is the seed value for the amplitude in the exponential tail fit
    std::vector<float> holder;                           // holds signal data
    std::vector<short> rawadc(transformSize);            // vector holding uncompressed adc values
    std::vector<TComplex> freqHolder(transformSize + 1); // temporary frequency data

    // loop over all wires
    for (unsigned int rdIter = 0; rdIter < digitVecHandle->size(); ++rdIter) { // ++ move
      holder.clear();

      art::Ptr<raw::RawDigit> digitVec(digitVecHandle, rdIter);
      channel = digitVec->Channel();

      holder.resize(transformSize);

      // uncompress the data
      raw::Uncompress(digitVec->ADCs(), rawadc, digitVec->Compression());

      for (bin = 0; bin < dataSize; ++bin)
        holder[bin] = (rawadc[bin] - digitVec->GetPedestal());
      // fExpEndBins only nonzero for detectors needing exponential tail fitting
      if (fExpEndBins && std::abs(decayConsts[channel]) > 0.0) {

        TH1D expTailData(
          "expTailData", "Tail data for fit", fExpEndBins, dataSize - fExpEndBins, dataSize);
        TF1 expFit("expFit", "[0]*exp([1]*x)");

        for (bin = 0; bin < (unsigned int)fExpEndBins; ++bin)
          expTailData.Fill(dataSize - fExpEndBins + bin, holder[dataSize - fExpEndBins + bin]);
        decayConst = decayConsts[channel];
        fitAmplitude = holder[dataSize - fExpEndBins] / exp(decayConst * (dataSize - fExpEndBins));
        expFit.FixParameter(1, decayConst);
        expFit.SetParameter(0, fitAmplitude);
        expTailData.Fit(&expFit, "QWN", "", dataSize - fExpEndBins, dataSize);
        expFit.SetRange(dataSize, transformSize);
        for (bin = 0; bin < dataSize; ++bin)
          holder[dataSize + bin] = expFit.Eval(bin + dataSize);
      }
      // This is actually deconvolution, by way of convolution with the inverted kernel.
      // This code assumes the response function has already been been transformed and
      // inverted.  This way a complex multiplication, rather than a complex division is
      // performed saving 2 multiplications and 2 divsions

      // the example below is for MicroBooNE, experiments should adapt as appropriate

      // Figure out which kernel to use (0=induction, 1=collection).
      geo::SigType_t sigtype = geom->Get().SignalType(channel);
      size_t k;
      if (sigtype == geo::kInduction)
        k = 0;
      else if (sigtype == geo::kCollection)
        k = 1;
      else
        throw cet::exception("CalWire") << "Bad signal type = " << sigtype << "\n";
      if (k >= kernel.size()) throw cet::exception("CalWire") << "kernel size < " << k << "!\n";

      fFFT->Convolute(holder, kernel[k]);

      holder.resize(dataSize, 1e-5);
      //This restores the DC component to signal removed by the deconvolution.
      if (fPostsample) {
        double average = 0.0;
        for (bin = 0; bin < (unsigned int)fPostsample; ++bin)
          average += holder[holder.size() - 1 - bin] / (double)fPostsample;
        for (bin = 0; bin < holder.size(); ++bin)
          holder[bin] -= average;
      }
      wirecol->push_back(recob::WireCreator(holder, *digitVec).move());
      // add an association between the last object in wirecol (that we just inserted) and
      // digitVec
      if (!util::CreateAssn(evt, *wirecol, digitVec, *WireDigitAssn)) {
        throw art::Exception(art::errors::ProductRegistrationFailure)
          << "Can't associate wire #" << (wirecol->size() - 1) << " with raw digit #"
          << digitVec.key();
      } // if failed to add association
    }   // for raw digits

    if (wirecol->empty()) mf::LogWarning("CalWire") << "No wires made for this event.";

    evt.put(std::move(wirecol));
    evt.put(std::move(WireDigitAssn));
  }

} // end namespace caldata

DEFINE_ART_MODULE(caldata::CalWire)