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 >

using	ModuleType = EDAnalyzer

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...

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

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 53 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 56 of file DumpRawDigits_module.cc.

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

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

Definition at line 92 of file DumpRawDigits_module.cc.

using detsim::DumpRawDigits::Pedestal_t = Digit_t

private

Type to represent a pedestal.

Definition at line 59 of file DumpRawDigits_module.cc.

Constructor & Destructor Documentation

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

explicit

Constructor.

Definition at line 123 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.

Implements art::EDAnalyzer.

Definition at line 143 of file DumpRawDigits_module.cc.

References art::InputTag::encode(), fDetSimModuleLabel, fOutputCategory, art::ProductRetriever::getValidHandle(), art::Event::id(), and PrintRawDigit().

 {
 
   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.

Reimplemented from art::EDAnalyzer.

Definition at line 132 of file DumpRawDigits_module.cc.

References fOutputCategory, and fPedestal.

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

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

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 160 of file DumpRawDigits_module.cc.

References raw::RawDigit::ADCs(), lar::util::MinMaxCollector< T >::add(), raw::RawDigit::Channel(), raw::RawDigit::Compression(), DEFINE_ART_MODULE, fDigitsPerLine, fPedestal, raw::kDynamicDec, raw::kHuffman, raw::kNone, raw::kZeroHuffman, raw::kZeroSuppression, lar::util::MinMaxCollector< T >::max(), lar::util::MinMaxCollector< T >::min(), raw::RawDigit::NADC(), raw::RawDigit::Samples(), and raw::Uncompress().

Referenced by analyze().

 {
 
   //
   // 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()

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

art::InputTag detsim::DumpRawDigits::fDetSimModuleLabel

private

Tag for digits data product.

Definition at line 104 of file DumpRawDigits_module.cc.

Referenced by analyze().

unsigned int detsim::DumpRawDigits::fDigitsPerLine

private

Ticks/digits per line in the output.

Definition at line 106 of file DumpRawDigits_module.cc.

Referenced by PrintRawDigit().

std::string detsim::DumpRawDigits::fOutputCategory

private

Category for LogVerbatim output.

Definition at line 105 of file DumpRawDigits_module.cc.

Referenced by analyze(), and beginJob().

Pedestal_t detsim::DumpRawDigits::fPedestal

private

ADC pedestal, will be subtracted from digits.

Definition at line 107 of file DumpRawDigits_module.cc.

Referenced by beginJob(), and PrintRawDigit().

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

lardata/v09_16_03/source/lardata/ArtDataHelper/Dumpers/DumpRawDigits_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation