Prints on console the total Protons On Target from the input subruns. More...

Inheritance diagram for sim::POTaccumulator:

Classes
struct	Config
	Collection of configuration parameters for the module. More...

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
	Type to enable module parameters description by art. More...

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	POTaccumulator (Parameters const &config)
	Configuration-checking constructor. More...

	POTaccumulator (POTaccumulator const &)=delete

	POTaccumulator (POTaccumulator &&)=delete

POTaccumulator &	operator= (POTaccumulator const &)=delete

POTaccumulator &	operator= (POTaccumulator &&)=delete

virtual void	analyze (art::Event const &event) override

virtual void	endSubRun (art::SubRun const &subRun) override
	Collects information from each subrun. More...

virtual void	endJob () override
	Prints the general summary. More...

Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDAnalyzer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept

	Analyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	Analyzer (Table< Config > const &config)

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)

Public Member Functions inherited from art::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

fhicl::ParameterSetID	selectorConfig () const

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	printMissingSubrunList () const
	Prints the list of subruns with partial or missing POT information. More...

void	printRunSummary () const
	Prints the list of POT per run. More...

void	printSummary (sumdata::POTSummary const &totalPOT) const
	Prints the total POT summary `totalPOT`. More...

Static Private Member Functions
static std::string	to_string (sumdata::POTSummary const &POT)
	Converts the information from `POT` in a compact string. More...

Private Attributes
art::InputTag	fPOTtag
	Name of `sumdata::POTSummary` data product. More...

std::string	fSummaryOutputCategory
	Name of the main stream for output. More...

std::string	fRunOutputCategory
	Name of the run stream for output. More...

std::map< art::SubRunID, unsigned int >	fPresentSubrunFragments
	Count of subrun fragments with POT information. More...

std::map< art::SubRunID, unsigned int >	fMissingSubrunFragments
	Count of subrun fragments without POT information. More...

std::map< art::RunID, art::SummedValue< sumdata::POTSummary > >	fRunPOT
	Partial count of POT in the run, per run. More...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)

Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Prints on console the total Protons On Target from the input subruns.

This module collects information from each of the subrun in the input files and prints the total of the protons on target. It also optionally prints the total for each observed run. If a subrun is met more than once, the information from all subrun fragments are added together (i.e. it is assumed that summary information is complementary rather than duplicate).

The output can be printed to the console or a file via the appropriate message facility configuration.

Two output streams are used: the one for the run summary and the one for the total summary. They may coincide.

Input

The module reads information from objects of type sumdata::POTSummary stored in each subrun.

Configuration

The output streams can be managed by configuring message facility to deal with the relevant category names. All messages are sent with the INFO level.

SummaryTag (input tag; default: generator): data product (subrun level) with the summary information;
SummaryCategory (string; default: POTaccumulator): the name of the output category the summary is sent to;
RunSummaryCategory (string; default: disabled): if specified, a summary POT is printed for each run; the summary is sent to the output stream specified by the value of this parameter.

Definition at line 71 of file POTaccumulator_module.cc.

Member Typedef Documentation

using sim::POTaccumulator::Parameters = art::EDAnalyzer::Table<Config>

Type to enable module parameters description by art.

Definition at line 98 of file POTaccumulator_module.cc.

Constructor & Destructor Documentation

sim::POTaccumulator::POTaccumulator ( Parameters const & config )

explicit

Configuration-checking constructor.

Definition at line 160 of file POTaccumulator_module.cc.

   : EDAnalyzer(config)
   , fPOTtag(config().SummaryTag())
   , fSummaryOutputCategory(config().SummaryCategory())
   , fRunOutputCategory(config().RunSummaryCategory())
 {}

sim::POTaccumulator::POTaccumulator ( POTaccumulator const & )

delete

sim::POTaccumulator::POTaccumulator ( POTaccumulator && )

delete

Member Function Documentation

virtual void sim::POTaccumulator::analyze ( art::Event const & event )

inlineoverridevirtual

Implements art::EDAnalyzer.

Definition at line 111 of file POTaccumulator_module.cc.

112 {}

void sim::POTaccumulator::endJob ( )

overridevirtual

Prints the general summary.

Reimplemented from art::EDAnalyzer.

Definition at line 201 of file POTaccumulator_module.cc.

 {
 
   //
   // print the run summary
   //
 
   if (!fRunOutputCategory.empty()) {
 
     if (!fMissingSubrunFragments.empty()) printMissingSubrunList();
 
     printRunSummary();
 
   } // if
 
   //
   // print the total summary
   //
 
   // here we skip _art_ aggregation mechanism
   // because it can't handle multiple runs
   sumdata::POTSummary totalPOT;
   for (auto const& POT : fRunPOT | ranges::views::values)
     totalPOT.aggregate(POT.value());
 
   printSummary(totalPOT);
 
 } // sim::POTaccumulator::endJob()

void sim::POTaccumulator::endSubRun ( art::SubRun const & subRun )

overridevirtual

Collects information from each subrun.

Reimplemented from art::EDAnalyzer.

