opdet::OpDigiProperties Class Reference

#include "OpDigiProperties.h"

Public Member Functions
	OpDigiProperties (fhicl::ParameterSet const &pset)
double	SampleFreq () const noexcept
	Returns sample frequency in MHz. More...
double	TimeBegin () const noexcept
	Returns window start time in us ... with respect to MC photon T0. More...
double	TimeEnd () const noexcept
	Returns window end time in us ... with respect to MC photon T0. More...
std::vector< double >	WaveformInit (std::string WaveformFile)
optdata::TimeSlice_t	GetTimeSlice (double time_ns)
double	QE () const noexcept
	Returns quantum efficiency. More...
double	DarkRate () const noexcept
	Returns rate of dark noise. More...
double	PedFlucRate () const noexcept
	Returns rate of pedestal fluctuation. More...
optdata::ADC_Count_t	PedFlucAmp () const noexcept
	Returns amplitude of pedestal fluctuation. More...
optdata::ADC_Count_t	SaturationScale () const noexcept
	Returns the saturation scale of the electronics. More...
optdata::ADC_Count_t	ADCBaseline () const noexcept
	Returns the ADCBaseline set mean value. More...
double	WFTimeConstant () const noexcept
	Returns WF time constant used in analytical model. More...
double	WFPowerFactor () const noexcept
	Returns WF power factor used in analytical model. More...
double	LowGainMean () const noexcept
	Returns set mean gain value for LOW gain. More...
double	HighGainMean () const noexcept
	Returns set mean gain value for HIGH gain. More...
double	LowGainMean (optdata::Channel_t ch) const
	Returns generated LOW gain value for input channel (PMT-to-PMT spread applied) More...
double	HighGainMean (optdata::Channel_t ch) const
	Returns generated HIGH gain value for input channel (PMT-to-PMT spread applied) More...
double	GainSpread () const noexcept
	Returns set value for intrinsic gain spread (common to HIGH and LOW) More...
double	GainSpread_PMT2PMT () const noexcept
	Returns set value for PMT-to-PMT gain spread. More...
double	LowGain (optdata::Channel_t ch) const
	Generate & return LOW gain value for an input channel using mean & spread for this channel. More...
double	HighGain (optdata::Channel_t ch) const
	Generate & return HIGH gain value for an input channel using mean & spread for this channel. More...
std::vector< double > const &	SinglePEWaveform () const noexcept
	Returns a vector of double which represents a binned SPE waveform. More...
std::vector< double > const &	HighGainArray () const noexcept
	Returns an array of HIGH gain. More...
std::vector< double > const &	LowGainArray () const noexcept
	Returns an array of LOW gain. More...
std::vector< double > const &	GainSpreadArray () const noexcept
	Returns an array of gain spread. More...
std::vector< optdata::ADC_Count_t > const &	PedMeanArray () const noexcept
	Returns an array of generated pedestal mean value per channel. More...
double	GetSPEArea () const
	Utility functions. More...
double	GetSPECumulativeArea () const
double	GetSPEAmplitude () const
double	GetSPECumulativeAmplitude () const

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

Private Attributes
double	fSampleFreq
double	fTimeBegin
double	fTimeEnd
double	fPERescale
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

Detailed Description

Definition at line 29 of file OpDigiProperties.h.

Constructor & Destructor Documentation

opdet::OpDigiProperties::OpDigiProperties

(

fhicl::ParameterSet const &

pset

)

Definition at line 27 of file OpDigiProperties.cc.

