icarus::trigger::TriggerGateReader< OpDetInfo > Class Template Reference

Assembles and returns trigger gates from serialized data. More...

#include <TriggerDataUtils.h>

Public Types
using	OpDetWaveformMeta_t = OpDetInfo
	Type of associated information. More...
using	TriggerGates_t = icarus::trigger::TrackedOpticalTriggerGate< OpDetWaveformMeta_t >
	Type of data objects returned. More...

Public Member Functions
	TriggerGateReader (art::InputTag dataTag)
	Constructor: configure to read the data with the specified tag. More...
template<typename ConsumesCollector >
void	declareConsumes (ConsumesCollector &collector) const
	Declares to the collector the data products that are going to be read. More...
art::InputTag const &	inputTag () const
	Returns the input tag the data is read from. More...
template<typename Event >
std::vector < icarus::trigger::TrackedOpticalTriggerGate < OpDetInfo > >	read (Event const &event) const
template<typename Event >
std::vector< TriggerGates_t >	read (Event const &event) const
	Reads the configured data product from the specified event. More...
template<typename Event >
std::vector< TriggerGates_t >	operator() (Event const &event) const

Private Attributes
art::InputTag	fDataTag
	Data tag of the data products being read. More...

Detailed Description

template<typename OpDetInfo = sbn::OpDetWaveformMeta>
class icarus::trigger::TriggerGateReader< OpDetInfo >

Assembles and returns trigger gates from serialized data.

Template Parameters

OpDetInfo	type of object associated to the gates
Event	type of object to read the needed information from

Parameters

event	object to read all the needed information from
dataTag	tag of the data to read from the event

Returns

a collection of "tracking" trigger gates

Exceptions

cet::exception

wrapping any cet::exception thrown internally (typically a data product not found)

See Also

icarus::trigger::FillTriggerGates()

This class manages reading from a data source trigger gates (vector of icarus::trigger::OpticalTriggerGateData_t elements) and their associations to a tracking information (OpDetInfo: sbn::OpDetWaveformMeta by default, but it may also be e.g. raw::OpDetWaveform).

All this information is merged into the "tracking" trigger gates, which wrap _ a copy_ of the trigger gates and a reference to the tracked information (by simple C pointer).

This class is a framework interface to FillTriggerGates(); interaction with the data source and the framework is driven by the Event object in the read() method, which is expected to expose an interface similar to _art_'sart::Event<tt>, and in particular: *Event::getProduct<T>(art::InputTag)to read and return directly a reference to the persistent, framework-owned data products of typeT`.

In addition, this class provides a shortcut to declare the consumed data products, again in a art-like interface. A full usage example in a module includes:

1. a reader data member in the module class reading the data:

   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} icarus::trigger::TriggerGateReader<> const fGateReader; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2. construction in the module constructor initializer list from a configured input tag representing the data to be read:

   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} , fGateReader{ config().TriggerGateTag() } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3. also in the module constructor body, declaration of what is going to be read: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} fGateReader.declareConsumes(consumesCollector()); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4. actual reading in a context where the current event is known: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} std::vector<icarus::trigger::TrackedOpticalTriggerGate<sbn::OpDetWaveformMeta>> gates = fGateReader(event); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In a context where the consume declaration is not relevant/desired, the first three steps can be omitted and the reading can happen with a temporary TriggerGateReader object; or the shortcut function icarus::trigger::ReadTriggerGates() can be used instead:

std::vector<icarus::trigger::TrackedOpticalTriggerGate<sbn::OpDetWaveformMeta>>
  gates = icarus::trigger::ReadTriggerGates<sbn::OpDetWaveformMeta>(event, dataTag);

is equivalent to the last step above. Note that it is still possible to use temporaries also for the consume declaration: for example, a program using icarus::trigger::ReadTriggerGates() may in the proper place (e.g. a module constructor) call explicitly the consume declaration:

