sbn::DumpTrigger Class Reference

Dumps on console the content of trigger data products. More...

Inheritance diagram for sbn::DumpTrigger:

Classes
struct	Config

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

Public Member Functions
	DumpTrigger (Parameters const &config)
virtual void	analyze (art::Event const &event) override
	Does the dumping. More...

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

Private Member Functions
void	dumpTrigger (std::vector< raw::Trigger > const &triggers) const
	Dumps a simple LArSoft trigger data product. More...
void	dumpTrigger (std::vector< raw::ExternalTrigger > const &triggers) const
	Dumps a LArSoft external trigger data product. More...
void	dumpBeamGate (std::vector< sim::BeamGateInfo > const &gates) const
	Dumps a LArSoft beam gate information data product. More...
void	dumpTrigger (sbn::ExtraTriggerInfo const &trigger) const
	Dumps a SBN trigger information data product. More...
std::pair< art::InputTag, bool >	inputTag (std::optional< art::InputTag > const &tag) const
	Returns the tag to try, and whether it is mandatory to find it. More...
template<typename T >
unsigned int	countConsume (std::optional< art::InputTag > const &param)

Private Attributes
std::optional< art::InputTag > const	fTriggerTag
	Input trigger tag. More...
std::optional< art::InputTag > const	fBeamGateTag
	Input beam gate tag. More...
std::optional< art::InputTag > const	fExternalTag
	Input additional trigger tag. More...
std::optional< art::InputTag > const	fExtraTag
unsigned int const	fVerbosity
	Input extra trigger tag. More...
std::string const	fOutputCategory
	Category used for message facility stream. More...

Detailed Description

Dumps on console the content of trigger data products.

Supported trigger types are:

• std::vector<raw::Trigger>
• std::vector<raw::ExternalTrigger>
• std::vector<sim::BeamGateInfo>
• std::vector<sbn::ExtraTriggerInfo>

Input data products

• std::vector<raw::Trigger>: simple trigger information
• std::vector<sim::BeamGateInfo>: beam gate information
• std::vector<raw::ExternalTrigger>: additional trigger information
• sbn::ExtraTriggerInfo: detailed trigger information

Configuration parameters

All data product tags are optional, but at least one needs to be specified. If a tag is not specified, the same tag as TriggerTag will be attempted (if specified). A terse description of the parameters is printed by running lar --print-description DumpTrigger.

• TriggerTag (data product input tag, optional): the tag identifying the data product of the simple trigger information to dump.
• BeamGateTag (data product input tag, optional): the tag identifying the data product of the beam gate; if explicitly empty, this type of data product will not be dumped; if omitted, an attempt to dump a data product with the same tag as TriggerTag will be performed, and in case of failure no message will be printed.
• ExternalTriggerTag (data product input tag, optional): the tag identifying the data product of the additional standard trigger information; this is a standard LArSoft data product that ICARUS abuses to store information in a portable way. If explicitly empty, this type of data product will not be dumped; if omitted, an attempt to dump a data product with the same tag as TriggerTag will be performed, and in case of failure no message will be printed.
• ExtraTriggerTag (data product input tag, optional): the tag identifying the data product of the detailed trigger information; this is SBN-specific. If explicitly empty, this type of data product will not be dumped; if omitted, an attempt to dump a data product with the same tag as TriggerTag will be performed, and in case of failure no message will be printed.
• Verbosity (integral, default: maximum): verbosity level used in the dump; see sbn::PMTconfiguration::dump() for details.
• OutputCategory (string, default: DumpTrigger): name of the message facility output stream to dump the information into.

Definition at line 95 of file DumpTrigger_module.cc.

Member Typedef Documentation

using sbn::DumpTrigger::electronics_time = detinfo::timescales::electronics_time

private

Definition at line 164 of file DumpTrigger_module.cc.

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

Definition at line 143 of file DumpTrigger_module.cc.

using sbn::DumpTrigger::simulation_time = detinfo::timescales::simulation_time

private

Definition at line 165 of file DumpTrigger_module.cc.

Constructor & Destructor Documentation

sbn::DumpTrigger::DumpTrigger ( Parameters const &  config )

explicit

