Inheritance diagram for sim::DumpMCParticles:

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

using	ModuleType = EDAnalyzer

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

	DumpMCParticles (DumpMCParticles const &)=delete

	DumpMCParticles (DumpMCParticles &&)=delete

DumpMCParticles &	operator= (DumpMCParticles const &)=delete

DumpMCParticles &	operator= (DumpMCParticles &&)=delete

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

void	endJob () override
	May print some warnings. More...

template<typename Stream >
void	DumpMCParticle (Stream &&out, simb::MCParticle const &particle, art::InputTag const &truthTag, sim::GeneratedParticleInfo const &truthInfo, std::string indent="", bool bIndentFirst=true) const
	Dumps the content of the specified particle in the output stream. More...

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)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

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

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

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

Private Attributes
art::InputTag	fInputParticles
	name of MCParticle's data product More...

art::InputTag	fParticleTruthInfo
	name of MCParticle assns data product More...

std::string	fOutputCategory
	name of the stream for output More...

unsigned int	fPointsPerLine
	trajectory points per output line More...

unsigned int	fNEvents = 0U

unsigned int	fNMissingTruth = 0U
	Count of events without truth association. More...

unsigned int	fNMissingTruthIndex = 0U
	Count of events without truth index. More...

Detailed Description

Definition at line 69 of file DumpMCParticles_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

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

Definition at line 72 of file DumpMCParticles_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 193 of file DumpMCParticles_module.cc.

References fInputParticles, and fParticleTruthInfo.

   : EDAnalyzer(config)
   , fInputParticles(config().InputParticles())
   , fOutputCategory(config().OutputCategory())
   , fPointsPerLine(config().PointsPerLine())
 {
   if (!config().ParticleTruthInfo(fParticleTruthInfo)) fParticleTruthInfo = fInputParticles;
 }

sim::DumpMCParticles::DumpMCParticles ( DumpMCParticles const & )

delete

sim::DumpMCParticles::DumpMCParticles ( DumpMCParticles && )

delete

Member Function Documentation

void sim::DumpMCParticles::analyze ( art::Event const & event )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 237 of file DumpMCParticles_module.cc.

References DumpMCParticle(), art::InputTag::encode(), fInputParticles, fNEvents, fNMissingTruth, fNMissingTruthIndex, fOutputCategory, fParticleTruthInfo, and sim::GeneratedParticleInfo::NoGeneratedParticleIndex.

 {
 
   ++fNEvents;
 
   ProductNameCache namesRegistry(event);
 
   // get the particles from the event
   auto const& particleHandle = event.getValidHandle<std::vector<simb::MCParticle>>(fInputParticles);
   auto const& Particles = *particleHandle;
 
   // get the association to MCTruth
   // - try first the more complete one, with true particle indices
   // - as a fallback, go without true particle indices
   auto particleToTruth = makeFindOneP<simb::MCTruth, sim::GeneratedParticleInfo>(
     particleHandle, event, fParticleTruthInfo);
   std::unique_ptr<art::FindOneP<simb::MCTruth>> particleToTruthLight;
   if (!particleToTruth) {
     ++fNMissingTruthIndex;
     particleToTruthLight =
       makeFindOneP<simb::MCTruth, void>(particleHandle, event, fParticleTruthInfo);
     if (!particleToTruthLight) ++fNMissingTruth;
   }
 
   mf::LogVerbatim(fOutputCategory)
     << "Event " << event.id() << ": data product '" << fInputParticles.encode() << "' contains "
     << Particles.size() << " MCParticle's";
 
   unsigned int iParticle = 0;
   for (simb::MCParticle const& particle : Particles) {
     // flush on every particle,
     // since the output buffer might grow too large otherwise
     mf::LogVerbatim log(fOutputCategory);
 
     // fetch the input tag of the truth information (if any)
     art::Ptr<simb::MCTruth> const& truth = particleToTruth ? particleToTruth->at(iParticle) :
                                            particleToTruthLight ?
                                                              particleToTruthLight->at(iParticle) :
                                                              art::Ptr<simb::MCTruth>{};
     art::InputTag const& truthTag = truth ? namesRegistry[truth] : art::InputTag{};
 
     // fetch the index of the true particle in the truth record (if any)
     sim::GeneratedParticleInfo truthInfo = particleToTruth ?
                                              particleToTruth->data(iParticle).ref() :
                                              sim::GeneratedParticleInfo::NoGeneratedParticleIndex;
 
     // a bit of a header
     log << "\n[#" << (iParticle++) << "] ";
     DumpMCParticle(log, particle, truthTag, truthInfo, "  ", false);
   } // for
 
   mf::LogVerbatim(fOutputCategory) << "\n";
 
 } // sim::DumpMCParticles::analyze()

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::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
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

template<typename Stream >

void sim::DumpMCParticles::DumpMCParticle	(	Stream &&	out,
		simb::MCParticle const &	particle,
		art::InputTag const &	truthTag,
		sim::GeneratedParticleInfo const &	truthInfo,
		std::string	indent = `""`,
		bool	bIndentFirst = `true`
	)		const