References fADCBaseline, fADCBaseSpread, fChargeNormalized, fDarkRate, fGainSpread, fGainSpread_PMT2PMT, fGainSpreadFile, fHighGainArray, fHighGainFile, fHighGainMean, FillGainArray(), FillPedMeanArray(), fLowGainArray, fLowGainFile, fLowGainMean, fNOpChannels, fPedFlucAmp, fPedFlucRate, fPedMeanArray, fPERescale, fQE, fSampleFreq, fSaturationScale, fTimeBegin, fTimeEnd, fUseEmpiricalGain, fUseEmpiricalShape, fVoltageAmpForSPE, fWaveformFile, fWFLength, fWFPowerFactor, fWFTimeConstant, GenerateWaveform(), Get, and fhicl::ParameterSet::get().

                                                               : fAnalyticalSPE(0)
  {
    fSampleFreq = p.get<double>("SampleFreq");
    fTimeBegin = p.get<double>("TimeBegin");
    fTimeEnd = p.get<double>("TimeEnd");
    fWaveformFile = p.get<std::string>("WaveformFile");
    fPERescale = p.get<double>("PERescale");

    // PMT properties
    fQE = p.get<double>("QE");
    fDarkRate = p.get<double>("DarkRate");
    fSaturationScale = p.get<optdata::ADC_Count_t>("SaturationScale");

    // Shaper properties
    fUseEmpiricalGain = p.get<bool>("UseEmpiricalGain");
    fHighGainFile = p.get<std::string>("HighGainFile");
    fLowGainFile = p.get<std::string>("LowGainFile");
    fGainSpreadFile = p.get<std::string>("GainSpreadFile");

    fHighGainMean = p.get<double>("HighGainMean");
    fLowGainMean = p.get<double>("LowGainMean");
    fGainSpread = p.get<double>("GainSpread");
    fGainSpread_PMT2PMT = p.get<double>("GainSpread_PMT2PMT");

    // Digitization ped fluc
    fPedFlucRate = p.get<double>("PedFlucRate");
    fPedFlucAmp = p.get<optdata::ADC_Count_t>("PedFlucAmp");
    fADCBaseline = p.get<optdata::ADC_Count_t>("ADCBaseline");
    fADCBaseSpread = p.get<double>("ADCBaseSpread");

    // WF related stuff
    fUseEmpiricalShape = p.get<bool>("UseEmpiricalShape");
    fWFLength = p.get<double>("WFLength");

    fWaveformFile = p.get<std::string>("WaveformFile");
    fChargeNormalized = p.get<bool>("WaveformChargeNormalized", false);

    // Option 2: WF from analytical function
    fWFPowerFactor = p.get<double>("WFPowerFactor");
    fWFTimeConstant = p.get<double>("WFTimeConstant");
    fVoltageAmpForSPE = p.get<double>("VoltageAmpForSPE");

    fNOpChannels = art::ServiceHandle<geo::WireReadout const>()->Get().NOpChannels();

    // Generate the SPE waveform (i.e. fWaveform)
    GenerateWaveform();

    // Fill gain array
    FillGainArray();

    // Fill baseline mean
    FillPedMeanArray();

    art::ServiceHandle<geo::Geometry const>{}; // <- Ick.  Make sure Geometry is constructed first.
    // Report
    std::string msg(Form(
      "%-10s ... %-10s ... %-10s ... %-10s\n", "Ch. Number", "Pedestal", "High Gain", "Low Gain"));
    for (unsigned int i = 0; i < fNOpChannels; ++i) {
      msg += Form("%-10d ... %-10d ... %-10g ... %-10g\n",
                  i,
                  fPedMeanArray[i],
                  fHighGainArray[i],
                  fLowGainArray[i]);
    }
    mf::LogInfo(__FUNCTION__) << msg.c_str();
  }

Member Function Documentation

optdata::ADC_Count_t opdet::OpDigiProperties::ADCBaseline ( ) const

inlinenoexcept

Returns the ADCBaseline set mean value.

Definition at line 63 of file OpDigiProperties.h.

References fADCBaseline.

{ return fADCBaseline; }

double opdet::OpDigiProperties::DarkRate ( ) const

inlinenoexcept

Returns rate of dark noise.

Definition at line 55 of file OpDigiProperties.h.

References fDarkRate.

{ return fDarkRate; }

void opdet::OpDigiProperties::FillGainArray ( )

private

Definition at line 203 of file OpDigiProperties.cc.

References fGainSpread, fGainSpread_PMT2PMT, fGainSpreadArray, fGainSpreadFile, fHighGainArray, fHighGainFile, fHighGainMean, fLowGainArray, fLowGainFile, fLowGainMean, fNOpChannels, and fUseEmpiricalGain.

