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

Inheritance diagram for detsim::DumpOpDetWaveforms:

Classes
struct	Config

struct	TimestampLabelMaker
	Base functor for printing time according to tick number. More...

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

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpOpDetWaveforms (Parameters const &config)

void	analyze (const art::Event &evt)
	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
enum	sortMode { sortMode::DataProductOrder, sortMode::ChannelAndTime }

Static Private Member Functions
static std::vector< std::vector< raw::OpDetWaveform const * > >	groupByChannel (std::vector< raw::OpDetWaveform > const &waveforms)
	Returns pointers to all waveforms in a vector with channel as index. More...

static void	sortByTimestamp (std::vector< raw::OpDetWaveform const * > &waveforms)
	Sorts all the waveforms in the vector by growing timestamp. More...

Private Attributes
art::InputTag	fOpDetWaveformsTag
	Input tag of data product to dump. More...

std::string	fOutputCategory
	Category for `mf::LogInfo` output. More...

unsigned int	fDigitsPerLine
	ADC readings per line in the output. More...

raw::ADC_Count_t	fPedestal
	ADC pedestal (subtracted from readings). More...

sortMode	fSortByChannelAndTime
	How to sort the waveforms in the dump. More...

std::unique_ptr< dump::raw::OpDetWaveformDumper::TimeLabelMaker >	fTimeLabel
	The object used to print tick labels. More...

Detailed Description

Prints the content of all optical detector waveforms on screen.

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

Configuration parameters

OpDetWaveformsTag (string, default: daq): input tag of the raw::OpDetWaveform collection to be dumped
OutputCategory (string, default: DumpOpDetWaveforms): the category used for the output (useful for filtering)
DigitsPerLine (integer, default: 20): the dump of ADC readings will put this many of them for each line
Pedestal (integer, default: 0): ADC readings are written relative to this number
TickLabel (string, default: "tick"): a preamble to each line of the dumped waveform digits, chosen among:
- "tick": the tick number of the waveform is printed (starts at 0)
- "time": timestamp (µs) of the first tick in the row
- "none": no preamble written at all

Definition at line 58 of file DumpOpDetWaveforms_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

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

Definition at line 98 of file DumpOpDetWaveforms_module.cc.

Member Enumeration Documentation

enum detsim::DumpOpDetWaveforms::sortMode

strongprivate

Enumerator
DataProductOrder	Unsorted: same order as the input data product.
ChannelAndTime	Sort by PMT channel number, then timestamp.

Definition at line 106 of file DumpOpDetWaveforms_module.cc.

                         {
       DataProductOrder, 
       ChannelAndTime    
     };                  // sortMode

Constructor & Destructor Documentation

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

explicit

Definition at line 150 of file DumpOpDetWaveforms_module.cc.

References art::errors::Configuration, and fTimeLabel.

     : EDAnalyzer(config)
     , fOpDetWaveformsTag(config().OpDetWaveformsTag())
     , fOutputCategory(config().OutputCategory())
     , fDigitsPerLine(config().DigitsPerLine())
     , fPedestal(config().Pedestal())
     , fSortByChannelAndTime(config().SortByChannelAndTime() ? sortMode::ChannelAndTime :
                                                               sortMode::DataProductOrder)
   {
     std::string const tickLabelStr = config().TickLabel();
     if (tickLabelStr == "none") {
       fTimeLabel.reset(); // not very useful, but let's be explicit
     }
     else if (tickLabelStr == "tick") {
       fTimeLabel = std::make_unique<dump::raw::OpDetWaveformDumper::TickLabelMaker>();
     }
     else if (tickLabelStr == "time") {
       auto const clock_data =
         art::ServiceHandle<detinfo::DetectorClocksService const>()->DataForJob();
       fTimeLabel = std::make_unique<TimestampLabelMaker>(clock_data.OpticalClock().TickPeriod());
     }
     else {
       throw art::Exception(art::errors::Configuration)
         << "Invalid choice '" << tickLabelStr << "' for time label.\n";
     }
 
   } // DumpOpDetWaveforms::DumpOpDetWaveforms()

Member Function Documentation

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

Does the printing.

Definition at line 179 of file DumpOpDetWaveforms_module.cc.

