Object to facilitate the discovery of the raw::OpDetWaveform a sbn::OpDetWaveformMeta objects comes from. More...

#include <OpDetWaveformMetaMatcher.h>

Classes
struct	CmpFirst
	Compares a sbn::OpDetWaveformMeta<tt>and an element ofWaveformMetaAssns_t`. More...

Public Member Functions
	OpDetWaveformMetaMatcher (Event const &event)
	Constructor: associates to the specified art event. More...


art::Ptr< raw::OpDetWaveform >	fetchAssociatedWaveform (art::Ptr< sbn::OpDetWaveformMeta > const &meta)
	Returns the waveform associated to `meta`, or a null pointer if not found. More...

art::Ptr< raw::OpDetWaveform >	operator ()(art

Private Types
using	Event_t = Event
	Type of the framework event to read data from. More...

using	WaveformMetaAssns_t = art::Assns< sbn::OpDetWaveformMeta, raw::OpDetWaveform >
	Type of associations used in this algorithm,. More...

Private Member Functions
WaveformMetaAssns_t const *	loadAssociations (art::ProductID const &pid)

art::Ptr< raw::OpDetWaveform >	findAssociatedWaveform (art::Ptr< sbn::OpDetWaveformMeta > const &meta, WaveformMetaAssns_t const &assns) const
	Returns the waveform associated to `meta` if in `assns` or a null pointer. More...

Private Attributes
Event_t const &	fEvent
	Event to read associations from. More...

std::unordered_map < art::ProductID, WaveformMetaAssns_t const * >	fAssns
	All associations discovered so far. More...

Detailed Description

template<typename Event>
class icarus::trigger::OpDetWaveformMetaMatcher< Event >

Object to facilitate the discovery of the raw::OpDetWaveform a sbn::OpDetWaveformMeta objects comes from.

Template Parameters

Event type of the framework event to read data products from

This algorithm will look in the associated art event for the raw::OpDetWaveform associated to any specified sbn::OpDetWaveformMeta.

The sbn::OpDetWaveformMeta object must be specified by art pointer. The algorithm assumes that the module that created the sbn::OpDetWaveformMeta object also created an association between it and the original raw::OpDetWaveform, and will read that association.

Example:

icarus::trigger::OpDetWaveformMetaMatcher waveformMetaMatcher{ event };
art::Assns<OpticalTriggerGateData_t, raw::OpDetWaveform> waveAssns;
for (auto const [ gatePtr, metaPtr ]: metaAssns)
      waveAssns.addSingle(gatePtr, waveformMetaMatcher(metaPtr));

will fill waveAssns with one gate/waveform association for each gate/metadata association in metaAssns. Note that, in this simple example, if no waveform pointer is matched to a metadata item, a null pointer to waveform is stored in the association.

Definition at line 34 of file OpDetWaveformMetaMatcher.h.

Member Typedef Documentation

template<typename Event >

using icarus::trigger::OpDetWaveformMetaMatcher< Event >::Event_t = Event

private

Type of the framework event to read data from.

Definition at line 65 of file OpDetWaveformMetaMatcher.h.

template<typename Event >

using icarus::trigger::OpDetWaveformMetaMatcher< Event >::WaveformMetaAssns_t = art::Assns<sbn::OpDetWaveformMeta, raw::OpDetWaveform>

private

Type of associations used in this algorithm,.

Definition at line 69 of file OpDetWaveformMetaMatcher.h.

Constructor & Destructor Documentation

template<typename Event >

icarus::trigger::OpDetWaveformMetaMatcher< Event >::OpDetWaveformMetaMatcher ( Event const & event )

Constructor: associates to the specified art event.

Definition at line 135 of file OpDetWaveformMetaMatcher.h.

136 : fEvent(event)

137 {}

icarus::trigger::OpDetWaveformMetaMatcher::fEvent

Event_t const & fEvent

Event to read associations from.

Definition: OpDetWaveformMetaMatcher.h:95

Member Function Documentation

template<typename Event >

art::Ptr< raw::OpDetWaveform > icarus::trigger::OpDetWaveformMetaMatcher< Event >::fetchAssociatedWaveform ( art::Ptr< sbn::OpDetWaveformMeta > const & meta )

Returns the waveform associated to meta, or a null pointer if not found.

Definition at line 144 of file OpDetWaveformMetaMatcher.h.

 {
   
   WaveformMetaAssns_t const* assns = loadAssociations(meta.id());
   return assns
     ? findAssociatedWaveform(meta, *assns): art::Ptr<raw::OpDetWaveform>{};
   
 } // icarus::trigger::OpDetWaveformMetaMatcher<>::fetchAssociatedWaveform()

template<typename Event >

art::Ptr< raw::OpDetWaveform > icarus::trigger::OpDetWaveformMetaMatcher< Event >::findAssociatedWaveform	(	art::Ptr< sbn::OpDetWaveformMeta > const &	meta,
		WaveformMetaAssns_t const &	assns
	)		const

private

Returns the waveform associated to meta if in assns or a null pointer.

Definition at line 186 of file OpDetWaveformMetaMatcher.h.

         {
   
   auto const key = meta.key();
   
   // try our luck: 1-1 association?
   if ((assns.size() > key) && (assns.at(key).first == meta))
     return assns[key].second;
   
   // nope, go binary search
   if (auto itAssn = std::lower_bound(assns.begin(), assns.end(), meta, CmpFirst{});
       itAssn != assns.end()
   ) {
     if (itAssn->first == meta) return itAssn->second;
   }
   
   // still nope, go linear search
   for (auto const& assn: assns) if (assn.first == meta) return assn.second;
   
   // still nope, not found!
   return {};
   
 } // icarus::trigger::OpDetWaveformMetaMatcher::fetchAssociatedWaveform()

template<typename Event >

auto icarus::trigger::OpDetWaveformMetaMatcher< Event >::loadAssociations ( art::ProductID const & pid )

private

Loads the association including pid.

Returns: pointer to the associations containing pid, nullptr if n/a.

Definition at line 157 of file OpDetWaveformMetaMatcher.h.

 {
   
   // if already there, the better
   if (auto const itAssns = fAssns.find(pid); itAssns != fAssns.end())
     return itAssns->second;
   
   // let's start optimistic: we won't find it
   auto& assnCache = (fAssns[pid] = nullptr);
   
   try {
     art::InputTag const tag = util::inputTagOf(fEvent, pid);
     
     auto const assnsHandle = fEvent.template getHandle<WaveformMetaAssns_t>(tag);
     if (!assnsHandle.isValid()) return nullptr;
     return assnCache = assnsHandle.product();
   }
   catch (art::Exception const& e) {
     if (e.categoryCode() == art::errors::ProductNotFound) return nullptr;
     throw;
   }
   
   
 } // icarus::trigger::OpDetWaveformMetaMatcher<>::loadAssociations()