Referenced by OpDigiProperties().

  {
    if (fUseEmpiricalGain) {
      // Fill fron user's text files.
      mf::LogWarning("OpDigiProperties") << "Using empirical table of gain for each PMT...";
      std::string FullPath;
      cet::search_path sp("FW_SEARCH_PATH");

      if (!sp.find_file(fHighGainFile, FullPath))
        throw cet::exception("OpDigiProperties")
          << "Unable to find high gain spread file in " << sp.to_string() << "\n";

      mf::LogWarning("OpDigiProperties")
        << "OpDigiProperties opening high gain spread file at " << FullPath.c_str();
      std::ifstream HighGainFile(FullPath.c_str());
      if (HighGainFile.is_open()) {
        std::string line;
        while (HighGainFile.good()) {
          getline(HighGainFile, line);
          fHighGainArray.push_back(strtod(line.c_str(), NULL));
        }
      }
      else
        throw cet::exception("OpDigiProperties") << "Unable to open file!\n";

      FullPath = "";
      if (!sp.find_file(fLowGainFile, FullPath))
        throw cet::exception("OpDigiProperties")
          << "Unable to find low gain spread file in " << sp.to_string() << "\n";

      mf::LogWarning("OpDigiProperties")
        << "OpDigiProperties opening low gain spread file at " << FullPath.c_str();
      std::ifstream LowGainFile(FullPath.c_str());
      if (LowGainFile.is_open()) {
        std::string line;
        while (LowGainFile.good()) {
          getline(LowGainFile, line);
          fLowGainArray.push_back(strtod(line.c_str(), NULL));
        }
      }
      else
        throw cet::exception("OpDigiProperties") << "Unable to open file!\n";

      FullPath = "";
      if (!sp.find_file(fGainSpreadFile, FullPath))
        throw cet::exception("OpDigiProperties")
          << "Unable to find low gain spread file in " << sp.to_string() << "\n";

      mf::LogWarning("OpDigiProperties")
        << "OpDigiProperties opening low gain spread file at " << FullPath.c_str();
      std::ifstream GainSpreadFile(FullPath.c_str());
      if (GainSpreadFile.is_open()) {
        std::string line;
        while (GainSpreadFile.good()) {
          getline(GainSpreadFile, line);
          fGainSpreadArray.push_back(strtod(line.c_str(), NULL));
        }
      }
      else
        throw cet::exception("OpDigiProperties") << "Unable to open file!\n";
    }
    else {
      // Generate a set of gake gain mean & spread.
      std::string txt;
      txt += "    Generating gain for each pmt.\n";
      txt += Form("        High gain mean: %g ADC/p.e.\n", fHighGainMean);
      txt += Form("        Low  gain mean: %g ADC/p.e.\n", fLowGainMean);
      txt += Form("        PMT-to-PMT gain spread : %g \n", fGainSpread_PMT2PMT);
      txt += Form("        Intrinsic gain spread  : %g \n", fGainSpread);
      mf::LogWarning("OpDigiProperties") << txt.c_str();
      for (unsigned int i = 0; i < fNOpChannels; ++i) {
        fLowGainArray.push_back(
          CLHEP::RandGauss::shoot(fLowGainMean, fLowGainMean * fGainSpread_PMT2PMT));
        fHighGainArray.push_back(
          CLHEP::RandGauss::shoot(fHighGainMean, fHighGainMean * fGainSpread_PMT2PMT));
        fGainSpreadArray.push_back(fGainSpread);
      }
    }

    //
    // Note:
    // Check for # entries. These exceptions ensures we have enough # of elements.
    // When a user access the elements by a channel number using LowGainMean(Channel_t ch) etc.,
    // those functions do not check if the given channel number is valid or not to keep a high
    // performance of the code. If there's an invalid memory access error in run-time, then
    // it must mean the user provided an invalid channel number and not due to insufficient
    // vector elements filled in this function.
    //
    if (fLowGainArray.size() < fNOpChannels)
      throw cet::exception("OpDigiProperties") << "Low gain missing for some channels!\n";
    if (fHighGainArray.size() < fNOpChannels)
      throw cet::exception("OpDigiProperties") << "High gain missing for some channels!\n";
    if (fGainSpreadArray.size() < fNOpChannels)
      throw cet::exception("OpDigiProperties") << "Gain spread missing for some channels!\n";
  }

void opdet::OpDigiProperties::FillPedMeanArray ( )

private

Definition at line 195 of file OpDigiProperties.cc.

References fADCBaseline, fADCBaseSpread, fNOpChannels, and fPedMeanArray.

Referenced by OpDigiProperties().

  {
    for (unsigned int i = 0; i < fNOpChannels; ++i)
      fPedMeanArray.push_back((optdata::ADC_Count_t)(
        CLHEP::RandGauss::shoot((double)fADCBaseline, fADCBaseSpread) + 0.5));
  }

double opdet::OpDigiProperties::GainSpread ( ) const

