dump::raw::OpDetWaveformDumper Class Reference

Prints the content of optical detector waveforms on screen. More...

#include "OpDetWaveform.h"

Inheritance diagram for dump::raw::OpDetWaveformDumper:

Classes
struct	TickLabelMaker
	Time label: tick number relative to the waveform. More...
struct	TimeLabelMaker
	Base functor for printing time according to tick number. More...

Public Member Functions
	OpDetWaveformDumper (raw::ADC_Count_t pedestal=0, unsigned int digitsPerLine=0U)
	Constructor: sets waveform dump parameters. More...
void	setTimeLabelMaker (TimeLabelMaker const *timeLabelMaker)
	Chooses which time label maker to use. More...
template<typename Stream >
void	dump (Stream &&stream, raw::OpDetWaveform const &waveform)
	Dumps the content of a waveform into the specified output stream. More...
template<typename Stream >
void	operator() (Stream &&stream, raw::OpDetWaveform const &waveform)
	An alias of dump(). More...
template<typename Stream >
decltype(auto)	indenter (Stream &&out) const
	Returns an Indenter object tied to this dumper and out stream. More...
Indentation.
Indentation strings are expected to be written by the dumping algorithms at the beginning of each output line to ensure the proper alignment of the dump. The indent() string should be written at the beginning of every new output line, with the exception of the first one, for which firstIndent() should be written instead. Note that this infrastructure only keeps track of the strings needed to indent the output, but it does not provide any tool to apply the indentation.
std::string const &	indent () const
	Returns the indentation string currently configured for all lines. More...
std::string const &	firstIndent () const
	Returns the indentation string currently configured for the first line. More...
void	setIndent (std::string const &indent, std::string const &firstIndent)
	Sets indentation strings to the specified values. More...
void	setIndent (std::string const &indent)
	Sets both indentation strings to the same specified value. More...
template<typename Stream >
Stream &	indented (Stream &&out, bool first=false) const
	Writes the indentation into a stream, and returns it for further output. More...
template<typename Stream >
Stream &	firstIndented (Stream &&out) const
template<typename Stream >
Stream &	newline (Stream &&out) const

Static Public Member Functions
static std::string	padRight (std::string const &s, unsigned int width, std::string padding=" ")
	Pads the specified string to the right, truncating its right if needed. More...
static unsigned int	digitsOf (unsigned int n)
	Pads the specified string to the right, truncating its right if needed. More...

Protected Member Functions
IndentSettings &	indentSettings ()
IndentSettings const &	indentSettings () const
IndentSettings &	saveIndentSettings ()
	Stacks a copy of the current settings, and returns the "new" ones. More...
IndentSettings &	restoreIndentSettings ()
	Restores and returns the last saved settings. More...

Private Attributes
raw::ADC_Count_t	fPedestal
	ADC pedestal (subtracted from readings). More...
unsigned int	fDigitsPerLine
	ADC readings per line in the output. More...
TimeLabelMaker const *	fTimeLabelMaker = nullptr
	The functor to be used to extract the time label. More...

Detailed Description

Prints the content of optical detector waveforms on screen.

Example of usage:

dump::raw::OpDetWaveformDumper dump;
dump.setIndent("  ");

for (raw::OpDetWaveform const& waveform: waveforms)
  dump(mf::LogVerbatim("dumper"), waveform);

Definition at line 43 of file OpDetWaveform.h.

Constructor & Destructor Documentation

dump::raw::OpDetWaveformDumper::OpDetWaveformDumper ( raw::ADC_Count_t  pedestal = 0, unsigned int  digitsPerLine = 0U  )

inline

Constructor: sets waveform dump parameters.

Parameters

pedestal	(default: 0) the pedestal to be automatically added to all digits
digitsPerLine	(default: 0) how many ADC digits to print per line; 0 disables the digit printing completely

Note that no indentation is set. If some is desired, set it with setIndent() after construction.

