OpDigiProperties.h

Go to the documentation of this file.

// \file OpDigiProperties.h
//
// \brief service containing information about optical digitization
//
// \author bjpjones@mit.edu
// \author kazuhiro@nevis.columbia.edu
//

#ifndef OPDET_OPDIGIPROPERTIES_H
#define OPDET_OPDIGIPROPERTIES_H

// LArSoft includes
#include "lardataobj/OpticalDetectorData/OpticalTypes.h"

// ART includes
#include "art/Framework/Services/Registry/ServiceDeclarationMacros.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "fhiclcpp/fwd.h"

// ROOT includes
class TF1;

#include <string>
#include <vector>

namespace opdet {
  class OpDigiProperties {
  public:
    OpDigiProperties(fhicl::ParameterSet const& pset);

    double SampleFreq() const noexcept { return fSampleFreq; }
    double TimeBegin() const noexcept { return fTimeBegin; }
    double TimeEnd() const noexcept { return fTimeEnd; }

    std::vector<double> WaveformInit(std::string WaveformFile);

    optdata::TimeSlice_t GetTimeSlice(double time_ns);

    double QE() const noexcept { return fQE; }
    double DarkRate() const noexcept { return fDarkRate; }
    double PedFlucRate() const noexcept { return fPedFlucRate; }
    optdata::ADC_Count_t PedFlucAmp() const noexcept { return fPedFlucAmp; }
    optdata::ADC_Count_t SaturationScale() const noexcept { return fSaturationScale; }
    optdata::ADC_Count_t ADCBaseline() const noexcept { return fADCBaseline; }
    double WFTimeConstant() const noexcept { return fWFTimeConstant; }
    double WFPowerFactor() const noexcept { return fWFPowerFactor; }
    double LowGainMean() const noexcept { return fLowGainMean; }
    double HighGainMean() const noexcept { return fHighGainMean; }
    double LowGainMean(optdata::Channel_t ch) const;
    double HighGainMean(optdata::Channel_t ch) const;

    double GainSpread() const noexcept { return fGainSpread; }
    double GainSpread_PMT2PMT() const noexcept { return fGainSpread_PMT2PMT; }
    double LowGain(optdata::Channel_t ch) const;
    double HighGain(optdata::Channel_t ch) const;

    std::vector<double> const& SinglePEWaveform() const noexcept { return fWaveform; }
    std::vector<double> const& HighGainArray() const noexcept { return fHighGainArray; }
    std::vector<double> const& LowGainArray() const noexcept { return fLowGainArray; }
    std::vector<double> const& GainSpreadArray() const noexcept { return fGainSpreadArray; }
    std::vector<optdata::ADC_Count_t> const& PedMeanArray() const noexcept { return fPedMeanArray; }

    double GetSPEArea() const;
    double GetSPECumulativeArea() const;
    double GetSPEAmplitude() const;
    double GetSPECumulativeAmplitude() const;

  private:
    double fSampleFreq;
    double fTimeBegin;
    double fTimeEnd;
    double fPERescale;

    std::vector<double> GenEmpiricalWF(std::string WaveformFile);
    std::vector<double> GenAnalyticalWF();
    void GenerateWaveform();
    void FillGainArray();
    void FillPedMeanArray();

    bool fUseEmpiricalGain;
    bool fUseEmpiricalShape;
    double fQE;
    double fPedFlucRate;
    optdata::ADC_Count_t fPedFlucAmp;
    double fDarkRate;
    optdata::ADC_Count_t fSaturationScale;
    optdata::ADC_Count_t fADCBaseline;
    double fADCBaseSpread;
    double fLowGainMean;
    double fHighGainMean;
    double fVoltageAmpForSPE;
    double fWFTimeConstant;
    double fWFPowerFactor;
    double fWFLength;
    double fGainSpread;
    double fGainSpread_PMT2PMT;
    TF1* fAnalyticalSPE;

    std::string fHighGainFile;
    std::string fLowGainFile;
    std::string fWaveformFile;
    std::string fGainSpreadFile;
    std::vector<double> fWaveform;
    bool fChargeNormalized;
    std::vector<double> fLowGainArray;
    std::vector<double> fHighGainArray;
    std::vector<double> fGainSpreadArray;
    std::vector<optdata::ADC_Count_t> fPedMeanArray;
    unsigned int fNOpChannels;
  }; // class OpDigiProperties

} //namespace opdet

DECLARE_ART_SERVICE(opdet::OpDigiProperties, LEGACY)

#endif