inlinenoexcept

Returns set value for intrinsic gain spread (common to HIGH and LOW)

Definition at line 78 of file OpDigiProperties.h.

References fGainSpread.

{ return fGainSpread; }

double opdet::OpDigiProperties::GainSpread_PMT2PMT ( ) const

inlinenoexcept

Returns set value for PMT-to-PMT gain spread.

Definition at line 80 of file OpDigiProperties.h.

References fGainSpread_PMT2PMT, HighGain(), and LowGain().

{ return fGainSpread_PMT2PMT; }

std::vector<double> const& opdet::OpDigiProperties::GainSpreadArray ( ) const

inlinenoexcept

Returns an array of gain spread.

Definition at line 93 of file OpDigiProperties.h.

References fGainSpreadArray.

{ return fGainSpreadArray; }

std::vector< double > opdet::OpDigiProperties::GenAnalyticalWF ( )

private

Definition at line 358 of file OpDigiProperties.cc.

References e, fAnalyticalSPE, fChargeNormalized, fSampleFreq, fVoltageAmpForSPE, fWFLength, fWFPowerFactor, and fWFTimeConstant.

Referenced by GenerateWaveform().

  {
    mf::LogWarning("OpDigiProperties")
      << "    OpDigiProperties using analytical function for WF generation.";
    //
    // Generate waveform from analytical form
    //
    if (!fAnalyticalSPE) { // Create analytical function if not yet created
      fAnalyticalSPE = new TF1("_analyticalSPE",
                               "10^(22)*x^[1]*[0]*exp(-x/[2])/TMath::Factorial([1])",
                               0,
                               fWFLength * 2);            // x is time in micro-seconds
      fAnalyticalSPE->SetParameter(0, fVoltageAmpForSPE); // voltage amplitude for s.p.e.
      fAnalyticalSPE->SetParameter(1, fWFPowerFactor);    // power factor (no unit)
      fAnalyticalSPE->SetParameter(2, fWFTimeConstant);   // time constant in us
    }
    //
    // Define a waveform vector
    //
    // Size of WF = time width [us] * frequency [MHz]
    std::vector<double> PEWaveform(int(fWFLength * fSampleFreq), 0.0);
    double SamplingDuration = 1. / fSampleFreq; // in micro seconds
    double MaxAmp = 0;
    double Charge = 0;
    for (unsigned short i = 0; i < PEWaveform.size(); ++i) {
      double Value = fAnalyticalSPE->Integral(i * SamplingDuration, (i + 1) * SamplingDuration) /
                     SamplingDuration;
      PEWaveform[i] = Value;
      if (PEWaveform[i] > MaxAmp) MaxAmp = PEWaveform[i];
      Charge += Value;
    }

    // rescale
    if (MaxAmp <= 0) throw cet::exception("OpDigiProperties_module") << "Waveform amplitude <=0!\n";

    if (!fChargeNormalized) {
      for (unsigned short i = 0; i < PEWaveform.size(); i++) {
        PEWaveform[i] = PEWaveform[i] / MaxAmp;
        if (PEWaveform[i] < 1.e-4) PEWaveform[i] = 0;
      }
    }
    else
      for (unsigned short i = 0; i < PEWaveform.size(); i++) {
        PEWaveform[i] = PEWaveform[i] / Charge;
      }

    return PEWaveform;
  }

std::vector< double > opdet::OpDigiProperties::GenEmpiricalWF ( std::string  WaveformFile )

private

Definition at line 316 of file OpDigiProperties.cc.

References fChargeNormalized, fSampleFreq, and fWFLength.

Referenced by GenerateWaveform().

  {
    // Read in waveform vector from text file
    std::ifstream WaveformFile(fWaveformFile.c_str());
    std::string line;

    mf::LogWarning("OpDigiProperties")
      << "OpDigiProperties opening OpDet waveform at " << fWaveformFile.c_str();

    // Read in each line and place into waveform vector
    std::vector<double> PEWaveform;
    if (WaveformFile.is_open()) {
      double MaxAmp = 0;
      double Charge = 0;
      int NSample = 0;
      while (WaveformFile.good() && NSample < int(fWFLength * fSampleFreq)) {
        getline(WaveformFile, line);
        double Amp = strtod(line.c_str(), NULL);
        PEWaveform.push_back(Amp);
        if (Amp > MaxAmp) MaxAmp = Amp;
        NSample++;
        Charge += Amp;
      }
      // rescale
      if (MaxAmp <= 0)
        throw cet::exception("OpDigiProperties_module") << "Waveform amplitude <=0!\n";
      if (!fChargeNormalized)
        for (unsigned short i = 0; i < PEWaveform.size(); i++) {
          PEWaveform[i] = PEWaveform[i] / MaxAmp;
        }
      else
        for (unsigned short i = 0; i < PEWaveform.size(); i++) {
          PEWaveform[i] = PEWaveform[i] / Charge;
        }
    }
    else
      throw cet::exception("No Waveform File") << "Unable to open file\n";

    WaveformFile.close();
    return (PEWaveform);
  }