References ChannelAndTime, DataProductOrder, fDigitsPerLine, fOpDetWaveformsTag, fOutputCategory, fPedestal, fSortByChannelAndTime, fTimeLabel, groupByChannel(), and sortByTimestamp().

   {
 
     // fetch the data to be dumped on screen
     auto const& Waveforms = event.getProduct<std::vector<raw::OpDetWaveform>>(fOpDetWaveformsTag);
 
     dump::raw::OpDetWaveformDumper dump(fPedestal, fDigitsPerLine);
     dump.setTimeLabelMaker(fTimeLabel.get());
 
     mf::LogVerbatim(fOutputCategory) << "The event " << event.id() << " contains data for "
                                      << Waveforms.size() << " optical detector channels";
     if (fPedestal != 0) {
       mf::LogVerbatim(fOutputCategory)
         << "A pedestal of " << fPedestal << " counts will be subtracted from all ADC readings.";
     } // if pedestal
 
     switch (fSortByChannelAndTime) {
     case sortMode::DataProductOrder: {
       dump.setIndent("  ");
       for (raw::OpDetWaveform const& waveform : Waveforms) {
         mf::LogVerbatim log(fOutputCategory);
         dump(log, waveform);
       }      // for waveforms on channel
     } break; // sortMode::DataProductOrder
     case sortMode::ChannelAndTime: {
       dump.setIndent("    ");
 
       auto groupedWaveforms = groupByChannel(Waveforms);
       for (auto& channelWaveforms : groupedWaveforms) {
         if (channelWaveforms.empty()) continue;
 
         sortByTimestamp(channelWaveforms);
         auto const channel = channelWaveforms.front()->ChannelNumber();
 
         mf::LogVerbatim(fOutputCategory) << "  optical detector channel #" << channel << " has "
                                          << channelWaveforms.size() << " waveforms:";
 
         for (raw::OpDetWaveform const* pWaveform : channelWaveforms) {
           mf::LogVerbatim log(fOutputCategory);
           dump(log, *pWaveform);
         } // for waveforms on channel
 
       }      // for all channels
     } break; // sortMode::ChannelAndTime
     }        // switch (fSortMode)
 
   } // DumpOpDetWaveforms::analyze()

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::vector< std::vector< raw::OpDetWaveform const * > > detsim::DumpOpDetWaveforms::groupByChannel ( std::vector< raw::OpDetWaveform > const & waveforms )

staticprivate

Returns pointers to all waveforms in a vector with channel as index.

Definition at line 228 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

   {
     std::vector<std::vector<raw::OpDetWaveform const*>> groups;
     for (auto const& waveform : waveforms) {
       auto const channel = waveform.ChannelNumber();
       if (groups.size() <= channel) groups.resize(channel + 1);
       groups[channel].push_back(&waveform);
     } // for
     return groups;
   } // DumpOpDetWaveforms::groupByChannel()

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";
   }

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 detsim::DumpOpDetWaveforms::sortByTimestamp ( std::vector< raw::OpDetWaveform const * > & waveforms )

staticprivate

Sorts all the waveforms in the vector by growing timestamp.

Definition at line 241 of file DumpOpDetWaveforms_module.cc.

References raw::OpDetWaveform::ChannelNumber(), DEFINE_ART_MODULE, and raw::OpDetWaveform::TimeStamp().

Referenced by analyze().

   {
 
     struct ChannelSorter {
 
       static bool sort(raw::OpDetWaveform const& a, raw::OpDetWaveform const& b)
       {
         if (a.ChannelNumber() < b.ChannelNumber()) return true;
         if (a.ChannelNumber() > b.ChannelNumber()) return false;
 
         return (a.TimeStamp() < b.TimeStamp());
       }
 
       bool operator()(raw::OpDetWaveform const& a, raw::OpDetWaveform const& b) const
       {
         return sort(a, b);
       }
 
       bool operator()(raw::OpDetWaveform const* a, raw::OpDetWaveform const* b) const
       {
         return sort(*a, *b);
       }
 
     }; // struct ChannelSorter
     std::sort(waveforms.begin(), waveforms.end(), ChannelSorter());
 
   } // DumpOpDetWaveforms::sortByTimestamp()

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

unsigned int detsim::DumpOpDetWaveforms::fDigitsPerLine

private

ADC readings per line in the output.

Definition at line 129 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

art::InputTag detsim::DumpOpDetWaveforms::fOpDetWaveformsTag

private

Input tag of data product to dump.

Definition at line 127 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

std::string detsim::DumpOpDetWaveforms::fOutputCategory

private

Category for mf::LogInfo output.

Definition at line 128 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

raw::ADC_Count_t detsim::DumpOpDetWaveforms::fPedestal

private

ADC pedestal (subtracted from readings).

Definition at line 130 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

sortMode detsim::DumpOpDetWaveforms::fSortByChannelAndTime

private

How to sort the waveforms in the dump.

Definition at line 131 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

std::unique_ptr<dump::raw::OpDetWaveformDumper::TimeLabelMaker> detsim::DumpOpDetWaveforms::fTimeLabel

private

The object used to print tick labels.

Definition at line 134 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze(), and DumpOpDetWaveforms().

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

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Static Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation