Inheritance diagram for sim::DumpMCTracks:

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

using	ModuleType = EDAnalyzer

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

	DumpMCTracks (DumpMCTracks const &)=delete

	DumpMCTracks (DumpMCTracks &&)=delete

DumpMCTracks &	operator= (DumpMCTracks const &)=delete

DumpMCTracks &	operator= (DumpMCTracks &&)=delete

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

template<typename Stream >
void	DumpMCTrack (Stream &&out, sim::MCTrack const &track, 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	fInputTracks
	name of MCTrack's data product More...

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

Detailed Description

Definition at line 77 of file DumpMCTracks_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

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

Definition at line 80 of file DumpMCTracks_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 123 of file DumpMCTracks_module.cc.

   : EDAnalyzer(config)
   , fInputTracks(config().InputTracks())
   , fOutputCategory(config().OutputCategory())
 {}

sim::DumpMCTracks::DumpMCTracks ( DumpMCTracks const & )

delete

sim::DumpMCTracks::DumpMCTracks ( DumpMCTracks && )

delete

Member Function Documentation

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

overridevirtual

Implements art::EDAnalyzer.

Definition at line 191 of file DumpMCTracks_module.cc.

References DEFINE_ART_MODULE, DumpMCTrack(), art::InputTag::encode(), fInputTracks, fOutputCategory, and track.

 {
 
   // get the particles from the event
   auto const& Tracks = *(event.getValidHandle<std::vector<sim::MCTrack>>(fInputTracks));
 
   mf::LogVerbatim(fOutputCategory)
     << "Event " << event.id() << ": data product '" << fInputTracks.encode() << "' contains "
     << Tracks.size() << " MCTrack objects";
 
   unsigned int iTrack = 0;
   mf::LogVerbatim log(fOutputCategory);
   for (sim::MCTrack const& track : Tracks) {
 
     // a bit of a header
     log << "\n[#" << (iTrack++) << "] ";
     DumpMCTrack(log, track, "  ", false);
 
   } // for
   log << "\n";
 
 } // sim::DumpMCTracks::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::DumpMCTracks::DumpMCTrack	(	Stream &&	out,
		sim::MCTrack const &	track,
		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
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.

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

Definition at line 131 of file DumpMCTracks_module.cc.

References sim::MCTrack::AncestorEnd(), sim::MCTrack::AncestorPdgCode(), sim::MCTrack::AncestorProcess(), sim::MCTrack::AncestorStart(), sim::MCTrack::AncestorTrackID(), sim::MCTrack::dEdx(), tca::dEdx(), sim::MCTrack::dQdx(), sim::MCTrack::End(), art::detail::indent(), sim::MCTrack::MotherEnd(), sim::MCTrack::MotherPdgCode(), sim::MCTrack::MotherProcess(), sim::MCTrack::MotherStart(), sim::MCTrack::MotherTrackID(), sim::MCTrack::Origin(), sim::MCTrack::PdgCode(), sim::MCTrack::Process(), sim::MCTrack::Start(), and sim::MCTrack::TrackID().

Referenced by analyze().

 {
   if (bIndentFirst) out << indent;
   out << "from GEANT track ID=" << track.TrackID() << " PDG ID=" << track.PdgCode() << " from "
       << OriginDescription(track.Origin()) << " via '" << track.Process() << "'";
   out << "\n" << indent << "  starting at ";
   ::PrintMCStep(out, track.Start());
   out << "\n" << indent << "  ending at ";
   ::PrintMCStep(out, track.End());
 
   std::vector<std::vector<double>> const& dQdx = track.dQdx(); // dQdx[MCStep][plane]
   std::vector<double> const& dEdx = track.dEdx();              // dEdx[MCStep]
   size_t const nQSteps = dQdx.size(), nESteps = dEdx.size();
   size_t const nSteps = std::max(nQSteps, nESteps);
   out << "\n" << indent;
   if (nSteps > 0) {
     out << "energy information for " << nSteps << " steps (dE/dX in MeV/cm, then dQ/dx per plane):";
     for (size_t iStep = 0; iStep < nSteps; ++iStep) {
       out << "\n" << indent << "  [#" << iStep << "] dE/dx=";
       if (iStep < nESteps)
         out << dEdx[iStep];
       else
         out << "<N/A>";
       out << "; dQ/dx:";
       if (iStep < nQSteps) {
         std::vector<double> const& step_dQdx = dQdx[iStep]; // dQdx[plane]
         for (size_t iPlane = 0; iPlane < step_dQdx.size(); ++iPlane) {
           out << " [#" << iPlane << "] " << step_dQdx[iPlane];
         } // for plane
       }
       else
         out << "<N/A>";
     } // for iStep
   }
   else
     out << "no energy or charge information available";
 
   out << "\n"
       << indent << "mother ID=" << track.MotherTrackID() << " PDG ID=" << track.MotherPdgCode()
       << " via '" << track.MotherProcess() << "'";
   out << "\n" << indent << "  starting at ";
   ::PrintMCStep(out, track.MotherStart());
   out << "\n" << indent << "  ending at ";
   ::PrintMCStep(out, track.MotherEnd());
 
   out << "\n"
       << indent << "ancestor ID=" << track.AncestorTrackID()
       << " PDG ID=" << track.AncestorPdgCode() << " via '" << track.AncestorProcess() << "'";
   out << "\n" << indent << "  starting at ";
   ::PrintMCStep(out, track.AncestorStart());
   out << "\n" << indent << "  ending at ";
   ::PrintMCStep(out, track.AncestorEnd());
 
 } // sim::DumpMCTracks::DumpMCTrack()

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";
   }

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

delete

DumpMCTracks& sim::DumpMCTracks::operator= ( DumpMCTracks && )

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::DumpMCTracks::fInputTracks

private

name of MCTrack's data product

Definition at line 114 of file DumpMCTracks_module.cc.

Referenced by analyze().

std::string sim::DumpMCTracks::fOutputCategory

private

name of the stream for output

Definition at line 115 of file DumpMCTracks_module.cc.

Referenced by analyze().

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

larsim/v09_43_00/source/larsim/MCDumpers/DumpMCTracks_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