caldata::DumpWires Class Reference

Prints the content of all the wires on screen. More...

Inheritance diagram for caldata::DumpWires:

Classes
struct	Config

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

Public Member Functions
	DumpWires (Parameters const &config)
	Constructor. More...
virtual void	analyze (art::Event const &evt) override
	Does the printing. More...

Private Member Functions
template<typename Stream >
void	PrintWire (Stream &&out, recob::Wire const &wire, std::string indent=" ", std::string firstIndent=" ") const
	Dumps a single recob:Wire to the specified output stream. More...

Private Attributes
art::InputTag	fCalWireModuleLabel
	Input tag for wires. More...
std::string	fOutputCategory
	Category for LogVerbatim output. More...
unsigned int	fDigitsPerLine
	Ticks/digits per line in the output. More...

Detailed Description

Prints the content of all the wires on screen.

This analyser prints the content of all the wires into the LogVerbatim stream.

Configuration parameters

• CalWireModuleLabel (string, default: "caldata"): label of the producer used to create the recob::Wire collection to be dumped
• OutputCategory (string, default: "DumpWires"): the category used for the output (useful for filtering)
• DigitsPerLine (integer, default: 20): the dump of digits and ticks will put this many of them for each line; 0 suppresses digit printout

Definition at line 71 of file DumpWires_module.cc.

Member Typedef Documentation

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

Definition at line 98 of file DumpWires_module.cc.

Constructor & Destructor Documentation

caldata::DumpWires::DumpWires ( Parameters const &  config )

explicit

Constructor.

Definition at line 128 of file DumpWires_module.cc.

  : EDAnalyzer         (config)
  , fCalWireModuleLabel(config().CalWireModuleLabel())
  , fOutputCategory    (config().OutputCategory())
  , fDigitsPerLine     (config().DigitsPerLine())
  {}

Member Function Documentation

void caldata::DumpWires::analyze ( art::Event const &  evt )

overridevirtual

Does the printing.

Definition at line 137 of file DumpWires_module.cc.

                                                  {

  auto const& Wires
    = *(evt.getValidHandle<std::vector<recob::Wire>>(fCalWireModuleLabel));

  mf::LogVerbatim(fOutputCategory) << "Event " << evt.id()
    << " contains " << Wires.size() << " '" << fCalWireModuleLabel.encode()
    << "' wires";

  for (recob::Wire const& wire: Wires) {

    PrintWire(mf::LogVerbatim(fOutputCategory), wire);

  } // for wire

} // caldata::DumpWires::analyze()

template<typename Stream >

void caldata::DumpWires::PrintWire ( Stream &&  out, recob::Wire const &  wire, std::string  indent = "  ", std::string  firstIndent = "  "  ) const

private

Dumps a single recob:Wire to the specified output stream.

Definition at line 157 of file DumpWires_module.cc.

        {

  using RegionsOfInterest_t = recob::Wire::RegionsOfInterest_t;

  RegionsOfInterest_t const & RoIs = wire.SignalROI();

  //
  // print a header for the wire
  //
  out << firstIndent << "channel #" << wire.Channel() << " on view "
    << ViewName(wire.View()) << "; " << wire.NSignal() << " time ticks";
  if (wire.NSignal() != RoIs.size())
    out << " [!!! EXPECTED " << RoIs.size() << "]";
  if (RoIs.n_ranges() == 0) {
    out << " with nothing in them";
    return;
  }
  out << " with " << RoIs.n_ranges() << " regions of interest:";

  //
  // print the list of regions of interest
  //
  for (RegionsOfInterest_t::datarange_t const& RoI: RoIs.get_ranges()) {
    out << "\n" << indent
      << "  from " << RoI.offset << " for " << RoI.size() << " ticks";
  } // for

  //
  // print the content of the wire
  //
  if (fDigitsPerLine > 0) {

    std::vector<RegionsOfInterest_t::value_type> DigitBuffer(fDigitsPerLine),
      LastBuffer;

    unsigned int repeat_count = 0; // additional lines like the last one
    unsigned int index = 0;
    lar::util::MinMaxCollector<RegionsOfInterest_t::value_type> Extrema;
    out << "\n" << indent
      << "  content of the wire (" << fDigitsPerLine << " ticks per line):";
    auto iTick = RoIs.cbegin(), tend = RoIs.cend();
    while (iTick != tend) {
      // the next line will show at most fDigitsPerLine ticks
      unsigned int line_size
        = std::min(fDigitsPerLine, (unsigned int) RoIs.size() - index);
      if (line_size == 0) break; // no more ticks

      // fill the new buffer (iTick will move forward)
      DigitBuffer.resize(line_size);
      auto iBuf = DigitBuffer.begin(), bend = DigitBuffer.end();
      while ((iBuf != bend) && (iTick != tend))
        Extrema.add(*(iBuf++) = *(iTick++));
      index += line_size;

      // if the new buffer is the same as the old one, just mark it
      if (DigitBuffer == LastBuffer) {
        repeat_count += 1;
        continue;
      }

      // if there are previous repeats, write that on screen
      // before the new, different line
      if (repeat_count > 0) {
        out << "\n" << indent
          << "  [ ... repeated " << repeat_count << " more times, "
          << (repeat_count * LastBuffer.size()) << " ticks ]";
        repeat_count = 0;
      }

      // dump the new line of ticks
      out << "\n" << indent
        << " " << std::fixed << std::setprecision(3);
      for (auto digit: DigitBuffer) out << std::setw(8) << digit;

      // quick way to assign DigitBuffer to LastBuffer
      // (we don't care we lose the former)
      std::swap(LastBuffer, DigitBuffer);

    } // while
    if (repeat_count > 0) {
      out << "\n" << indent
        << "  [ ... repeated " << repeat_count << " more times to the end ]";
    }
    if (Extrema.min() < Extrema.max()) {
      out << "\n" << indent
        << "    range of " << index
        << " samples: [" << Extrema.min() << ";" << Extrema.max() << "]";
    }
  } // if dumping the ticks

} // caldata::DumpWires::PrintWire()

Member Data Documentation

art::InputTag caldata::DumpWires::fCalWireModuleLabel

private

Input tag for wires.

Definition at line 109 of file DumpWires_module.cc.

unsigned int caldata::DumpWires::fDigitsPerLine

private

Ticks/digits per line in the output.

Definition at line 111 of file DumpWires_module.cc.

std::string caldata::DumpWires::fOutputCategory

private

Category for LogVerbatim output.

Definition at line 110 of file DumpWires_module.cc.

---

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

• DumpWires_module.cc