void opdet::OpDigiProperties::GenerateWaveform ( )

private

Definition at line 299 of file OpDigiProperties.cc.

References fUseEmpiricalShape, fWaveform, fWaveformFile, GenAnalyticalWF(), and GenEmpiricalWF().

Referenced by OpDigiProperties().

  {
    std::string FullPath;

    if (fUseEmpiricalShape) {
      cet::search_path sp("FW_SEARCH_PATH");
      if (!sp.find_file(fWaveformFile, FullPath))

        throw cet::exception("OpDigiProperties")
          << "Unable to find PMT waveform file in " << sp.to_string() << "\n";

      fWaveform = GenEmpiricalWF(FullPath);
    }
    else
      fWaveform = GenAnalyticalWF();
  }

double opdet::OpDigiProperties::GetSPEAmplitude

(

)

const

Definition at line 104 of file OpDigiProperties.cc.

References fWaveform.

Referenced by PedMeanArray().

  {
    double AmpSoFar = 0;
    for (size_t i = 0; i != fWaveform.size(); ++i)
      if (fWaveform.at(i) > AmpSoFar) AmpSoFar = fWaveform.at(i);
    return AmpSoFar;
  }

double opdet::OpDigiProperties::GetSPEArea

(

)

const

Utility functions.

Definition at line 95 of file OpDigiProperties.cc.

References fWaveform.

Referenced by PedMeanArray().

  {
    double SPEArea = 0;
    for (size_t i = 0; i != fWaveform.size(); ++i)
      SPEArea += fWaveform.at(i);
    return SPEArea;
  }

double opdet::OpDigiProperties::GetSPECumulativeAmplitude

(

)

const

Definition at line 124 of file OpDigiProperties.cc.

References fWaveform.

Referenced by PedMeanArray().

  {
    double AmpSoFar = 0, Cumulative = 0;
    for (size_t i = 0; i != fWaveform.size(); ++i) {
      Cumulative += fWaveform.at(i);
      if (Cumulative > AmpSoFar) AmpSoFar = Cumulative;
    }
    return AmpSoFar;
  }

double opdet::OpDigiProperties::GetSPECumulativeArea

(

)

const

Definition at line 113 of file OpDigiProperties.cc.

References fWaveform.

Referenced by PedMeanArray().

  {
    double Cumulative = 0, SPEArea = 0;
    for (size_t i = 0; i != fWaveform.size(); ++i) {
      Cumulative += fWaveform.at(i);
      SPEArea += Cumulative;
    }
    return SPEArea;
  }

optdata::TimeSlice_t opdet::OpDigiProperties::GetTimeSlice

(

double

time_ns

)

Convert the given time into time-slice number. Input time should be in ns unit and measurd w.r.t. MC photon T0

Definition at line 157 of file OpDigiProperties.cc.

References fSampleFreq, fTimeBegin, and fTimeEnd.

Referenced by TimeEnd().

  {
    if (time_ns / 1.e3 > (fTimeEnd - fTimeBegin))
      return std::numeric_limits<optdata::TimeSlice_t>::max();

    else
      return optdata::TimeSlice_t((time_ns / 1.e3 - fTimeBegin) * fSampleFreq);
  }

double opdet::OpDigiProperties::HighGain

(

optdata::Channel_t

ch

)

const

Generate & return HIGH gain value for an input channel using mean & spread for this channel.

Definition at line 152 of file OpDigiProperties.cc.

References fGainSpreadArray, and fHighGainArray.

Referenced by GainSpread_PMT2PMT().

  {
    return CLHEP::RandGauss::shoot(fHighGainArray[ch], fGainSpreadArray[ch] * fHighGainArray[ch]);
  }

std::vector<double> const& opdet::OpDigiProperties::HighGainArray ( ) const

inlinenoexcept

Returns an array of HIGH gain.

Definition at line 89 of file OpDigiProperties.h.

References fHighGainArray.

{ return fHighGainArray; }

double opdet::OpDigiProperties::HighGainMean ( ) const

inlinenoexcept

Returns set mean gain value for HIGH gain.

Definition at line 71 of file OpDigiProperties.h.

References fHighGainMean, and LowGainMean().

{ return fHighGainMean; }

double opdet::OpDigiProperties::HighGainMean

(

optdata::Channel_t

ch

)

const

Returns generated HIGH gain value for input channel (PMT-to-PMT spread applied)

Definition at line 142 of file OpDigiProperties.cc.

References fHighGainArray.

  {
    return fHighGainArray[ch];
  }

double opdet::OpDigiProperties::LowGain

(

optdata::Channel_t

ch

)

const

Generate & return LOW gain value for an input channel using mean & spread for this channel.

Definition at line 147 of file OpDigiProperties.cc.

References fGainSpreadArray, and fLowGainArray.

Referenced by GainSpread_PMT2PMT().

  {
    return CLHEP::RandGauss::shoot(fLowGainArray[ch], fGainSpreadArray[ch] * fLowGainArray[ch]);
  }

std::vector<double> const& opdet::OpDigiProperties::LowGainArray ( ) const

inlinenoexcept

Returns an array of LOW gain.

Definition at line 91 of file OpDigiProperties.h.

References fLowGainArray.

{ return fLowGainArray; }

double opdet::OpDigiProperties::LowGainMean ( ) const

inlinenoexcept

Returns set mean gain value for LOW gain.

Definition at line 69 of file OpDigiProperties.h.

References fLowGainMean.

Referenced by HighGainMean().

{ return fLowGainMean; }

double opdet::OpDigiProperties::LowGainMean

(

optdata::Channel_t

ch

)

const

Returns generated LOW gain value for input channel (PMT-to-PMT spread applied)

Definition at line 136 of file OpDigiProperties.cc.

References fLowGainArray.

  {
    return fLowGainArray[ch];
  }

optdata::ADC_Count_t opdet::OpDigiProperties::PedFlucAmp ( ) const

inlinenoexcept

Returns amplitude of pedestal fluctuation.

Definition at line 59 of file OpDigiProperties.h.

References fPedFlucAmp.

{ return fPedFlucAmp; }

double opdet::OpDigiProperties::PedFlucRate ( ) const

inlinenoexcept

Returns rate of pedestal fluctuation.

Definition at line 57 of file OpDigiProperties.h.

References fPedFlucRate.

{ return fPedFlucRate; }

std::vector<optdata::ADC_Count_t> const& opdet::OpDigiProperties::PedMeanArray ( ) const

inlinenoexcept

Returns an array of generated pedestal mean value per channel.

Definition at line 95 of file OpDigiProperties.h.

References fPedMeanArray, GetSPEAmplitude(), GetSPEArea(), GetSPECumulativeAmplitude(), and GetSPECumulativeArea().

{ return fPedMeanArray; }

double opdet::OpDigiProperties::QE ( ) const

inlinenoexcept

Returns quantum efficiency.

Definition at line 53 of file OpDigiProperties.h.

References fQE.

Referenced by opdet::FlashHypothesisCreator::CreateFlashHypothesesFromSegment(), cosmic::BeamFlashTrackMatchTaggerAlg::GetMIPHypotheses(), and opdet::SimPhotonCounterAlg::InitializeCounters().

{ return fQE; }

double opdet::OpDigiProperties::SampleFreq ( ) const

inlinenoexcept

Returns sample frequency in MHz.

Definition at line 34 of file OpDigiProperties.h.

References fSampleFreq.

{ return fSampleFreq; }

optdata::ADC_Count_t opdet::OpDigiProperties::SaturationScale ( ) const

inlinenoexcept

Returns the saturation scale of the electronics.

Definition at line 61 of file OpDigiProperties.h.

References fSaturationScale.

{ return fSaturationScale; }

std::vector<double> const& opdet::OpDigiProperties::SinglePEWaveform ( ) const

inlinenoexcept

Returns a vector of double which represents a binned SPE waveform.

Definition at line 87 of file OpDigiProperties.h.

References fWaveform.

{ return fWaveform; }

double opdet::OpDigiProperties::TimeBegin ( ) const

inlinenoexcept

Returns window start time in us ... with respect to MC photon T0.

Definition at line 36 of file OpDigiProperties.h.

References fTimeBegin.

{ return fTimeBegin; }

double opdet::OpDigiProperties::TimeEnd ( ) const

inlinenoexcept

Returns window end time in us ... with respect to MC photon T0.

Definition at line 38 of file OpDigiProperties.h.

References fTimeEnd, GetTimeSlice(), and WaveformInit().

{ return fTimeEnd; }

std::vector< double > opdet::OpDigiProperties::WaveformInit

(

std::string

WaveformFile

)

DEPRECATED as far as Kazu is concerned for UBooNE PMT simulation. Any comment? –Kazu 08/05/2013

Definition at line 170 of file OpDigiProperties.cc.

References fPERescale.

Referenced by TimeEnd().

  {
    // Read in waveform vector from text file
    std::ifstream WaveformFile(fWaveformFile.c_str());
    std::string line;

    mf::LogInfo("OpDigiProperties")
      << "OpDigiProperties opening OpDet waveform at " << fWaveformFile.c_str();

    // Read in each line and place into waveform vector
    std::vector<double> PEWaveform;
    if (WaveformFile.is_open()) {
      while (WaveformFile.good()) {
        getline(WaveformFile, line);
        PEWaveform.push_back(fPERescale * strtod(line.c_str(), NULL));
      }
    }
    else
      throw cet::exception("OpDigiProperties") << "No Waveform File: Unable to open file\n";

    WaveformFile.close();
    return (PEWaveform);
  }

double opdet::OpDigiProperties::WFPowerFactor ( ) const

inlinenoexcept

Returns WF power factor used in analytical model.

Definition at line 67 of file OpDigiProperties.h.

References fWFPowerFactor.

{ return fWFPowerFactor; }

double opdet::OpDigiProperties::WFTimeConstant ( ) const

inlinenoexcept

Returns WF time constant used in analytical model.

Definition at line 65 of file OpDigiProperties.h.

References fWFTimeConstant.

{ return fWFTimeConstant; }

Member Data Documentation

optdata::ADC_Count_t opdet::OpDigiProperties::fADCBaseline

private

Definition at line 122 of file OpDigiProperties.h.

Referenced by ADCBaseline(), FillPedMeanArray(), and OpDigiProperties().

double opdet::OpDigiProperties::fADCBaseSpread

private

Definition at line 123 of file OpDigiProperties.h.

Referenced by FillPedMeanArray(), and OpDigiProperties().

TF1* opdet::OpDigiProperties::fAnalyticalSPE

private

Definition at line 132 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF().

bool opdet::OpDigiProperties::fChargeNormalized

private

Definition at line 139 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), GenEmpiricalWF(), and OpDigiProperties().

double opdet::OpDigiProperties::fDarkRate

private

Definition at line 120 of file OpDigiProperties.h.

Referenced by DarkRate(), and OpDigiProperties().

double opdet::OpDigiProperties::fGainSpread

private

Definition at line 130 of file OpDigiProperties.h.

Referenced by FillGainArray(), GainSpread(), and OpDigiProperties().

double opdet::OpDigiProperties::fGainSpread_PMT2PMT

private

Definition at line 131 of file OpDigiProperties.h.

Referenced by FillGainArray(), GainSpread_PMT2PMT(), and OpDigiProperties().

std::vector<double> opdet::OpDigiProperties::fGainSpreadArray

private

Definition at line 142 of file OpDigiProperties.h.

Referenced by FillGainArray(), GainSpreadArray(), HighGain(), and LowGain().

std::string opdet::OpDigiProperties::fGainSpreadFile

private

Definition at line 137 of file OpDigiProperties.h.

Referenced by FillGainArray(), and OpDigiProperties().

std::vector<double> opdet::OpDigiProperties::fHighGainArray

private

Definition at line 141 of file OpDigiProperties.h.

Referenced by FillGainArray(), HighGain(), HighGainArray(), HighGainMean(), and OpDigiProperties().

std::string opdet::OpDigiProperties::fHighGainFile

private

Definition at line 134 of file OpDigiProperties.h.

Referenced by FillGainArray(), and OpDigiProperties().

double opdet::OpDigiProperties::fHighGainMean

private

Definition at line 125 of file OpDigiProperties.h.

