Inheritance diagram for sim::DumpMCTracks:

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

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

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

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	fInputTracks
	name of MCTrack's data product More...

std::string	fOutputCategory
	name of the stream for output 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 83 of file DumpMCTracks_module.cc.

Member Typedef Documentation

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

Definition at line 86 of file DumpMCTracks_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 134 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 211 of file DumpMCTracks_module.cc.

                                                    {
 
   // 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 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 142 of file DumpMCTracks_module.cc.

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

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

delete

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

delete

Member Data Documentation

art::InputTag sim::DumpMCTracks::fInputTracks

private

name of MCTrack's data product

Definition at line 124 of file DumpMCTracks_module.cc.

std::string sim::DumpMCTracks::fOutputCategory

private

name of the stream for output

Definition at line 125 of file DumpMCTracks_module.cc.

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

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