Definition at line 89 of file OpDetWaveform.h.

      : fPedestal(pedestal), fDigitsPerLine(digitsPerLine)
    {}

Member Function Documentation

unsigned int dump::raw::OpDetWaveformDumper::digitsOf ( unsigned int  n )

static

Pads the specified string to the right, truncating its right if needed.

Definition at line 278 of file OpDetWaveform.h.

Referenced by dump::raw::OpDetWaveformDumper::TickLabelMaker::labelWidth(), and operator()().

{
  unsigned int digits = 1U;
  while (n >= 10) {
    ++digits;
    n /= 10;
  }
  return digits;
} // dump::raw::OpDetWaveformDumper::digitsOf()

template<typename Stream >

void dump::raw::OpDetWaveformDumper::dump	(	Stream &&	stream,
		raw::OpDetWaveform const &	waveform
	)

Dumps the content of a waveform into the specified output stream.

Template Parameters

Stream

type of stream to dump data into

Parameters

stream	stream to dump data into
waveform	the object to be dumped

Indentation is regulated via base class methods (see setIndent()).

Definition at line 148 of file OpDetWaveform.h.

References lar::util::MinMaxCollector< T >::add(), raw::OpDetWaveform::ChannelNumber(), fDigitsPerLine, fPedestal, fTimeLabelMaker, dump::DumperBase::indent(), dump::DumperBase::indenter(), dump::raw::OpDetWaveformDumper::TimeLabelMaker::label(), dump::raw::OpDetWaveformDumper::TimeLabelMaker::labelWidth(), lar::util::MinMaxCollector< T >::max(), lar::util::MinMaxCollector< T >::min(), padRight(), dump::DumperBase::restoreIndentSettings(), dump::DumperBase::saveIndentSettings(), dump::DumperBase::IndentSettings::set(), and raw::OpDetWaveform::TimeStamp().

Referenced by operator()(), and setTimeLabelMaker().

{
  static std::string const headerSep = " | ";

  auto const& data = waveform;
  using Count_t = raw::ADC_Count_t;

  auto out = indenter(std::forward<Stream>(stream));

  // print a header for the raw digits
  out.start() << "on channel #" << waveform.ChannelNumber()
              << " (time stamp: " << waveform.TimeStamp() << "): " << data.size() << " time ticks";

  // print the content of the channel
  if (fDigitsPerLine == 0) return;

  // save and change indentation
  saveIndentSettings().set(indent() + "  ");

  unsigned int repeat_count = 0U; // additional lines like the last one
  unsigned int index = 0U;
  unsigned int firstLineTick = 0U;

  // local function for printing and resetting the repeat count
  auto flushRepeatCount =
    [this, &out, &waveform, &firstLineTick](unsigned int& count) -> decltype(auto) {
    if (count > 0) {
      out.newline();
      if (fTimeLabelMaker) {
        out << padRight("", fTimeLabelMaker->labelWidth(waveform, firstLineTick)) << headerSep;
      }
      out << " [ ... repeated " << count << " more times ]";
      count = 0;
    }
    return out;
  };

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

  lar::util::MinMaxCollector<Count_t> Extrema;
  out.newline() << "content of the channel (" << fDigitsPerLine << " ticks per line):";
  auto iTick = data.cbegin(), tend = data.cend(); // const iterators
  while (iTick != tend) {
    // the next line will show at most fDigitsPerLine ticks
    unsigned int line_size = std::min(fDigitsPerLine, (unsigned int)data.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++) - fPedestal);
    firstLineTick = index;
    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
    flushRepeatCount(repeat_count);

    // dump the new line of ticks
    out.newline();
    if (fTimeLabelMaker) {
      out << padRight(fTimeLabelMaker->label(waveform, firstLineTick),
                      fTimeLabelMaker->labelWidth(waveform, firstLineTick))
          << headerSep;
    }
    for (auto digit : DigitBuffer)
      out << " " << std::setw(4) << digit;

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

  } // while
  flushRepeatCount(repeat_count);
  if (Extrema.min() != Extrema.max()) {
    out.newline() << "  range of " << data.size() << " samples: [" << Extrema.min() << ";"
                  << Extrema.max() << "] (span: " << (Extrema.max() - Extrema.min());
    if (fPedestal != 0) {
      out << ", absolute: [" << (Extrema.min() + fPedestal) << ";" << (Extrema.max() + fPedestal)
          << "]";
    }
    out << ")";
  }

  restoreIndentSettings();

} // dump::raw::OpDetWaveformDumper::dump()