Definition at line 169 of file POTaccumulator_module.cc.

 {
 
   auto const& ID = subRun.id();
 
   //
   // get the information from the subrun and update the subrun counts
   //
   art::Handle<sumdata::POTSummary> summaryHandle;
   if (!subRun.getByLabel(fPOTtag, summaryHandle)) {
     ++fMissingSubrunFragments[ID];
     mf::LogDebug(fSummaryOutputCategory)
       << "Fragment of subrun " << ID << " has no '" << fPOTtag.encode() << "' POT summary.";
     return;
   }
 
   ++fPresentSubrunFragments[ID];
 
   //
   // accumulate the information by run
   //
   sumdata::POTSummary const& subRunPOT = *summaryHandle;
 
   fRunPOT[ID.runID()].update(summaryHandle);
   MF_LOG_TRACE(fSummaryOutputCategory)
     << "Fragment #" << fPresentSubrunFragments[ID] << " of subrun " << ID << ": "
     << sim::POTaccumulator::to_string(subRunPOT);
 
 } // sim::POTaccumulator::endSubRun()

POTaccumulator& sim::POTaccumulator::operator= ( POTaccumulator const & )

delete

POTaccumulator& sim::POTaccumulator::operator= ( POTaccumulator && )

delete

void sim::POTaccumulator::printMissingSubrunList ( ) const

private

Prints the list of subruns with partial or missing POT information.

Definition at line 232 of file POTaccumulator_module.cc.

 {
 
   //
   // missing fragments information
   //
   mf::LogVerbatim log{fRunOutputCategory};
   log << size(fMissingSubrunFragments) << " subruns lack POT information:";
 
   auto const fend = fPresentSubrunFragments.cend();
 
   for (auto const& [id, nMissing] : fMissingSubrunFragments) {
 
     // add to the count of fragments the ones which we have actually found
     unsigned int nFragments = nMissing;
     auto const iFound = fPresentSubrunFragments.find(id);
     if (iFound != fend) nFragments += iFound->second;
 
     log << "\n" << id << ": " << nMissing << " / " << nFragments << " \"fragments\"";
 
   } // for
 
 } // sim::POTaccumulator::printMissingSubrunList()

void sim::POTaccumulator::printRunSummary ( ) const

private

Prints the list of POT per run.

Definition at line 258 of file POTaccumulator_module.cc.

 {
 
   // count subruns in run
   std::map<art::RunID, unsigned int> subrunCount;
   for (art::SubRunID const& ID : fPresentSubrunFragments | ranges::views::keys)
     ++subrunCount[ID.runID()];
 
   mf::LogVerbatim log{fRunOutputCategory};
   log << "POT from " << size(fRunPOT) << " runs:";
   for (auto const& [id, POT] : fRunPOT) {
     log << "\n " << id << " (" << subrunCount[id]
         << " subruns): " << sim::POTaccumulator::to_string(POT.value());
   } // for
 
 } // sim::POTaccumulator::printRunSummary()

void sim::POTaccumulator::printSummary ( sumdata::POTSummary const & totalPOT ) const

private

Prints the total POT summary totalPOT.

Definition at line 277 of file POTaccumulator_module.cc.

 {
 
   // aggregate all run summaries
   mf::LogVerbatim{fSummaryOutputCategory}
     << "Aggregated POT from " << fRunPOT.size() << " runs (" << fPresentSubrunFragments.size()
     << " subruns): " << sim::POTaccumulator::to_string(totalPOT);
 
 } // sim::POTaccumulator::printSummary()

std::string sim::POTaccumulator::to_string ( sumdata::POTSummary const & POT )

staticprivate

Converts the information from POT in a compact string.

Definition at line 289 of file POTaccumulator_module.cc.

 {
   using namespace std::string_literals;
   return std::to_string(POT.totgoodpot) + " good POT ( "s + std::to_string(POT.goodspills) +
          " spills); total: " + std::to_string(POT.totpot) + " POT ( "s +
          std::to_string(POT.totspills) + " spills)";
 } // sim::POTaccumulator::to_string(sumdata::POTSummary)

Member Data Documentation

std::map<art::SubRunID, unsigned int> sim::POTaccumulator::fMissingSubrunFragments

private

Count of subrun fragments without POT information.

Definition at line 135 of file POTaccumulator_module.cc.

art::InputTag sim::POTaccumulator::fPOTtag

private

Name of sumdata::POTSummary data product.

Definition at line 123 of file POTaccumulator_module.cc.

std::map<art::SubRunID, unsigned int> sim::POTaccumulator::fPresentSubrunFragments

private

Count of subrun fragments with POT information.

Definition at line 132 of file POTaccumulator_module.cc.

std::string sim::POTaccumulator::fRunOutputCategory

private

Name of the run stream for output.

Definition at line 125 of file POTaccumulator_module.cc.

std::map<art::RunID, art::SummedValue<sumdata::POTSummary> > sim::POTaccumulator::fRunPOT

private

Partial count of POT in the run, per run.

Definition at line 138 of file POTaccumulator_module.cc.

std::string sim::POTaccumulator::fSummaryOutputCategory

private

Name of the main stream for output.

Definition at line 124 of file POTaccumulator_module.cc.

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

larsim/larsim/EventGenerator/POTaccumulator_module.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Input

Configuration

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation