icarus::trigger::FixBeamGateInfo Class Reference

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

Inheritance diagram for icarus::trigger::FixBeamGateInfo:

Classes
struct	BeamChangeRecipe
	All directions to change a beam gate. More...
struct	Config

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

Public Member Functions
	FixBeamGateInfo (Parameters const &config, art::ProcessingFrame const &)
virtual void	produce (art::Event &event, art::ProcessingFrame const &) override

Private Types
using	simulation_time = detinfo::timescales::simulation_time

Private Member Functions
sim::BeamGateInfo	fixBeamGate (sim::BeamGateInfo const &beamGate) const
	Returns a "fixed" beam gate based on the input beamGate one. More...

Static Private Member Functions
static bool	acceptGate (sim::BeamGateInfo const &gate, BeamChangeRecipe::GateSelector_t const &selection)
	Returns whether gate passes the specified selection. More...
template<typename T , typename P , typename I >
static T &	applyRecipe (T &target, std::optional< BeamChangeRecipe::ChangeRecipe_t< P, I >> const &recipe)
	Applies the changes in recipe on the target value. More...

Private Attributes
art::InputTag const	fBeamGateTag
	Input beam gate data product. More...
std::vector< BeamChangeRecipe > const	fChanges
	Changes on beam gate. More...
std::string const	fInstanceName
	Instance name for the output product. More...
std::string const	fLogCategory
	Message facility stream category for output. More...

Friends
struct	dumpRecipe
BeamChangeRecipe	convert (Config::ChangeGate const &config)

Detailed Description

Rewrites a set collection of beam gates into each event.

This module allows to perform fixed transformations to an existing beam gate data product (sim::BeamGateInfo), producing a new set of gates.

Output data products

• std::vector<sim::BeamGateInfo>: a collection of as many sim::BeamGateInfo as in the input.

Configuration parameters

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

• BeamGateTag (input tag, mandatory): data product with the beam gates to be "fixed"
• Changes (list of tables): a list of beam gate changes to be performed; the changes are performed in the order of this list, all the ones which apply (e.g. not stopping at the first that applies). Each item must specify at least an action to be taken (changing either start or width of the gate). Each element in the list is a table including:
  • Select (optional table): if specified, the following changes apply only to the gates that match the constraints as follows.
    • Types (list of gate types): if specified, the changes will be applied only to gates of type specified in the list; the gate type is specified by name (e.g. "BNB", "NuMI"). If not specified, the changes are applied to all types of gates.
  • Width (optional table): a table with the operations affecting the duration of the gate. The end of the gate is modified accordingly, while the start point is not changed. The following options are exclusive:
    • SetTo (time): duration is set to this interval;
    • Change (time): this value is added to the duration (negative decreases it, but never below 0).
  • Start (optional table): a table with the operations affecting the start of the gate. The duration of the gate is always preserved. The following options are exclusive:
    • SetTo (time): start of the beam gate is moved to this time point, set on the electronics time scale;
    • Change (time): this value is added to the start time (negative anticipates it).
• KeepInstanceName (flag, default: false): if set, the output beam gate data product will have the same instance name as the input one specified in BeamGateTag.
• OutputInstanceName (string, default: empty): the instance name of the output data product (exclusive with KeepInstanceName).
• LogCategory (string, default: FixBeamGateInfo): name of the output stream category for console messages (managed by MessageFacility library).

Times must be specified as strings with their unit, e.g. "0.6 us" for 0.6 microseconds.

Definition at line 97 of file FixBeamGateInfo_module.cc.

Member Typedef Documentation

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

Definition at line 269 of file FixBeamGateInfo_module.cc.

using icarus::trigger::FixBeamGateInfo::simulation_time = detinfo::timescales::simulation_time

private

Definition at line 99 of file FixBeamGateInfo_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 408 of file FixBeamGateInfo_module.cc.

  : art::SharedProducer(config)
  // configuration
  , fBeamGateTag{ config().BeamGateTag() }
  , fChanges{ config().Changes() }
  , fInstanceName{
      config().KeepInstanceName()
      ? fBeamGateTag.instance(): config().OutputInstanceName()
    }
  , fLogCategory(config().LogCategory())
{
  using namespace util::quantities::time_literals;
  
  //
  // parameter validation
  //
  if (config().KeepInstanceName() && !config().OutputInstanceName().empty()) {
    throw art::Exception{ art::errors::Configuration }
      << "Can't set both '" << config().KeepInstanceName.name()
        << " (" << std::boolalpha << config().KeepInstanceName() << ")"
      << "' and '" << config().OutputInstanceName.name() << "' ('"
        << config().OutputInstanceName() << "') at the same time.\n";
  }
  
  for (auto const& [ iChange, change ]: util::enumerate(fChanges)) {
    if (change.valid()) continue;
    throw art::Exception{ art::errors::Configuration }
      << "Incompatible requests for '" << config().Changes.name()
      << "' item [" << iChange << "] " << dumpRecipe(change, "  ", "")
      << "\n";
  } // for changes
  
  //
  // input data declaration
  //
  consumes<std::vector<sim::BeamGateInfo>>(fBeamGateTag);
  
  //
  // output data declaration
  //
  produces<std::vector<sim::BeamGateInfo>>(fInstanceName);
  
  async<art::InEvent>();
  
  //
  // configuration report (short)
  //
  {
    mf::LogInfo log { fLogCategory };
    log << "New beam gates based on '" << fBeamGateTag.encode()
      << "' following " << fChanges.size() << " rules:";
    for (auto const& [iChange, change]: util::enumerate(fChanges)) {
      log << "\n[" << iChange << "] " << dumpRecipe(change, "  ", "");
    } // for all change sets
  }
  
} // icarus::trigger::FixBeamGateInfo::FixBeamGateInfo()

