Extracts PMT baseline settings from PMT readout configuration. More...

Inheritance diagram for icarus::PMTWaveformBaselinesFromReadoutConfiguration:

Classes
struct	Config

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

Public Member Functions
	PMTWaveformBaselinesFromReadoutConfiguration (Parameters const &config)

virtual void	beginJob () override
	Prepares the plots to be filled. More...

virtual void	beginRun (art::Run &run) override
	Reads the PMT readout configuration. More...

virtual void	produce (art::Event &event) override
	Creates the data products. More...

Private Types
using	Baseline_t = signed short int
	Type for baseline (same as V1730channelConfiguration::baseline) More...

Private Member Functions
void	setupPlots ()
	Creates all the plots to be filled by the module. More...

Baseline_t	getBaseline (raw::Channel_t channel) const

std::pair< unsigned int, std::vector< Baseline_t > >	extractBaselinesFromConfiguration (sbn::PMTconfiguration const &PMTconfig) const
	Returns the number of channels in configuration and a baseline map. More...

unsigned int	nChannelsWithBaseline () const
	Returns the number of channels currently configured with a baseline. More...

void	printBaselines () const
	Prints the current baselines on maesage facility (INFO level). More...

Private Attributes
art::InputTag const	fOpDetWaveformTag
	Input optical waveform tag. More...

art::InputTag const	fPMTconfigurationTag
	Input PMT readout config tag. More...

bool const	fPlotBaselines
	Whether to produce plots. More...

bool const	fPrintBaselines
	Whether to print baselines on each run. More...

std::string const	fLogCategory
	Category name for the console output stream. More...

unsigned int	fConfigured = 0U
	Number of channels in PMT configuration. More...

std::vector< short signed int >	fBaselines
	PMT baselines configured in the current run, indexed by channel. More...

TH2 *	fHBaselines = nullptr
	All baselines, per channel. More...

Static Private Attributes
static constexpr Baseline_t	NoBaseline = std::numeric_limits<Baseline_t>::min()
	Mnemonic value for channels without baseline information. More...

Detailed Description

Extracts PMT baseline settings from PMT readout configuration.

This module produces a baseline data product for each optical detector waveform. The content is the same for all the events in each run, and it is read from the specified PMT configuration data product.

Each waveform is associated with the baseline configured for its channel. If there is no information for a given channel and that channel is requested, an exception is thrown.

This module is interchangeable with PMTWaveformBaselines, which instead extracts the baseline dynamically from each waveform.

Output data products

a data product of type std::vector<icarus::WaveformBaseline>, with one baseline per input waveform; the baselines are guaranteed to be in the same order as the waveforms in the input collection;
an art association, one baseline per input optical waveform; normally this is not needed as long as the original PMT waveform data product is available; the type of the association is art::Assns<icarus::WaveformBaseline, raw::OpDetWaveform>.

Output plots

Baselines: baseline distribution, per channel; one entry [ADC] per configured channel per run.

Input data products

std::vector<raw::OpDetWaveform>: a single waveform for each recorded optical detector activity; the activity belongs to a single channel, but there may be multiple waveforms on the same channel.

Note: This module needs only the information of the channel of each waveform; because art is not capable of selective readout, though, the whole optical detector readout data is loaded. When this module is the first one in the job accessing the PMT waveforms, the data loading time is accounted to it; the time the module needs to perform its specific operations is tiny in comparison. Anyway, since it is likely that another module in the job will then use PMT waveform data, this loading time is not wasted.

Service requirements

TFileService and Geometry if PlotBaselines is enabled

Configuration parameters

A terse description of the parameters is printed by running lar --print-description PMTWaveformBaselinesFromReadoutConfiguration.

OpticalWaveforms (input tag, mandatory): the data product containing all optical detector waveforms.
PMTconfigurationTag (input tag, mandatory): the run-level data product containing the full PMT readout configuration (including baseline per channel).
OutputCategory (string, default: "PMTWaveformBaselinesFromReadoutConfiguration"): label for the category of messages in the console output; this is the label that can be used for filtering messages via MessageFacility service configuration.
PlotBaselines (flag, default: true): whether to produce distributions of the configured baselines (not implemented yet).
PrintBaselines (flag, default: true): if set to true, on each run it will print the baseline of all the configured channels with a LArSoft channel ID.

Definition at line 132 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

Member Typedef Documentation

using icarus::PMTWaveformBaselinesFromReadoutConfiguration::Baseline_t = signed short int

private

Type for baseline (same as V1730channelConfiguration::baseline)