std::string const& dump::DumperBase::firstIndent ( ) const

inlineinherited

Returns the indentation string currently configured for the first line.

Definition at line 98 of file DumperBase.h.

References dump::DumperBase::IndentSettings::firstIndent, and dump::DumperBase::indentSettings().

Referenced by dump::DumperBase::Indenter< Stream >::firstIndentString().

{ return indentSettings().firstIndent; }

template<typename Stream >

Stream& dump::DumperBase::firstIndented ( Stream &&  out ) const

inlineinherited

Writes first line indentation into a stream, and returns it for further output.

Definition at line 120 of file DumperBase.h.

References dump::DumperBase::indented().

    {
      return indented(std::forward<Stream>(out), true);
    }

std::string const& dump::DumperBase::indent ( ) const

inlineinherited

Returns the indentation string currently configured for all lines.

Definition at line 95 of file DumperBase.h.

References dump::DumperBase::IndentSettings::indent, and dump::DumperBase::indentSettings().

Referenced by dump(), and dump::DumperBase::Indenter< Stream >::indentString().

{ return indentSettings().indent; }

template<typename Stream >

Stream& dump::DumperBase::indented ( Stream &&  out, bool  first = false  ) const

inlineinherited

Writes the indentation into a stream, and returns it for further output.

Definition at line 111 of file DumperBase.h.

References dump::DumperBase::IndentSettings::firstIndent, and dump::DumperBase::IndentSettings::indent.

Referenced by dump::DumperBase::firstIndented(), dump::DumperBase::Indenter< Stream >::indent(), and dump::DumperBase::newline().

    {
      out << (first ? firstIndent() : indent());
      return out;
    }

template<typename Stream >

decltype(auto) dump::DumperBase::indenter ( Stream &&  out ) const

inlineinherited

Returns an Indenter object tied to this dumper and out stream.

Definition at line 215 of file DumperBase.h.

Referenced by dump().

    {
      return Indenter<Stream>(std::forward<Stream>(out), *this);
    }

IndentSettings& dump::DumperBase::indentSettings ( )

inlineprotectedinherited

Definition at line 221 of file DumperBase.h.

Referenced by dump::DumperBase::firstIndent(), dump::DumperBase::indent(), dump::DumperBase::restoreIndentSettings(), dump::DumperBase::saveIndentSettings(), and dump::DumperBase::setIndent().

{ return fIndentSettings.back(); }

IndentSettings const& dump::DumperBase::indentSettings ( ) const

inlineprotectedinherited

Definition at line 222 of file DumperBase.h.

{ return fIndentSettings.back(); }

template<typename Stream >

Stream& dump::DumperBase::newline ( Stream &&  out ) const

inlineinherited

Initiates a new output line, including indentation, and returns the stream for further output.

Definition at line 128 of file DumperBase.h.

References dump::DumperBase::indented().

    {
      return indented(std::forward<Stream>(out));
    }

template<typename Stream >

void dump::raw::OpDetWaveformDumper::operator() ( Stream &&  stream, raw::OpDetWaveform const &  waveform  )

inline

An alias of dump().

Definition at line 120 of file OpDetWaveform.h.

References digitsOf(), dump(), n, and padRight().

    {
      dump(stream, waveform);
    }

std::string dump::raw::OpDetWaveformDumper::padRight ( std::string const &  s, unsigned int  width, std::string  padding = " "  )

