Inheritance diagram for sim::DumpMCParticles:

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

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

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

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...

	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...

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 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...

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

Definition at line 78 of file DumpMCParticles_module.cc.

Member Typedef Documentation

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

Definition at line 77 of file DumpMCParticles_module.cc.

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

Definition at line 81 of file DumpMCParticles_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 210 of file DumpMCParticles_module.cc.

   : 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

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

explicit

Configuration-checking constructor.

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.

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

overridevirtual

Implements art::EDAnalyzer.

Definition at line 254 of file DumpMCParticles_module.cc.

                                                       {
   
   ++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 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.

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 223 of file DumpMCParticles_module.cc.

         {
   
   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.

void sim::DumpMCParticles::endJob ( )

overridevirtual

May print some warnings.

Reimplemented from art::EDAnalyzer.

Definition at line 315 of file DumpMCParticles_module.cc.

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

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

delete

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

delete

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

delete

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

delete

Member Data Documentation

art::InputTag sim::DumpMCParticles::fInputParticles

private

name of MCParticle's data product

Definition at line 129 of file DumpMCParticles_module.cc.

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

private

Count of processed events.

Definition at line 134 of file DumpMCParticles_module.cc.

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

private

Count of events without truth association.

Definition at line 136 of file DumpMCParticles_module.cc.

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

private

Count of events without truth index.

Definition at line 138 of file DumpMCParticles_module.cc.

std::string sim::DumpMCParticles::fOutputCategory

private

name of the stream for output

Definition at line 131 of file DumpMCParticles_module.cc.

art::InputTag sim::DumpMCParticles::fParticleTruthInfo

private

name of MCParticle assns data product

Definition at line 130 of file DumpMCParticles_module.cc.

unsigned int sim::DumpMCParticles::fPointsPerLine

private

trajectory points per output line

Definition at line 132 of file DumpMCParticles_module.cc.

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

garsoft/Utilities/Dumpers/DumpMCParticles_module.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation