artdaq_demo  v3_04_00
demo::WFViewer Class Reference

An example art analysis module which plots events both as histograms and event snapshots (plot of ADC value vs ADC number) More...

Inheritance diagram for demo::WFViewer:

Public Member Functions

 WFViewer (fhicl::ParameterSet const &p)
 WFViewer Constructor. More...
 
virtual ~WFViewer ()=default
 WFViewer default Destructor.
 
void analyze (art::Event const &e) override
 Analyze an event. Called by art for each event in run (based on command line options) More...
 
void beginRun (art::Run const &) override
 Art calls this function at the beginning of the run. Used for set-up of ROOT histogram objects and to open the output file if one is specified.
 

Detailed Description

An example art analysis module which plots events both as histograms and event snapshots (plot of ADC value vs ADC number)

Definition at line 42 of file WFViewer_module.cc.

Constructor & Destructor Documentation

demo::WFViewer::WFViewer ( fhicl::ParameterSet const &  p)
explicit

WFViewer Constructor.

Parameters
pParameterSet used to configure WFViewer
* WFViewer accepts the following Parameters:
* "prescale" (REQUIRED): WFViewer will only redraw historgrams once per this many events
* "digital_sum_only" (Default: false): Only create the histogram, not the event snapshot
* "num_x_plots": (Default: size_t::MAX_VALUE): Maximum number of columns of plots
* "num_y_plots": (Default: size_t::MAX_VALUE): Maximum number of rows of plots
* "raw_data_label": (Default: "daq"): Label under which artdaq data is stored
* "fragment_ids": (REQUIRED): List of ids to process. Fragment IDs are assigned by BoardReaders.
* "fileName": (Default: artdaqdemo_onmon.root): File name for output, if
* "write_to_file": (Default: false): Whether to write output histograms to "fileName"
* 

Definition at line 104 of file WFViewer_module.cc.

Member Function Documentation

void demo::WFViewer::analyze ( art::Event const &  e)
override

Analyze an event. Called by art for each event in run (based on command line options)

Parameters
eThe art::Event object to process, and display if it passes the prescale

Definition at line 158 of file WFViewer_module.cc.


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