Writes PMT configuration from FHiCL into a data product. More...

Inheritance diagram for icarus::PMTconfigurationExtraction:

Classes
struct	Config
	Configuration of the module. More...

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

Public Member Functions
	PMTconfigurationExtraction (Parameters const &config)
	Constructor: just reads the configuration. More...

virtual void	beginRun (art::Run &run) override
	Action on new run: configuration is written. More...

virtual void	produce (art::Event &) override
	Mandatory method, unused. More...

Private Member Functions
bool	checkConsistency (sbn::PMTconfiguration const &newConfig, std::string const &srcName) const
	Throws an exception if the `newConfig` is not compatible with the current. More...

Private Attributes
std::optional < sbn::PMTconfiguration >	fPMTconfig
	Current PMT configuration (may be still unassigned). More...

icarusDB::IICARUSChannelMap const *	fChannelMap = nullptr
	Pointer to the online channel mapping service. More...

bool	fRequireConsistency = true
	Whether PMT configuration inconsistency is fatal. More...

bool	fVerbose = false
	Whether to print the configuration we read. More...

std::string	fLogCategory
	Category tag for messages. More...

Detailed Description

Writes PMT configuration from FHiCL into a data product.

This module reads the configuration related to PMT from the FHiCL configuration of the input runs and puts it into each run as a data product.

Input

This module requires any input with art run objects in it. The format expected for that configuration is defined in icarus::PMTconfigurationExtractor, which is the utility used for the actual extraction.

Output

A data product of type sbn::PMTconfiguration is placed in each run. Note that the module itself does not enforce any coherence in the configuration.

Configuration parameters

The following configuration parameters are supported:

AssignOfflineChannelIDs (flag, default: true): when set, service IICARUSChannelMap is used to track the channel numbers back to the LArSoft PMT channel IDs, and this information is saved together with the channel information; if the service is not available, this flag should be set to false, in which case the channel ID will be marked as unknown (sbn::V1730channelConfiguration::NoChannelID).
RequireConsistentPMTconfigurations (flag, default: true): requires that all input files contain compatible PMT configuration; while this is in general desired during decoding, when mixing files with different runs in the same process this check might fail.
Verbose (flag, default: false): if set to true, it will print in full the configuration of the PMT the first time it is read and each time a different one is found.
LogCategory (string, default: PMTconfigurationExtraction): category tag used for messages to message facility.

Multithreading

This module does not support multithreading, and art does not provide multithreading for its functionality anyway: the only action is performed at run and input file level, and the only concurrency in art is currently (art 3.7) at event level.

Definition at line 91 of file PMTconfigurationExtraction_module.cc.

Member Typedef Documentation

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

Definition at line 139 of file PMTconfigurationExtraction_module.cc.

Constructor & Destructor Documentation

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

Constructor: just reads the configuration.

Definition at line 165 of file PMTconfigurationExtraction_module.cc.

   : art::EDProducer(config)
   , fChannelMap(config().AssignOfflineChannelIDs()
       ? art::ServiceHandle<icarusDB::IICARUSChannelMap const>{}.get()

Member Function Documentation

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

overridevirtual

Action on new run: configuration is written.

Definition at line 184 of file PMTconfigurationExtraction_module.cc.

                                                            {
   
   sbn::PMTconfiguration config = extractPMTreadoutConfiguration
     (run, icarus::PMTconfigurationExtractor{ *fChannelMap });
   
   checkConsistency(config, "run " + std::to_string(run.run()));
   if (!fPMTconfig.has_value() && fVerbose)
     mf::LogInfo(fLogCategory) << "PMT readout:" << config;
   
   fPMTconfig = std::move(config);
   
   // put a copy of the current configuration
   run.put(std::make_unique<sbn::PMTconfiguration>(fPMTconfig.value()));
   
 } // icarus::PMTconfigurationExtraction::beginRun()

bool icarus::PMTconfigurationExtraction::checkConsistency	(	sbn::PMTconfiguration const &	newConfig,
		std::string const &	srcName
	)		const

private

Throws an exception if the newConfig is not compatible with the current.

Definition at line 203 of file PMTconfigurationExtraction_module.cc.

 {
   if (!fPMTconfig.has_value() || (*fPMTconfig == config)) return true;
   
   // see debug information for more details
   if (fRequireConsistency) {
     throw cet::exception("PMTconfigurationExtraction")
       << "Configuration from " << srcName
       << " is incompatible with the previously found configuration.\n"
       ;
   } // if consistency is required
   
   mf::LogWarning(fLogCategory)
     << "Configuration from " << srcName
     << " is incompatible with the previously found configuration.\n"
     ;
   if (fVerbose) mf::LogVerbatim(fLogCategory) << "PMT readout:" << config;
   return false;
   
   
 } // icarus::PMTconfigurationExtraction::checkConsistency()