Dumps the content of the specified particle in the output stream.

Template Parameters

Stream the type of output stream

Parameters

out	the output stream
particle	the particle to be dumped
truthTag	input tag of the truth record the particle derived from
truthIndex	index of particle in the truth record this derived from
indent	base indentation string (default: none)
bIndentFirst	if first output line should be indented (default: yes)

The indent string is prepended to every line of output, with the possible exception of the first one, in case bIndentFirst is true.

If truthTag module label is empty, it is assumed that this information could not be retrieved, and it will be silently omitted. If truthIndex is sim::NoGeneratorIndex, it is assumed that this information could not be retrieved, and it will be silently omitted.

The output starts on the current line, and the last line is NOT broken.

Definition at line 204 of file DumpMCParticles_module.cc.

References sim::dump::DumpMCParticle(), sim::dump::DumpMCParticleTrajectory(), art::InputTag::encode(), fPointsPerLine, sim::GeneratedParticleInfo::generatedParticleIndex(), sim::GeneratedParticleInfo::hasGeneratedParticleIndex(), art::InputTag::label(), simb::MCParticle::NumberTrajectoryPoints(), and simb::MCParticle::Trajectory().

Referenced by analyze().

 {
 
   if (!truthTag.label().empty() || truthInfo.hasGeneratedParticleIndex()) {
     out << "(from ";
     if (truthTag.label().empty())
       out << "unknown truth record";
     else
       out << "'" << truthTag.encode() << "'";
     if (truthInfo.hasGeneratedParticleIndex())
       out << " particle #" << truthInfo.generatedParticleIndex();
     out << ") ";
   }
 
   sim::dump::DumpMCParticle(
     std::forward<Stream>(out), particle, indent, bIndentFirst ? indent : "");
 
   const unsigned int nPoints = particle.NumberTrajectoryPoints();
   if ((nPoints > 0) && (fPointsPerLine > 0)) {
     out << ":";
     sim::dump::DumpMCParticleTrajectory(
       std::forward<Stream>(out), particle.Trajectory(), fPointsPerLine, indent + "  ");
   } // if has points
 
 } // sim::DumpMCParticles::DumpMCParticle()

void sim::DumpMCParticles::endJob ( )

overridevirtual

May print some warnings.

Reimplemented from art::EDAnalyzer.

Definition at line 293 of file DumpMCParticles_module.cc.

References DEFINE_ART_MODULE, fNEvents, fNMissingTruth, fNMissingTruthIndex, fOutputCategory, and fParticleTruthInfo.

 {
 
   if (fNMissingTruth > 0) {
     mf::LogProblem(fOutputCategory)
       << "Warning: " << fNMissingTruth << "/" << fNEvents
       << " events lacked event generator information for '" << fParticleTruthInfo << "'.";
   }
   else if (fNMissingTruthIndex > 0) {
     mf::LogProblem(fOutputCategory) << "Warning: " << fNMissingTruthIndex << "/" << fNEvents
                                     << " events lacked information of which particles of '"
                                     << fParticleTruthInfo << "' are generator particles.";
   }
 
 } // sim::DumpMCParticles::endJob()

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

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

delete

DumpMCParticles& sim::DumpMCParticles::operator= ( DumpMCParticles && )

delete

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

art::InputTag sim::DumpMCParticles::fInputParticles

private

name of MCParticle's data product

Definition at line 118 of file DumpMCParticles_module.cc.

Referenced by analyze(), and DumpMCParticles().

unsigned int sim::DumpMCParticles::fNEvents = 0U

private

Count of processed events.

Definition at line 123 of file DumpMCParticles_module.cc.

Referenced by analyze(), and endJob().

unsigned int sim::DumpMCParticles::fNMissingTruth = 0U

private

Count of events without truth association.

Definition at line 125 of file DumpMCParticles_module.cc.

Referenced by analyze(), and endJob().

unsigned int sim::DumpMCParticles::fNMissingTruthIndex = 0U

private

Count of events without truth index.

Definition at line 127 of file DumpMCParticles_module.cc.

Referenced by analyze(), and endJob().

std::string sim::DumpMCParticles::fOutputCategory

private

name of the stream for output

Definition at line 120 of file DumpMCParticles_module.cc.

Referenced by analyze(), and endJob().

art::InputTag sim::DumpMCParticles::fParticleTruthInfo

private

name of MCParticle assns data product

Definition at line 119 of file DumpMCParticles_module.cc.

Referenced by analyze(), DumpMCParticles(), and endJob().

unsigned int sim::DumpMCParticles::fPointsPerLine

private

trajectory points per output line

Definition at line 121 of file DumpMCParticles_module.cc.

Referenced by DumpMCParticle().

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

larsim/v09_43_00/source/larsim/MCDumpers/DumpMCParticles_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation