sbn::OpDetWaveformMetaMaker Class Reference

Converter from raw::OpDetWaveform into sbn::OpDetWaveformMeta. More...

#include <OpDetWaveformMetaUtils.h>

Public Types
using	microseconds = util::quantities::intervals::microseconds

Public Member Functions
	OpDetWaveformMetaMaker (detinfo::DetectorTimings const &detTimings)
	OpDetWaveformMetaMaker (microseconds opDetTickPeriod)
sbn::OpDetWaveformMeta	make (raw::OpDetWaveform const &waveform) const
	Creates a sbn::OpDetWaveformMeta out of the specified waveform. More...
sbn::OpDetWaveformMeta	operator() (raw::OpDetWaveform const &waveform) const

Private Types
using	electronics_time = detinfo::timescales::electronics_time

Private Attributes
microseconds	fOpDetTickPeriod
	The duration of a optical detector tick. More...
std::optional< electronics_time >	fTriggerTime
	Cached trigger time. More...
std::optional< electronics_time >	fBeamGateTime
	Cached beam gate time. More...

Detailed Description

Converter from raw::OpDetWaveform into sbn::OpDetWaveformMeta.

An object of this class is initialized once with some timings (e.g. once per event), used to make() multiple sbn::OpDetWaveformMeta and then discarded:

detinfo::DetectorTimings const detTimings = detinfo::makeDetectorTimings
  (art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(event));

std::vector<sbn::OpDetWaveformMeta> PMTinfo;
for (raw::OpDetWaveform const& waveform: waveforms)
  PMTinfo.push_back(makeOpDetWaveformMeta(waveform));

It supports a scenario where times (trigger and beam gate) are not available or not relevant, in which case only the duration in time of a optical detector waveform tick is needed.

Definition at line 123 of file OpDetWaveformMetaUtils.h.

Member Typedef Documentation

using sbn::OpDetWaveformMetaMaker::electronics_time = detinfo::timescales::electronics_time

private

Definition at line 147 of file OpDetWaveformMetaUtils.h.

using sbn::OpDetWaveformMetaMaker::microseconds = util::quantities::intervals::microseconds

Definition at line 127 of file OpDetWaveformMetaUtils.h.

Constructor & Destructor Documentation

sbn::OpDetWaveformMetaMaker::OpDetWaveformMetaMaker

(

detinfo::DetectorTimings const &

detTimings

)

Constructor: allows creation of sbn::OpDetWaveformMeta with full information.

Definition at line 22 of file OpDetWaveformMetaUtils.cxx.

  : fOpDetTickPeriod{ detTimings.OpticalClockPeriod() }
  , fTriggerTime{ detTimings.TriggerTime() }
  , fBeamGateTime{ detTimings.BeamGateTime() }
  {}

sbn::OpDetWaveformMetaMaker::OpDetWaveformMetaMaker

(

microseconds

opDetTickPeriod

)

Constructor: allows creation of sbn::OpDetWaveformMeta with no trigger/beam time information.

Definition at line 30 of file OpDetWaveformMetaUtils.cxx.

  : fOpDetTickPeriod{ opDetTickPeriod }
  {}

Member Function Documentation

sbn::OpDetWaveformMeta sbn::OpDetWaveformMetaMaker::make

(

raw::OpDetWaveform const &

waveform

)

const

Creates a sbn::OpDetWaveformMeta out of the specified waveform.

Definition at line 37 of file OpDetWaveformMetaUtils.cxx.

{
  
  using detinfo::timescales::electronics_time;
  
  raw::Channel_t const channel = waveform.ChannelNumber();
  std::size_t const nSamples = waveform.Waveform().size();
  electronics_time const startTime { waveform.TimeStamp() };
  electronics_time const endTime
    = startTime + waveform.Waveform().size() * fOpDetTickPeriod;
  
  sbn::OpDetWaveformMeta info {
      channel                   // channel
    , nSamples                  // nSamples
    , startTime.value()         // startTime
    , endTime.value()           // endTime
    /* the following are left default:
    // flags
    */
    };
  
  auto const setFlag = [&info]
    (sbn::OpDetWaveformMeta::Flags_t::Flag_t flag, bool value)
    { if (value) info.flags.set(flag); else info.flags.unset(flag); };
  
  auto const isInWaveform = [startTime,endTime](electronics_time t)
    { return (t >= startTime) && (t < endTime); };
  
  if (fTriggerTime) {
    setFlag
      (sbn::OpDetWaveformMeta::bits::WithTrigger, isInWaveform(*fTriggerTime));
  }
  
  if (fBeamGateTime) {
    setFlag
      (sbn::OpDetWaveformMeta::bits::WithBeamGate, isInWaveform(*fBeamGateTime));
  }
  
  return info;
  
} // sbn::OpDetWaveformMetaMaker::make()

sbn::OpDetWaveformMeta sbn::OpDetWaveformMetaMaker::operator() ( raw::OpDetWaveform const &  waveform ) const

inline

Definition at line 141 of file OpDetWaveformMetaUtils.h.

    { return make(waveform); }

Member Data Documentation

std::optional<electronics_time> sbn::OpDetWaveformMetaMaker::fBeamGateTime

private

Cached beam gate time.

Definition at line 152 of file OpDetWaveformMetaUtils.h.

microseconds sbn::OpDetWaveformMetaMaker::fOpDetTickPeriod

private

The duration of a optical detector tick.

Definition at line 149 of file OpDetWaveformMetaUtils.h.

std::optional<electronics_time> sbn::OpDetWaveformMetaMaker::fTriggerTime

private

Cached trigger time.

Definition at line 151 of file OpDetWaveformMetaUtils.h.

---

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

• OpDetWaveformMetaUtils.h
• OpDetWaveformMetaUtils.cxx