Writes a set collection of beam gates into each event. More...

Inheritance diagram for icarus::trigger::WriteBeamGateInfo:

Classes
struct	Config

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

Public Member Functions
	WriteBeamGateInfo (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
std::vector< sim::BeamGateInfo > const	fBeamGates
	The gates to write. More...

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

Detailed Description

Writes a set collection of beam gates into each event.

This module simply injects a list of sim::BeamGateInfo from the configuration into each event.

It may be used as input to modules which require to operate on beam gates.

Output data products

std::vector<sim::BeamGateInfo>: a collection of as many sim::BeamGateInfo as the BeamGates configuration parameter entries, with the content from them.

Configuration parameters

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

BeamGates (list of configuration tables, mandatory): list of beam gate specifications; one output element is produced for each entry in this list. Each entry is a configuration table in the form:
- Duration (time, mandatory): the duration of the beam gate; the time requires the unit to be explicitly specified: use "1.6 us" for BNB, 9.5 us for NuMI (also available as BNB_settings.spill_duration and NuMI_settings.spill_duration in trigger_icarus.fcl);
- Start (time, default: 0_us): how long after the nominal beam gate opening time the actual beam gate opens at;
- Type (string, default: "unknown"): type of the gate; see online description for the configuration keys representing the values of sim::BeamType_t.
LogCategory (string, default: WriteBeamGateInfo): name of the output stream category for console messages (managed by MessageFacility library).

Definition at line 75 of file WriteBeamGateInfo_module.cc.

Member Typedef Documentation

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

Definition at line 148 of file WriteBeamGateInfo_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 219 of file WriteBeamGateInfo_module.cc.

   : art::SharedProducer(config)
   // configuration
   , fBeamGates(config().BeamGates())
   , fLogCategory(config().LogCategory())
 {
   
   //
   // output data declaration
   //
   produces<std::vector<sim::BeamGateInfo>>();
   
   async<art::InEvent>();
   
   //
   // configuration report (short)
   //
   {
     mf::LogInfo log { fLogCategory };
     log << "Writing " << fBeamGates.size() << " gates in each event:";
     for (sim::BeamGateInfo const& gate: fBeamGates) {
       auto const& beamType = Config::GateConfig::BeamTypeSelector.get
         (Config::GateConfig::BeamType_t(gate.BeamType()));
       log << "\n *  [ " << gate.Start() << " -- " << gate.Start() + gate.Width()
         << " ] ns (duration: " << gate.Width() << " ns), type: "
         << beamType.name() << " (" << gate.BeamType() << ")"
         ;
     } // for
   }
   
 } // icarus::trigger::WriteBeamGateInfo::WriteBeamGateInfo()

Member Function Documentation

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

overridevirtual

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

Definition at line 254 of file WriteBeamGateInfo_module.cc.

 {
   
   // put a copy
   event.put(std::make_unique<std::vector<sim::BeamGateInfo>>(fBeamGates));
   
 } // icarus::trigger::WriteBeamGateInfo::produce()