Definition at line 199 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

using icarus::PMTWaveformBaselinesFromReadoutConfiguration::Parameters = art::EDProducer::Table<Config>

Definition at line 174 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

Constructor & Destructor Documentation

icarus::PMTWaveformBaselinesFromReadoutConfiguration::PMTWaveformBaselinesFromReadoutConfiguration ( Parameters const & config )

explicit

Definition at line 286 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

   : art::EDProducer(config)
   // configuration
   , fOpDetWaveformTag(config().OpticalWaveforms())
   , fPMTconfigurationTag(config().PMTconfigurationTag())
   , fPlotBaselines(config().PlotBaselines())
   , fPrintBaselines(config().PrintBaselines())
   , fLogCategory(config().OutputCategory())
 {
   //
   // optional configuration parameters
   //
   
   //
   // configuration report (currently, more like a placeholder)
   //
   mf::LogInfo(fLogCategory)
     << "Using configured baselines from '" << fPMTconfigurationTag.encode()
     << "', waveform by waveform, on '" << fOpDetWaveformTag.encode() << "'.";
   
   //
   // declaration of input
   //
   consumes<sbn::PMTconfiguration, art::InRun>(fPMTconfigurationTag);
   consumes<std::vector<raw::OpDetWaveform>>(fOpDetWaveformTag);
   
   //
   // declaration of output
   //
   produces<std::vector<icarus::WaveformBaseline>>();
   produces<art::Assns<icarus::WaveformBaseline, raw::OpDetWaveform>>();
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::PMTWaveformBaselinesFromReadoutConfiguration()

Member Function Documentation

void icarus::PMTWaveformBaselinesFromReadoutConfiguration::beginJob ( )

overridevirtual

Prepares the plots to be filled.

Definition at line 322 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

                                                                   {
   
   //
   // set up the plots, if needed
   //
   if (fPlotBaselines) setupPlots();
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::beginJob()

void icarus::PMTWaveformBaselinesFromReadoutConfiguration::beginRun ( art::Run & run )

overridevirtual

Reads the PMT readout configuration.

Definition at line 334 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   auto const& PMTconfig
     = run.getProduct<sbn::PMTconfiguration>(fPMTconfigurationTag);
   
   std::vector<Baseline_t> newBaselines;
   std::tie(fConfigured, newBaselines)
     = extractBaselinesFromConfiguration(PMTconfig);
   
   bool const changed = (fBaselines != newBaselines);
   fBaselines = std::move(newBaselines);
   
   if (fHBaselines) {
     for (auto const& [ channel, baseline ]: util::enumerate(fBaselines)) {
       if (baseline != NoBaseline)
         fHBaselines->Fill(double(channel), double(baseline));
     } // for
   } // if plots
   
   if (fPrintBaselines && changed) printBaselines();
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::beginRun()

auto icarus::PMTWaveformBaselinesFromReadoutConfiguration::extractBaselinesFromConfiguration ( sbn::PMTconfiguration const & PMTconfig ) const

private

Returns the number of channels in configuration and a baseline map.

Definition at line 459 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   constexpr auto NoChannelID = sbn::V1730channelConfiguration::NoChannelID;
   
   unsigned int nConfigured = 0U;
   std::vector<Baseline_t> baselines;
   
   for (sbn::V1730Configuration const& boardConfig: PMTconfig.boards) {
     for (sbn::V1730channelConfiguration const& channelConfig
       : boardConfig.channels
     ) {
       
       ++nConfigured;
       
       raw::Channel_t const channelID = channelConfig.channelID;
       if (channelID == NoChannelID) continue;
       
       auto const channelSlot = static_cast<std::size_t>(channelID);
       if (baselines.size() <= channelSlot)
         baselines.resize(channelSlot + 1U, NoBaseline);
       
       Baseline_t const baseline = channelConfig.baseline;
       if (baseline == NoBaseline) {
         // if this exception is thrown, it means we need a different way than
         // a special baseline value (`NoBaseline`) to track the missing channels
         // (e.g. a map or a std::vector<std::optional<...>>)
         throw art::Exception(art::errors::LogicError)
           << "A configured baseline actually matches the special value "
           << "`NoBaseline` (" << NoBaseline << ")\n";
       } // if bad luck
       
       baselines[channelSlot] = baseline;
       
     } // for all channels on a board
   } // for all boards
   
   return { nConfigured, std::move(baselines) };
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::extractBaselinesFromConfiguration()

auto icarus::PMTWaveformBaselinesFromReadoutConfiguration::getBaseline ( raw::Channel_t channel ) const

private

Returns the configured baseline.

Exceptions

cet::exception (category: "PMTWaveformBaselinesFromReadoutConfiguration") if channel is not present in the configuration

Definition at line 441 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   
   auto const channelSlot = static_cast<std::size_t>(channel);
   if (channelSlot < fBaselines.size()) {
     Baseline_t const baseline = fBaselines[channelSlot];
     if (baseline != NoBaseline) return baseline;
   }
   throw cet::exception("PMTWaveformBaselinesFromReadoutConfiguration")
     << "No baseline configured for channel " << channel << ".\n";
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::getBaseline()

unsigned int icarus::PMTWaveformBaselinesFromReadoutConfiguration::nChannelsWithBaseline ( ) const

private

Returns the number of channels currently configured with a baseline.

Definition at line 504 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   return fBaselines.size()
     - std::count(fBaselines.begin(), fBaselines.end(), NoBaseline);
 }

void icarus::PMTWaveformBaselinesFromReadoutConfiguration::printBaselines ( ) const

private

Prints the current baselines on maesage facility (INFO level).

Definition at line 511 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   mf::LogInfo log { fLogCategory };
   
   unsigned int const nChannels = nChannelsWithBaseline();
   assert(nChannels <= fConfigured);
   unsigned int const nMissing = fConfigured - nChannels;
   
   log << "Configuration has " << nChannels << " channels";
   if (nMissing > 0U)
     log << " (plus " << nMissing << " not associated to any channel ID)";
   log << ":";
   for (auto [ channelID, baseline ]: util::enumerate(fBaselines)) {
     if (baseline == NoBaseline) continue;
     log << "\n  channel " << channelID << ": " << baseline;
   } // for all channels
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::printBaselines()

void icarus::PMTWaveformBaselinesFromReadoutConfiguration::produce ( art::Event & event )

overridevirtual

Creates the data products.

Definition at line 360 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

 {
   
   //
   // fetch input
   //
   auto const& waveformHandle
     = event.getValidHandle<std::vector<raw::OpDetWaveform>>(fOpDetWaveformTag);
   auto const& waveforms = *waveformHandle;
   
   /*
    * this may be needed in a future where processing happens per channel
    * rather than per waveform:
   // map address of waveform to art pointer to that waveform
   auto const& opDetWavePtrs
     = util::mapDataProductPointers(event, waveformHandle);
   */
   
   
   //
   // compute all the baselines
   //
   std::vector<icarus::WaveformBaseline> baselines;
   baselines.reserve(waveforms.size());
   
   art::Assns<icarus::WaveformBaseline, raw::OpDetWaveform> baselineToWaveforms;
   
   art::PtrMaker<icarus::WaveformBaseline> const makeBaselinePtr(event);
   
   for (auto const& [ iWaveform, waveform ]: util::enumerate(waveforms)) {
     assert(iWaveform == baselines.size());
     
     icarus::WaveformBaseline const baseline
       { static_cast<float>(getBaseline(waveform.ChannelNumber())) };
     
     baselines.push_back(baseline);
     
     baselineToWaveforms.addSingle(
       makeBaselinePtr(iWaveform),
       art::Ptr<raw::OpDetWaveform>(waveformHandle, iWaveform)
       );
     
   } // for waveforms
   
   
   //
   // output
   //
   event.put(
     std::make_unique<std::vector<icarus::WaveformBaseline>>
       (std::move(baselines))
     );
   event.put(
     std::make_unique<art::Assns<icarus::WaveformBaseline, raw::OpDetWaveform>>
       (std::move(baselineToWaveforms))
     );
   
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::produce()

void icarus::PMTWaveformBaselinesFromReadoutConfiguration::setupPlots ( )

private

Creates all the plots to be filled by the module.

Definition at line 422 of file PMTWaveformBaselinesFromReadoutConfiguration_module.cc.

                                                                     {
   
   auto const& tfs = *(art::ServiceHandle<art::TFileService>());
   auto const& geom = *(lar::providerFrom<geo::Geometry const>());
   
   unsigned int const nChannels = geom.NOpChannels();
   
   fHBaselines = tfs.make<TH2F>(
     "Baselines",
     "PMT baseline;channel;baseline per channel [ / 8 ADC ]",
     nChannels, 0.0, double(nChannels),
     256, 13312.0, 15360.0
     );
   
 } // icarus::PMTWaveformBaselinesFromReadoutConfiguration::setupPlots()