Extracts and saves the time coverage of optical detector waveforms. More...

Inheritance diagram for icarus::trigger::OpDetWaveformMetaMaker:

Classes
struct	Config

Public Types
using	Parameters = art::SharedProducer::Table< Config >

Public Member Functions
	OpDetWaveformMetaMaker (Parameters const &config, art::ProcessingFrame const &)

virtual void	produce (art::Event &event, art::ProcessingFrame const &) override
	Fills the plots. Also extracts the information to fill them with. More...

Private Attributes
art::InputTag const	fWaveformTag
	Input waveforms. More...

std::string const	fLogCategory
	Message facility stream category for output. More...

Detailed Description

Extracts and saves the time coverage of optical detector waveforms.

This module writes a list of sbn::OpDetWaveformMeta objects matching the information of each optical detector waveform.

It may be used as input to modules which require all the information of a PMT waveform except the actual content of the waveform. For such uses, the large waveforms may be dropped and this summary information be kept instead.

Input data products

This module acts on a selection of tracks, which implies that the input is a set of pointers to tracks rather than to an actual track collection. For each track, an associated time is required.

std::vector<raw::OpDetWaveform> (tag from Waveforms): all optical detector waveforms to extract the information from

Output data products

std::vector<sbn::OpDetWaveformMeta>: a collection parallel to the input one (from data product configured by Waveforms) with the summary information on each of them; also an explicit courtesy association art::Assns<sbn::OpDetWaveformMeta, raw::OpDetWaveform> for uses where order is not preserved. The times in these objects are on the same scale as the ones in the source data product, which is expected to be electronics time scale [us].

Configuration parameters

A terse online description of the parameters is printed by running lar --print-description OpDetWaveformMetaMaker.

Waveforms (input tag, mandatory): the list of optical detector waveforms to be processed.
LogCategory (string, default: OpDetWaveformMetaMaker): name of the output stream category for console messages (managed by MessageFacility library).

Definition at line 93 of file OpDetWaveformMetaMaker_module.cc.

Member Typedef Documentation

using icarus::trigger::OpDetWaveformMetaMaker::Parameters = art::SharedProducer::Table<Config>

Definition at line 118 of file OpDetWaveformMetaMaker_module.cc.

Constructor & Destructor Documentation

icarus::trigger::OpDetWaveformMetaMaker::OpDetWaveformMetaMaker	(	Parameters const &	config,
		art::ProcessingFrame const &
	)

explicit

Definition at line 168 of file OpDetWaveformMetaMaker_module.cc.

   : art::SharedProducer(config)
   // configuration
   , fWaveformTag(config().Waveforms())
   , fLogCategory(config().LogCategory())
 {
   
   async<art::InEvent>();
   
   //
   // output data declaration
   //
   produces<std::vector<sbn::OpDetWaveformMeta>>();
   produces<art::Assns<sbn::OpDetWaveformMeta, raw::OpDetWaveform>>();
   
   //
   // configuration report (short)
   //
   
   mf::LogInfo{ fLogCategory }
     << "Configuration:"
     << "\n - input waveforms: '" << fWaveformTag.encode() << '\''
     ;
   
 } // icarus::trigger::OpDetWaveformMetaMaker::OpDetWaveformMetaMaker()

Member Function Documentation

void icarus::trigger::OpDetWaveformMetaMaker::produce	(	art::Event &	event,
		art::ProcessingFrame const &
	)

overridevirtual

Fills the plots. Also extracts the information to fill them with.

Definition at line 197 of file OpDetWaveformMetaMaker_module.cc.

 {
   
   using detinfo::timescales::electronics_time;
   
   //
   // get the timing information for this event
   //
   detinfo::DetectorTimings const detTimings = detinfo::makeDetectorTimings
     (art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(event))
     ;
   
   //
   // fetch input
   //
   auto const& waveformHandle
     = event.getValidHandle<std::vector<raw::OpDetWaveform>>(fWaveformTag);
 
   {
     electronics_time const triggerTime = detTimings.TriggerTime();
     electronics_time const beamGateTime = detTimings.BeamGateTime();
     mf::LogDebug(fLogCategory)
       << "Event " << event.id() << " has beam gate starting at " << beamGateTime
       << " and trigger at " << triggerTime << "."
       << "\nNow extracting information from " << waveformHandle->size()
         << " waveforms."
       ;
   }
 
   //
   // create the content
   //
   sbn::OpDetWaveformMetaMaker makeOpDetWaveformMeta{ detTimings };
   
   std::vector<sbn::OpDetWaveformMeta> PMTinfo;
   art::Assns<sbn::OpDetWaveformMeta, raw::OpDetWaveform> infoToWaveform;
   
   art::PtrMaker<sbn::OpDetWaveformMeta> const makeInfoPtr { event };
   art::PtrMaker<raw::OpDetWaveform> const makeWaveformPtr
     { event, waveformHandle.id() };
   
   for (auto const& [ iWaveform, waveform ]: util::enumerate(*waveformHandle)) {
     assert(iWaveform == PMTinfo.size());
     
     PMTinfo.push_back(makeOpDetWaveformMeta(waveform));
     
     {
       sbn::OpDetWaveformMeta const& info = PMTinfo.back();
       mf::LogTrace log{ fLogCategory };
       log << "Coverage for waveform #" << iWaveform
         << " on channel " << info.channel << ": "
         << info.startTime << " -- " << info.endTime;
       if (info.withTrigger()) log << "; includes trigger";
       if (info.withBeamGate()) log << "; includes beam gate start";
     }
     
     infoToWaveform.addSingle
       (makeInfoPtr(iWaveform), makeWaveformPtr(iWaveform));
     
   } // for
   
   //
   // store output
   //
   event.put(moveToUniquePtr(PMTinfo));
   event.put(moveToUniquePtr(infoToWaveform));
   
 } // icarus::trigger::OpDetWaveformMetaMaker::produce()