Produces plots to inform trigger design. More...

Inheritance diagram for icarus::trigger::DumpTriggerGateData:

Classes
struct	Config

Public Types
using	TriggerGateData_t = icarus::trigger::OpticalTriggerGate::GateData_t
	The type of data this dumper is dumping. More...

using	Parameters = art::EDAnalyzer::Table< Config >

Public Member Functions
	DumpTriggerGateData (Parameters const &config)

	DumpTriggerGateData (DumpTriggerGateData const &)=delete

	DumpTriggerGateData (DumpTriggerGateData &&)=delete

DumpTriggerGateData &	operator= (DumpTriggerGateData const &)=delete

DumpTriggerGateData &	operator= (DumpTriggerGateData &&)=delete

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

Private Attributes
art::InputTag	fTriggerGateDataTag
	Input trigger gate data tag. More...

bool	fPrintChannels
	Whether to print associated optical waveform info. More...

std::string	fOutputCategory
	Category used for message facility stream. More...

Detailed Description

Produces plots to inform trigger design.

This module produces sets of plots based on the configured trigger settings.

Input data products

std::vector<raw::OpDetWaveform>: a single waveform for each recorded optical detector activity; the activity belongs to a single channel, but there may be multiple waveforms on the same channel. The time stamp is expected to be from the electronics time scale and therefore expressed in microseconds.
std::vector<simb::MCTruth>: generator information, used for categorising the events for plot sets

Output plots

For each event category, a set of plots is left into a ROOT subdirectory.

Todo:: Document which plots these are!

Configuration parameters

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

Todo:: Complete the documentation

TriggerGateDataTag (data product input tag): the tag identifying the data product to dump; instance names are specified introduced by a colon: "modulelabel:instance".

Definition at line 83 of file DumpTriggerGateData_module.cc.

Member Typedef Documentation

using icarus::trigger::DumpTriggerGateData::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 116 of file DumpTriggerGateData_module.cc.

using icarus::trigger::DumpTriggerGateData::TriggerGateData_t = icarus::trigger::OpticalTriggerGate::GateData_t

The type of data this dumper is dumping.

Definition at line 88 of file DumpTriggerGateData_module.cc.

Constructor & Destructor Documentation

icarus::trigger::DumpTriggerGateData::DumpTriggerGateData ( Parameters const & config )

explicit

Definition at line 173 of file DumpTriggerGateData_module.cc.

   : art::EDAnalyzer(config)
   // configuration
   , fTriggerGateDataTag(config().TriggerGateDataTag())
   , fPrintChannels     (config().PrintChannels())
   , fOutputCategory    (config().OutputCategory())
 {
   consumes<std::vector<TriggerGateData_t>>(fTriggerGateDataTag);
   if (fPrintChannels) {
     consumes<art::Assns<TriggerGateData_t, raw::OpDetWaveform>>
       (fTriggerGateDataTag);
   }
   
 } // icarus::trigger::DumpTriggerGateData::DumpTriggerGateData()

icarus::trigger::DumpTriggerGateData::DumpTriggerGateData ( DumpTriggerGateData const & )

delete

icarus::trigger::DumpTriggerGateData::DumpTriggerGateData ( DumpTriggerGateData && )

delete

Member Function Documentation

void icarus::trigger::DumpTriggerGateData::analyze ( art::Event const & event )

overridevirtual

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

Definition at line 190 of file DumpTriggerGateData_module.cc.

                                                                     {
   
   //
   // do the work
   //
   auto const& gates =
    *(event.getValidHandle<std::vector<TriggerGateData_t>>(fTriggerGateDataTag));
   auto const* gateToWaveforms = fPrintChannels
     ? event.getHandle<art::Assns<TriggerGateData_t, raw::OpDetWaveform>>
       (fTriggerGateDataTag).product()
     : nullptr
     ;
   
   auto maybeItOpDetWave { gateToWaveforms
     ? std::make_optional(gateToWaveforms->begin()): std::nullopt
     };
 
   mf::LogVerbatim log(fOutputCategory);
   log << event.id() << ": '" << fTriggerGateDataTag.encode() << "' has "
     << gates.size() << " trigger gates:";
   for (auto const& [ iGate, gate ]: util::enumerate(gates)) {
     log << "\n[#" << iGate << "] " << compactdump(gate);
     if (gateToWaveforms) {
       auto& itOpDetWave = maybeItOpDetWave.value();
       auto const owend = gateToWaveforms->end();
 
       /*
        * Associations are expected to be in the same order as the trigger gates;
        * so we look for the first one matching this gate
        * (matching by the position in the data product collection)
        * and then for the last one; if there is none... well, we say so.
        */
       while (itOpDetWave != owend) {
         if (itOpDetWave->first.key() == iGate) break;
         ++itOpDetWave;
       } // while
       if (itOpDetWave == owend) {
         log << "\n  (not associated with any optical detector waveform!)";
         continue;
       }
       auto const firstOpDetWave = itOpDetWave;
       std::set<raw::Channel_t> channels;
       while (itOpDetWave != owend) {
         if (itOpDetWave->first.key() != iGate) break;
         channels.insert(itOpDetWave->second->ChannelNumber());
         ++itOpDetWave;
       } // while
 
       log << "\n  associated with "
         << std::distance(firstOpDetWave, itOpDetWave)
         << " optical detector waveforms on ";
       if (channels.size() == 1U) {
         log << "channel " << *(channels.cbegin());
       }
       else {
         log << channels.size() << " channels:";
         for (auto const& channel: channels) log << " " << channel;
       }
 
     } // if printing associated information
   } // for
 
 } // icarus::trigger::DumpTriggerGateData::analyze()