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 >

Public Member Functions
	DumpOpDetWaveforms (Parameters const &config)

void	analyze (const art::Event &evt)
	Does the printing. More...

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 detsim::DumpOpDetWaveforms::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 99 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 108 of file DumpOpDetWaveforms_module.cc.

                         {
       DataProductOrder, ///< Unsorted: same order as the input data product.
       ChannelAndTime    ///< Sort by PMT channel number, then timestamp.
     }; // sortMode

Constructor & Destructor Documentation

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

explicit

Definition at line 153 of file DumpOpDetWaveforms_module.cc.

     : 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 184 of file DumpOpDetWaveforms_module.cc.

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

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 240 of file DumpOpDetWaveforms_module.cc.

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

void detsim::DumpOpDetWaveforms::sortByTimestamp ( std::vector< raw::OpDetWaveform const * > & waveforms )

staticprivate

Sorts all the waveforms in the vector by growing timestamp.

Definition at line 253 of file DumpOpDetWaveforms_module.cc.

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