static

Pads the specified string to the right, truncating its right if needed.

Definition at line 244 of file OpDetWaveform.h.

Referenced by dump(), and operator()().

{

  if (s.length() > width) { // too long already?
    // truncate on the right
    return {s, 0U, width}; // { string, start index, character count }
  }

  std::string padded;
  padded.reserve(width);

  // this is how many full padding strings we need to prepend
  unsigned int nPadding = (s.length() >= width) ? 0U : (width - s.length()) / padding.length();

  // if there is need for some more partial padding beyond that:
  if (nPadding * padding.length() + s.length() < width) {
    // immediately prepend from the rightmost part of the padding string
    padded.append(padding.end() - (width - (nPadding * padding.length() + s.length())),
                  padding.end());
  }

  // add the rest of the padding and the string, and then we are done
  while (nPadding-- > 0)
    padded += padding;
  padded += s;

  assert(padded.length() == width);

  return padded;
} // dump::raw::OpDetWaveformDumper::padRight()

IndentSettings& dump::DumperBase::restoreIndentSettings ( )

inlineprotectedinherited

Restores and returns the last saved settings.

Definition at line 233 of file DumperBase.h.

References dump::DumperBase::indentSettings().

Referenced by dump().

    {
      if (fIndentSettings.size() > 1U) fIndentSettings.pop_back();
      assert(!fIndentSettings.empty());
      return indentSettings();
    }

IndentSettings& dump::DumperBase::saveIndentSettings ( )

inlineprotectedinherited

Stacks a copy of the current settings, and returns the "new" ones.

Definition at line 225 of file DumperBase.h.

References dump::DumperBase::indentSettings().

Referenced by dump().

    {
      auto oldSettings = indentSettings();
      fIndentSettings.push_back(std::move(oldSettings));
      return indentSettings();
    }

void dump::DumperBase::setIndent ( std::string const &  indent, std::string const &  firstIndent  )

inlineinherited

Sets indentation strings to the specified values.

Definition at line 101 of file DumperBase.h.

References dump::DumperBase::IndentSettings::indent, and dump::DumperBase::indentSettings().

    {
      indentSettings() = {indent, firstIndent};
    }

void dump::DumperBase::setIndent ( std::string const &  indent )

inlineinherited

Sets both indentation strings to the same specified value.

Definition at line 107 of file DumperBase.h.

References dump::DumperBase::setIndent().

Referenced by dump::DumperBase::setIndent().

{ setIndent(indent, indent); }

void dump::raw::OpDetWaveformDumper::setTimeLabelMaker ( TimeLabelMaker const *  timeLabelMaker )

inline

Chooses which time label maker to use.

Parameters

timeLabelMaker

a pointer to the external time label maker

A time label maker is an object derived from TimeLabelMaker which can convert a waveform and tick into a string representing that tick within the waveform. If never specified or if nullptr, no time label will be printed at all.

Definition at line 102 of file OpDetWaveform.h.

References dump(), and fTimeLabelMaker.

    {
      fTimeLabelMaker = timeLabelMaker;
    }

Member Data Documentation

unsigned int dump::raw::OpDetWaveformDumper::fDigitsPerLine

private

ADC readings per line in the output.

Definition at line 135 of file OpDetWaveform.h.

Referenced by dump().

raw::ADC_Count_t dump::raw::OpDetWaveformDumper::fPedestal

private

ADC pedestal (subtracted from readings).

Definition at line 134 of file OpDetWaveform.h.

Referenced by dump().

TimeLabelMaker const* dump::raw::OpDetWaveformDumper::fTimeLabelMaker = nullptr

private

The functor to be used to extract the time label.

Definition at line 138 of file OpDetWaveform.h.

Referenced by dump(), and setTimeLabelMaker().

---

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

• lardataalg/v09_17_03/source/lardataalg/Dumpers/RawData/OpDetWaveform.h