DrawRawHist_tool.cc

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
/// \file   DrawRawHist_tool.cc
/// \author T. Usher
////////////////////////////////////////////////////////////////////////

#include "lareventdisplay/EventDisplay/ColorDrawingOptions.h"
#include "lareventdisplay/EventDisplay/RawDrawingOptions.h"
#include "lareventdisplay/EventDisplay/wfHitDrawers/IWaveformDrawer.h"
#include "larevt/CalibrationDBI/Interface/DetPedestalProvider.h"
#include "larevt/CalibrationDBI/Interface/DetPedestalService.h"
#include "larcore/Geometry/Geometry.h"
#include "lardataobj/RawData/RawDigit.h"
#include "lardataobj/RawData/raw.h"

#include "nuevdb/EventDisplayBase/EventHolder.h"

#include "art/Utilities/ToolMacros.h"
#include "art/Framework/Principal/Handle.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "messagefacility/MessageLogger/MessageLogger.h"

#include "TH1F.h"

namespace evdb_tool {

  class DrawRawHist : public IWaveformDrawer {
  public:
    explicit DrawRawHist(const fhicl::ParameterSet& pset);

    ~DrawRawHist();

    void configure(const fhicl::ParameterSet& pset) override;
    void Fill(evdb::View2D&, raw::ChannelID_t&, float, float) override;
    void Draw(const std::string&, float, float) override;

    float
    getMaximum() const override
    {
      return fMaximum;
    };
    float
    getMinimum() const override
    {
      return fMinimum;
    };

  private:
    void BookHistogram(raw::ChannelID_t&, float, float);

    float fMaximum;
    float fMinimum;

    std::unique_ptr<TH1F> fRawDigitHist;
  };

  //----------------------------------------------------------------------
  // Constructor.
  DrawRawHist::DrawRawHist(const fhicl::ParameterSet& pset) { configure(pset); }

  DrawRawHist::~DrawRawHist() {}

  void
  DrawRawHist::configure(const fhicl::ParameterSet& pset)
  {
    return;
  }

  void
  DrawRawHist::Fill(evdb::View2D& view2D, raw::ChannelID_t& channel, float lowBin, float numTicks)
  {
    art::ServiceHandle<evd::RawDrawingOptions const> rawOpt;

    //grab the singleton with the event
    const art::Event* event = evdb::EventHolder::Instance()->GetEvent();
    if (!event) return;

    // Handle histograms
    BookHistogram(channel, lowBin, numTicks);

    fMinimum = std::numeric_limits<float>::max();
    fMaximum = std::numeric_limits<float>::lowest();

    // Loop over the possible producers of RawDigits
    for (const auto& rawDataLabel : rawOpt->fRawDataLabels) {
      art::Handle<std::vector<raw::RawDigit>> rawDigitVecHandle;
      event->getByLabel(rawDataLabel, rawDigitVecHandle);

      if (!rawDigitVecHandle.isValid()) continue;

      for (size_t rawDigitIdx = 0; rawDigitIdx < rawDigitVecHandle->size(); rawDigitIdx++) {
        art::Ptr<raw::RawDigit> rawDigit(rawDigitVecHandle, rawDigitIdx);

        if (rawDigit->Channel() != channel) continue;

        // We will need the pedestal service...
        const lariov::DetPedestalProvider& pedestalRetrievalAlg =
          art::ServiceHandle<lariov::DetPedestalService const>()->GetPedestalProvider();

        // recover the pedestal
        float pedestal = 0;

        if (rawOpt->fPedestalOption == 0) { pedestal = pedestalRetrievalAlg.PedMean(channel); }
        else if (rawOpt->fPedestalOption == 1) {
          pedestal = rawDigit->GetPedestal();
        }
        else if (rawOpt->fPedestalOption == 2) {
          pedestal = 0;
        }
        else {
          mf::LogWarning("DrawRawHist")
            << " PedestalOption is not understood: " << rawOpt->fPedestalOption
            << ".  Pedestals not subtracted.";
        }

        std::vector<short> uncompressed(rawDigit->Samples());
        raw::Uncompress(rawDigit->ADCs(), uncompressed, rawDigit->Compression());

        TH1F* histPtr = fRawDigitHist.get();

        for (size_t idx = 0; idx < uncompressed.size(); idx++) {
          float signalVal = float(uncompressed[idx]) - pedestal;

          histPtr->Fill(float(idx) + 0.5, signalVal);
        }

        short minimumVal = *std::min_element(uncompressed.begin(), uncompressed.end());
        short maximumVal = *std::max_element(uncompressed.begin(), uncompressed.end());

        fMinimum = float(minimumVal) - pedestal;
        fMaximum = float(maximumVal) - pedestal;

        histPtr->SetLineColor(kBlack);

        // There is only one channel displayed so if here we are done
        break;
      }
    }

    return;
  }

  void
  DrawRawHist::Draw(const std::string& options, float maxLowVal, float maxHiVal)
  {
    TH1F* histPtr = fRawDigitHist.get();

    // Do we have valid limits to set?
    histPtr->SetMaximum(maxHiVal);
    histPtr->SetMinimum(maxLowVal);

    histPtr->Draw(options.c_str());

    return;
  }

  //......................................................................
  void
  DrawRawHist::BookHistogram(raw::ChannelID_t& channel, float startTick, float numTicks)
  {
    art::ServiceHandle<evd::ColorDrawingOptions const> cst;
    art::ServiceHandle<geo::Geometry const> geo;

    // Get rid of the previous histograms
    if (fRawDigitHist.get()) fRawDigitHist.reset();

    // figure out the signal type for this plane, assume that
    // plane n in each TPC/cryostat has the same type
    geo::SigType_t sigType = geo->SignalType(channel);
    int numBins = numTicks;

    fRawDigitHist = std::make_unique<TH1F>(
      "fRAWQHisto", ";t [ticks];q [ADC]", numBins, startTick, startTick + numTicks);

    TH1F* histPtr = fRawDigitHist.get();

    histPtr->SetMaximum(cst->fRawQHigh[(size_t)sigType]);
    histPtr->SetMinimum(cst->fRawQLow[(size_t)sigType]);

    histPtr->SetLineColor(kBlack);
    histPtr->SetLineWidth(1);

    histPtr->GetXaxis()->SetLabelSize(0.10);   // was 0.15
    histPtr->GetXaxis()->SetLabelOffset(0.01); // was 0.00
    histPtr->GetXaxis()->SetTitleSize(0.10);   // was 0.15
    histPtr->GetXaxis()->SetTitleOffset(0.60); // was 0.80

    histPtr->GetYaxis()->SetLabelSize(0.10);    // was 0.15
    histPtr->GetYaxis()->SetLabelOffset(0.002); // was 0.00
    histPtr->GetYaxis()->SetTitleSize(0.10);    // was 0.15
    histPtr->GetYaxis()->SetTitleOffset(0.16);  // was 0.80
  }

  DEFINE_ART_CLASS_TOOL(DrawRawHist)
}