Referenced by FillGainArray(), HighGainMean(), and OpDigiProperties().

std::vector<double> opdet::OpDigiProperties::fLowGainArray

private

Definition at line 140 of file OpDigiProperties.h.

Referenced by FillGainArray(), LowGain(), LowGainArray(), LowGainMean(), and OpDigiProperties().

std::string opdet::OpDigiProperties::fLowGainFile

private

Definition at line 135 of file OpDigiProperties.h.

Referenced by FillGainArray(), and OpDigiProperties().

double opdet::OpDigiProperties::fLowGainMean

private

Definition at line 124 of file OpDigiProperties.h.

Referenced by FillGainArray(), LowGainMean(), and OpDigiProperties().

unsigned int opdet::OpDigiProperties::fNOpChannels

private

Definition at line 144 of file OpDigiProperties.h.

Referenced by FillGainArray(), FillPedMeanArray(), and OpDigiProperties().

optdata::ADC_Count_t opdet::OpDigiProperties::fPedFlucAmp

private

Definition at line 119 of file OpDigiProperties.h.

Referenced by OpDigiProperties(), and PedFlucAmp().

double opdet::OpDigiProperties::fPedFlucRate

private

Definition at line 118 of file OpDigiProperties.h.

Referenced by OpDigiProperties(), and PedFlucRate().

std::vector<optdata::ADC_Count_t> opdet::OpDigiProperties::fPedMeanArray

private

Definition at line 143 of file OpDigiProperties.h.

Referenced by FillPedMeanArray(), OpDigiProperties(), and PedMeanArray().

double opdet::OpDigiProperties::fPERescale

private

Definition at line 107 of file OpDigiProperties.h.

Referenced by OpDigiProperties(), and WaveformInit().

double opdet::OpDigiProperties::fQE

private

Definition at line 117 of file OpDigiProperties.h.

Referenced by OpDigiProperties(), and QE().

double opdet::OpDigiProperties::fSampleFreq

private

Definition at line 104 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), GenEmpiricalWF(), GetTimeSlice(), OpDigiProperties(), and SampleFreq().

optdata::ADC_Count_t opdet::OpDigiProperties::fSaturationScale

private

Definition at line 121 of file OpDigiProperties.h.

Referenced by OpDigiProperties(), and SaturationScale().

double opdet::OpDigiProperties::fTimeBegin

private

Definition at line 105 of file OpDigiProperties.h.

Referenced by GetTimeSlice(), OpDigiProperties(), and TimeBegin().

double opdet::OpDigiProperties::fTimeEnd

private

Definition at line 106 of file OpDigiProperties.h.

Referenced by GetTimeSlice(), OpDigiProperties(), and TimeEnd().

bool opdet::OpDigiProperties::fUseEmpiricalGain

private

Definition at line 115 of file OpDigiProperties.h.

Referenced by FillGainArray(), and OpDigiProperties().

bool opdet::OpDigiProperties::fUseEmpiricalShape

private

Definition at line 116 of file OpDigiProperties.h.

Referenced by GenerateWaveform(), and OpDigiProperties().

double opdet::OpDigiProperties::fVoltageAmpForSPE

private

Definition at line 126 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), and OpDigiProperties().

std::vector<double> opdet::OpDigiProperties::fWaveform

private

Definition at line 138 of file OpDigiProperties.h.

Referenced by GenerateWaveform(), GetSPEAmplitude(), GetSPEArea(), GetSPECumulativeAmplitude(), GetSPECumulativeArea(), and SinglePEWaveform().

std::string opdet::OpDigiProperties::fWaveformFile

private

Definition at line 136 of file OpDigiProperties.h.

Referenced by GenerateWaveform(), and OpDigiProperties().

double opdet::OpDigiProperties::fWFLength

private

Definition at line 129 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), GenEmpiricalWF(), and OpDigiProperties().

double opdet::OpDigiProperties::fWFPowerFactor

private

Definition at line 128 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), OpDigiProperties(), and WFPowerFactor().

double opdet::OpDigiProperties::fWFTimeConstant

private

Definition at line 127 of file OpDigiProperties.h.

Referenced by GenAnalyticalWF(), OpDigiProperties(), and WFTimeConstant().

---

The documentation for this class was generated from the following files:

• larana/v10_00_11/source/larana/OpticalDetector/OpDigiProperties.h
• larana/v10_00_11/source/larana/OpticalDetector/OpDigiProperties.cc