Definition at line 235 of file DumpTrigger_module.cc.

  : art::EDAnalyzer(config)
  // configuration
  , fTriggerTag    { config().TriggerTag() }
  , fBeamGateTag   { config().BeamGateTag() }
  , fExternalTag   { config().ExternalTriggerTag() }
  , fExtraTag      { config().ExtraTriggerTag() }
  , fVerbosity     { config().Verbosity() }
  , fOutputCategory{ config().OutputCategory() }
{
  
  unsigned int nRequiredTriggers = 0U; // count of required data products
  
  /*
   * data product usage declaration
   */
  nRequiredTriggers += countConsume<std::vector<raw::Trigger>>(fTriggerTag);
  nRequiredTriggers
    += countConsume<std::vector<sim::BeamGateInfo>>(fBeamGateTag);
  nRequiredTriggers
    += countConsume<std::vector<raw::ExternalTrigger>>(fExternalTag);
  nRequiredTriggers += countConsume<sbn::ExtraTriggerInfo>(fExtraTag);
  
  /*
   * parameter check
   */
  if (nRequiredTriggers == 0U) {
    throw art::Exception{ art::errors::Configuration }
      << "At least one trigger data product needs to be specified.\n";
  }
  
  /*
   * print configuration
   */
  mf::LogInfo log{ fOutputCategory };
  log << "Configuration:\n * dump:";
  
  if (fTriggerTag) log << "\n - '" << fTriggerTag->encode() << "' (raw::Trigger)";
  
  if (auto const [ tag, req ] = inputTag(fExternalTag); !tag.empty()) {
    log << "\n - '" << tag.encode() << "' (raw::ExternalTrigger)";
    if (!req) log << " (if available)";
  }
  
  if (auto const [ tag, req ] = inputTag(fExtraTag); !tag.empty()) {
    log << "\n - '" << tag.encode() << "' (sbn::ExtraTriggerInfo)";
    if (!req) log << " (if available)";
  }
  
  if (auto const [ tag, req ] = inputTag(fBeamGateTag); !tag.empty()) {
    log << "\n - '" << tag.encode() << "' (sim::BeamGateInfo)";
    if (!req) log << " (if available)";
  }
  
} // sbn::DumpTrigger::DumpTrigger()

Member Function Documentation

void sbn::DumpTrigger::analyze ( art::Event const &  event )

overridevirtual

Does the dumping.

Definition at line 293 of file DumpTrigger_module.cc.

                                                  {
  
  mf::LogVerbatim{ fOutputCategory }
    << "Trigger information in " << event.id() << ":";
  
  if (auto const [ tag, req ] = inputTag(fTriggerTag); !tag.empty()) {
    
    auto const& handle = event.getHandle<std::vector<raw::Trigger>>(tag);
    if (handle) {
      mf::LogVerbatim{ fOutputCategory }
        << "* raw::Trigger ('" << tag.encode() << "'):";
      dumpTrigger(*handle);
    }
    else if (req) throw *(handle.whyFailed());
  } // simple trigger
  
  
  if (auto const [ tag, req ] = inputTag(fExternalTag); !tag.empty()) {
    
    auto const& handle
      = event.getHandle<std::vector<raw::ExternalTrigger>>(tag);
    if (handle) {
      mf::LogVerbatim{ fOutputCategory }
        << "* raw::ExternalTrigger ('" << tag.encode() << "'):";
      dumpTrigger(*handle);
    }
    else if (req) throw *(handle.whyFailed());
  } // external trigger info
  
  
  if (auto const [ tag, req ] = inputTag(fExtraTag); !tag.empty()) {
    
    auto const& handle = event.getHandle<sbn::ExtraTriggerInfo>(tag);
    if (handle) {
      mf::LogVerbatim{ fOutputCategory }
        << "* sbn::ExtraTriggerInfo ('" << tag.encode() << "'):";
      dumpTrigger(*handle);
    }
    else if (req) throw *(handle.whyFailed());
  } // extra trigger info
  
  
  if (auto const [ tag, req ] = inputTag(fBeamGateTag); !tag.empty()) {
    
    auto const& handle = event.getHandle<std::vector<sim::BeamGateInfo>>(tag);
    if (handle) {
      mf::LogVerbatim{ fOutputCategory }
        << "* sim::BeamGateInfo ('" << tag.encode() << "'):";
      dumpBeamGate(*handle);
    }
    else if (req) throw *(handle.whyFailed());
  } // beam gate
  
  
} // sbn::DumpTrigger::analyze()

template<typename T >

unsigned int sbn::DumpTrigger::countConsume ( std::optional< art::InputTag > const &  param )

private

Returns 1 if the data product of type T specified by param must be available, 0 otherwise. It also declares it will consume it.

Definition at line 472 of file DumpTrigger_module.cc.

{
  auto const [ tag, required ] = inputTag(param);
  if (tag.empty()) return 0;
  if (required) consumes<T>(tag);
  else          mayConsume<T>(tag);
  return required? 1: 0;
} // sbn::DumpTrigger::countConsume()

void sbn::DumpTrigger::dumpBeamGate ( std::vector< sim::BeamGateInfo > const &  gates ) const

private

Dumps a LArSoft beam gate information data product.

Definition at line 415 of file DumpTrigger_module.cc.