icarus::trigger::TriggerGateReader<>{ config().TriggerGateTag() }
  .declareConsumes(consumesCollector());

is equivalent to the three steps above. The only advantage of the approach in multiple steps of the first example is that consistency of declaration and use is guaranteed by construction.

Definition at line 298 of file TriggerDataUtils.h.

Member Typedef Documentation

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

using icarus::trigger::TriggerGateReader< OpDetInfo >::OpDetWaveformMeta_t = OpDetInfo

Type of associated information.

Definition at line 459 of file TriggerDataUtils.h.

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

using icarus::trigger::TriggerGateReader< OpDetInfo >::TriggerGates_t = icarus::trigger::TrackedOpticalTriggerGate<OpDetWaveformMeta_t>

Type of data objects returned.

Definition at line 463 of file TriggerDataUtils.h.

Constructor & Destructor Documentation

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

icarus::trigger::TriggerGateReader< OpDetInfo >::TriggerGateReader ( art::InputTag  dataTag )

inline

Constructor: configure to read the data with the specified tag.

Definition at line 467 of file TriggerDataUtils.h.

: fDataTag(std::move(dataTag)) {}

Member Function Documentation

template<typename OpDetInfo >

template<typename ConsumesCollector >

void icarus::trigger::TriggerGateReader< OpDetInfo >::declareConsumes

(

ConsumesCollector &

collector

)

const

Declares to the collector the data products that are going to be read.

Definition at line 610 of file TriggerDataUtils.h.

{

  using icarus::trigger::OpticalTriggerGateData_t; // for convenience

  collector.template consumes<std::vector<OpticalTriggerGateData_t>>(fDataTag);
  collector.template consumes<art::Assns<OpticalTriggerGateData_t, OpDetInfo>>
    (fDataTag);
  
} // icarus::trigger::TriggerGateReader::declareConsumes()

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

art::InputTag const& icarus::trigger::TriggerGateReader< OpDetInfo >::inputTag ( ) const

inline

Returns the input tag the data is read from.

Definition at line 474 of file TriggerDataUtils.h.

{ return fDataTag; }

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

template<typename Event >

std::vector<TriggerGates_t> icarus::trigger::TriggerGateReader< OpDetInfo >::operator() ( Event const &  event ) const

inline

Definition at line 481 of file TriggerDataUtils.h.

    { return read(event); }

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

template<typename Event >

std::vector<TriggerGates_t> icarus::trigger::TriggerGateReader< OpDetInfo >::read

(

Event const &

event

)

const

Reads the configured data product from the specified event.

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

template<typename Event >

std::vector<icarus::trigger::TrackedOpticalTriggerGate<OpDetInfo> > icarus::trigger::TriggerGateReader< OpDetInfo >::read

(

Event const &

event

)

const

Definition at line 626 of file TriggerDataUtils.h.

                                                                        {

  using icarus::trigger::OpticalTriggerGateData_t; // for convenience

  // currently the associations are a waste of time memory...
  auto const& gates
    = event.template getProduct<std::vector<OpticalTriggerGateData_t>>(fDataTag);
  auto const& gateToWaveforms = event.template getProduct
    <art::Assns<OpticalTriggerGateData_t, OpDetInfo>>(fDataTag);
  
  try {
    return icarus::trigger::FillTriggerGates(gates, gateToWaveforms);
  }
  catch (cet::exception const& e) {
    throw cet::exception("readTriggerGates", "", e)
      << "readTriggerGates() encountered an error while reading data products from '"
      << fDataTag.encode() << "'\n";
  }

} // icarus::trigger::TriggerGateReader::read()

Member Data Documentation

template<typename OpDetInfo = sbn::OpDetWaveformMeta>

art::InputTag icarus::trigger::TriggerGateReader< OpDetInfo >::fDataTag

private

Data tag of the data products being read.

Definition at line 455 of file TriggerDataUtils.h.

---

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

• TriggerDataUtils.h