Member Function Documentation

bool icarus::trigger::FixBeamGateInfo::acceptGate ( sim::BeamGateInfo const &  gate, BeamChangeRecipe::GateSelector_t const &  selection  )

staticprivate

Returns whether gate passes the specified selection.

Definition at line 526 of file FixBeamGateInfo_module.cc.

{
  if (!selection.beamTypes.empty()) {
    if (!contains(selection.beamTypes, gate.BeamType())) return false;
  }
  return true;
} // icarus::trigger::FixBeamGateInfo::acceptGate()

template<typename T , typename P , typename I >

T & icarus::trigger::FixBeamGateInfo::applyRecipe ( T &  target, std::optional< BeamChangeRecipe::ChangeRecipe_t< P, I >> const &  recipe  )

staticprivate

Applies the changes in recipe on the target value.

Definition at line 537 of file FixBeamGateInfo_module.cc.

  {
  if (recipe) {
    if (recipe->setValue) target = *recipe->setValue;
    if (recipe->addValue) target += *recipe->addValue;
  }
  return target;
} // icarus::trigger::FixBeamGateInfo::applyRecipe()

sim::BeamGateInfo icarus::trigger::FixBeamGateInfo::fixBeamGate ( sim::BeamGateInfo const &  beamGate ) const

private

Returns a "fixed" beam gate based on the input beamGate one.

Definition at line 500 of file FixBeamGateInfo_module.cc.

{
  using nanosecond = util::quantities::points::nanosecond;
  using nanoseconds = util::quantities::intervals::nanoseconds;
  
  // beamGate is supposed to be stored in simulation_time units (nanoseconds)
  simulation_time start { nanosecond{ beamGate.Start() }};
  simulation_time::interval_t width { nanoseconds{ beamGate.Width() }};
  
  for (BeamChangeRecipe const& change: fChanges) {
    if (!acceptGate(beamGate, change.selectGates)) continue;
    applyRecipe(start, change.start);
    applyRecipe(width, change.width);
  } // for all changes
  
  return sim::BeamGateInfo{
    nanosecond{ start }.value(),
    nanoseconds{ width }.value(),
    beamGate.BeamType()
    };
  
} // icarus::trigger::FixBeamGateInfo::fixBeamGate()

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

overridevirtual

Definition at line 469 of file FixBeamGateInfo_module.cc.

{
  
  //
  // read input data product
  //
  auto const& beamGates
    = event.getProduct<std::vector<sim::BeamGateInfo>>(fBeamGateTag);
  
  //
  // "fix"
  //
  std::vector<sim::BeamGateInfo> fixedBeamGates;
  fixedBeamGates.reserve(beamGates.size());
  for (sim::BeamGateInfo const& beamGate: beamGates)
    fixedBeamGates.push_back(fixBeamGate(beamGate));
  
  //
  // put into the event
  //
  event.put(
    std::make_unique<std::vector<sim::BeamGateInfo>>
      (std::move(fixedBeamGates)),
    fInstanceName
    );
  
} // icarus::trigger::FixBeamGateInfo::produce()

Friends And Related Function Documentation

BeamChangeRecipe convert ( Config::ChangeGate const &  config )

friend

Definition at line 364 of file FixBeamGateInfo_module.cc.

  {
    using ChangeGate = FixBeamGateInfo::Config::ChangeGate;
    return FixBeamGateInfo::BeamChangeRecipe{
        ChangeGate::convert(config.Select())  // selectGates
      , ChangeGate::convert(config.Start())   // start
      , ChangeGate::convert(config.Width())   // width
      };
  } // convert(FixBeamGateInfo::Config::ChangeGate)

friend struct dumpRecipe

friend

Definition at line 326 of file FixBeamGateInfo_module.cc.

Member Data Documentation

art::InputTag const icarus::trigger::FixBeamGateInfo::fBeamGateTag

private

Input beam gate data product.

Definition at line 294 of file FixBeamGateInfo_module.cc.

std::vector<BeamChangeRecipe> const icarus::trigger::FixBeamGateInfo::fChanges

private

Changes on beam gate.

Definition at line 297 of file FixBeamGateInfo_module.cc.

std::string const icarus::trigger::FixBeamGateInfo::fInstanceName

private

Instance name for the output product.

Definition at line 299 of file FixBeamGateInfo_module.cc.

std::string const icarus::trigger::FixBeamGateInfo::fLogCategory

private

Message facility stream category for output.

Definition at line 302 of file FixBeamGateInfo_module.cc.

---

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

• FixBeamGateInfo_module.cc