{
  
  static std::string const indent(4U, ' ');
  
  if (gates.empty()) {
    mf::LogVerbatim{ fOutputCategory } << indent << "no beam gates.";
    return;
  }
  if (gates.size() > 1) {
    mf::LogVerbatim{ fOutputCategory }
      << indent << "[" << gates.size() << " beam gates]";
  }
  
  for (auto const& [ iGate, gate]: util::enumerate(gates)) {
    mf::LogVerbatim log { fOutputCategory };
    log << indent;
    simulation_time const start { gate.Start() };
    simulation_time const end { gate.Start() + gate.Width() };
    if (gates.size() > 1) log << "[" << iGate << "] ";
    log << "beam gate [ " << start << " -- " << end << " ] (duration: "
      << (end - start) << ") of type ";
    switch (gate.BeamType()) {
      case sim::kBNB:     log << "BNB"; break;
      case sim::kNuMI:    log << "NuMI"; break;
      case sim::kUnknown: log << "unknown"; break;
      default:
        log << "unsupported [code=" << static_cast<int>(gate.BeamType()) << "]";
    } // switch
  
  } // for
  
} // sbn::DumpTrigger::dumpBeamGate()

void sbn::DumpTrigger::dumpTrigger ( std::vector< raw::Trigger > const &  triggers ) const

private

Dumps a simple LArSoft trigger data product.

Definition at line 352 of file DumpTrigger_module.cc.

{
  static std::string const indent(4U, ' ');
  
  if (triggers.empty()) {
    mf::LogVerbatim{ fOutputCategory } << indent << "no triggers.";
    return;
  }
  if (triggers.size() > 1) {
    mf::LogVerbatim{ fOutputCategory }
      << indent << "[" << triggers.size() << " triggers]";
  }
  
  for (auto const& [ iTrigger, trigger]: util::enumerate(triggers)) {
    mf::LogVerbatim log { fOutputCategory };
    log << indent;
    if (triggers.size() > 1) log << "[" << iTrigger << "] ";
    log << "trigger #" << trigger.TriggerNumber() << " at "
      << electronics_time{ trigger.TriggerTime() }
      << ", beam gate at " << electronics_time{ trigger.BeamGateTime() }
      << ", bits:";
    if (sbn::bits::triggerSourceMask const bitMask{ trigger.TriggerBits() }) {
      log << " {";
      for (std::string const& name: names(bitMask)) log << " " << name;
      log << " }";
    }
    else log << " none";
  
  } // for
  
} // sbn::DumpTrigger::dumpTrigger()

void sbn::DumpTrigger::dumpTrigger ( std::vector< raw::ExternalTrigger > const &  triggers ) const

private

Dumps a LArSoft external trigger data product.

Definition at line 387 of file DumpTrigger_module.cc.

{
  
  static std::string const indent(4U, ' ');
  
  if (triggers.empty()) {
    mf::LogVerbatim{ fOutputCategory } << indent << "no triggers.";
    return;
  }
  if (triggers.size() > 1) {
    mf::LogVerbatim{ fOutputCategory }
      << indent << "[" << triggers.size() << " triggers]";
  }
  
  for (auto const& [ iTrigger, trigger]: util::enumerate(triggers)) {
    mf::LogVerbatim log { fOutputCategory };
    log << indent;
    if (triggers.size() > 1) log << "[" << iTrigger << "] ";
    log << "trigger ID=" << trigger.GetTrigID()
      << " at " << dumpTimestamp(trigger.GetTrigTime());
  
  } // for
  
} // sbn::DumpTrigger::dumpTrigger(ExternalTrigger)

void sbn::DumpTrigger::dumpTrigger ( sbn::ExtraTriggerInfo const &  trigger ) const

private

Dumps a SBN trigger information data product.

Definition at line 451 of file DumpTrigger_module.cc.

                                                                         {
  
  static std::string const indent(4U, ' ');
  
  mf::LogVerbatim{ fOutputCategory } << util::addIndent(indent) << trigger;
  
} // sbn::DumpTrigger::dumpTrigger(ExtraTriggerInfo)

std::pair< art::InputTag, bool > sbn::DumpTrigger::inputTag ( std::optional< art::InputTag > const &  tag ) const

private

Returns the tag to try, and whether it is mandatory to find it.

Definition at line 462 of file DumpTrigger_module.cc.

{
  return
    { tag.value_or(fTriggerTag.value_or(art::InputTag{})), tag.has_value() };
} // sbn::DumpTrigger::inputTag()

Member Data Documentation

std::optional<art::InputTag> const sbn::DumpTrigger::fBeamGateTag

private

Input beam gate tag.

Definition at line 172 of file DumpTrigger_module.cc.

std::optional<art::InputTag> const sbn::DumpTrigger::fExternalTag

private

Input additional trigger tag.

Definition at line 175 of file DumpTrigger_module.cc.

std::optional<art::InputTag> const sbn::DumpTrigger::fExtraTag

private

Definition at line 177 of file DumpTrigger_module.cc.

std::string const sbn::DumpTrigger::fOutputCategory

private

Category used for message facility stream.

Definition at line 182 of file DumpTrigger_module.cc.

std::optional<art::InputTag> const sbn::DumpTrigger::fTriggerTag

private

Input trigger tag.

Definition at line 170 of file DumpTrigger_module.cc.

unsigned int const sbn::DumpTrigger::fVerbosity

private

Input extra trigger tag.

Verbosity level used for dumping.

Definition at line 179 of file DumpTrigger_module.cc.

---

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

• DumpTrigger_module.cc