detsim::DumpRawDigits Class Reference

Prints the content of all the raw digits on screen. More...

Inheritance diagram for detsim::DumpRawDigits:

Classes
struct	Config

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

Public Member Functions
	DumpRawDigits (Parameters const &config)
	Constructor. More...
virtual void	beginJob () override
	Prints an introduction. More...
virtual void	analyze (art::Event const &evt) override
	Does the printing. More...

Private Types
using	Digit_t = raw::RawDigit::ADCvector_t::value_type
	Type to represent a digit. More...
using	Pedestal_t = Digit_t
	Type to represent a pedestal. More...

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

Private Attributes
art::InputTag	fDetSimModuleLabel
	Tag for digits data product. More...
std::string	fOutputCategory
	Category for LogVerbatim output. More...
unsigned int	fDigitsPerLine
	Ticks/digits per line in the output. More...
Pedestal_t	fPedestal
	ADC pedestal, will be subtracted from digits. More...

Detailed Description

Prints the content of all the raw digits on screen.

This analyser prints the content of all the raw digits into the LogVerbatim stream.

Configuration parameters

• DetSimModuleLabel (string, default: "daq"): label of the producer used to create the raw::RawDigits collection
• OutputCategory (string, default: "DumpDigits"): 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
• Pedestal (integer, default: 0): digit values are written relative to this number

Definition at line 54 of file DumpRawDigits_module.cc.

Member Typedef Documentation

using detsim::DumpRawDigits::Digit_t = raw::RawDigit::ADCvector_t::value_type

private

Type to represent a digit.

Definition at line 57 of file DumpRawDigits_module.cc.

using detsim::DumpRawDigits::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 94 of file DumpRawDigits_module.cc.

using detsim::DumpRawDigits::Pedestal_t = Digit_t

private

Type to represent a pedestal.

Definition at line 60 of file DumpRawDigits_module.cc.

Constructor & Destructor Documentation

detsim::DumpRawDigits::DumpRawDigits ( Parameters const &  config )

explicit

Constructor.

Definition at line 128 of file DumpRawDigits_module.cc.

  : EDAnalyzer         (config)
  , fDetSimModuleLabel(config().DetSimModuleLabel())
  , fOutputCategory   (config().OutputCategory())
  , fDigitsPerLine    (config().DigitsPerLine())
  , fPedestal         (config().Pedestal())
  {}

Member Function Documentation

void detsim::DumpRawDigits::analyze ( art::Event const &  evt )

overridevirtual

Does the printing.

Definition at line 149 of file DumpRawDigits_module.cc.

                                                     {

  auto const& RawDigits
    = *(evt.getValidHandle<std::vector<raw::RawDigit>>(fDetSimModuleLabel));

  mf::LogVerbatim(fOutputCategory) << "Event " << evt.id()
    << " contains " << RawDigits.size() << " '" << fDetSimModuleLabel.encode()
    << "' waveforms";
  for (raw::RawDigit const& digits: RawDigits) {

    PrintRawDigit(mf::LogVerbatim(fOutputCategory), digits);

  } // for digits

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

void detsim::DumpRawDigits::beginJob ( )

overridevirtual

Prints an introduction.

Definition at line 138 of file DumpRawDigits_module.cc.

                                   {

  if (fPedestal != 0) {
    mf::LogVerbatim(fOutputCategory) << "A pedestal of " << fPedestal
      << " will be subtracted from all raw digits";
  } // if pedestal

} // detsim::DumpRawDigits::beginJob()

template<typename Stream >

void detsim::DumpRawDigits::PrintRawDigit ( Stream &&  out, raw::RawDigit const &  digits, std::string  indent = "  ", std::string  firstIndent = "  "  ) const

private

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

Definition at line 168 of file DumpRawDigits_module.cc.

        {

  //
  // uncompress the digits
  //
  raw::RawDigit::ADCvector_t ADCs(digits.Samples());
  raw::Uncompress(digits.ADCs(), ADCs, digits.Compression());

  //
  // print a header for the raw digits
  //
  out << firstIndent
    << "  #" << digits.Channel() << ": " << ADCs.size() << " time ticks";
  if (digits.Samples() != ADCs.size())
    out << " [!!! EXPECTED " << digits.Samples() << "] ";
  out
    << " (" << digits.NADC() << " after compression); compression type: ";
  switch (digits.Compression()) {
    case raw::kNone:            out << "no compression"; break;
    case raw::kHuffman:         out << "Huffman encoding" ; break;
    case raw::kZeroSuppression: out << "zero suppression"; break;
    case raw::kZeroHuffman:     out << "zero suppression + Huffman encoding";
                                break;
    case raw::kDynamicDec:      out << "dynamic decimation"; break;
    default:
      out << "unknown (#" << ((int) digits.Compression()) << ")"; break;
  } // switch

  // print the content of the channel
  if (fDigitsPerLine > 0) {
    std::vector<Digit_t> DigitBuffer(fDigitsPerLine), LastBuffer;

    unsigned int repeat_count = 0; // additional lines like the last one
    unsigned int index = 0;
    lar::util::MinMaxCollector<Digit_t> Extrema;
    out << "\n" << indent
      << "content of the channel (" << fDigitsPerLine << " ticks per line):";
    auto iTick = ADCs.cbegin(), tend = ADCs.cend(); // const iterators
    while (iTick != tend) {
      // the next line will show at most fDigitsPerLine ticks
      unsigned int line_size
        = std::min(fDigitsPerLine, (unsigned int) ADCs.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));
      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 << " ";
      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
    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

} // detsim::DumpRawDigits::analyze()

Member Data Documentation

art::InputTag detsim::DumpRawDigits::fDetSimModuleLabel

private

Tag for digits data product.

Definition at line 108 of file DumpRawDigits_module.cc.

unsigned int detsim::DumpRawDigits::fDigitsPerLine

private

Ticks/digits per line in the output.

Definition at line 110 of file DumpRawDigits_module.cc.

std::string detsim::DumpRawDigits::fOutputCategory

private

Category for LogVerbatim output.

Definition at line 109 of file DumpRawDigits_module.cc.

Pedestal_t detsim::DumpRawDigits::fPedestal

private

ADC pedestal, will be subtracted from digits.

Definition at line 111 of file DumpRawDigits_module.cc.

---

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

• DumpRawDigits_module.cc