sim::DumpMCShowers Class Reference

Inheritance diagram for sim::DumpMCShowers:

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	DumpMCShowers (Parameters const &config)
	Configuration-checking constructor. More...
	DumpMCShowers (DumpMCShowers const &)=delete
	DumpMCShowers (DumpMCShowers &&)=delete
DumpMCShowers &	operator= (DumpMCShowers const &)=delete
DumpMCShowers &	operator= (DumpMCShowers &&)=delete
virtual void	analyze (art::Event const &event) override
template<typename Stream >
void	DumpMCShower (Stream &&out, sim::MCShower const &shower, 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	fInputShowers
	name of MCShower's data product More...
std::string	fOutputCategory
	name of the stream for output More...
unsigned int	fDaughtersPerLine
	number of daughter IDs printed per line 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 90 of file DumpMCShowers_module.cc.

Member Typedef Documentation

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

Definition at line 93 of file DumpMCShowers_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 142 of file DumpMCShowers_module.cc.

  : EDAnalyzer(config)
  , fInputShowers(config().InputShowers())
  , fOutputCategory(config().OutputCategory())
  , fDaughtersPerLine(config().DaughtersPerLine())
{}

sim::DumpMCShowers::DumpMCShowers ( DumpMCShowers const &  )

delete

sim::DumpMCShowers::DumpMCShowers ( DumpMCShowers &&  )

delete

Member Function Documentation

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

overridevirtual

Implements art::EDAnalyzer.

Definition at line 228 of file DumpMCShowers_module.cc.

                                                    {

  // get the particles from the event
  auto const& Showers
    = *(event.getValidHandle<std::vector<sim::MCShower>>(fInputShowers));

  mf::LogVerbatim(fOutputCategory)
    << "Event " << event.id() << ": data product '"
    << fInputShowers.encode() << "' contains "
    << Showers.size() << " MCShower objects";

  unsigned int iShower = 0;
  mf::LogVerbatim log(fOutputCategory);
  for (sim::MCShower const& shower: Showers) {

    // a bit of a header
    log << "\n[#" << (iShower++) << "] ";
    DumpMCShower(log, shower, "  ", false);

  } // for
  log << "\n";

} // sim::DumpMCShowers::analyze()

template<typename Stream >

void sim::DumpMCShowers::DumpMCShower	(	Stream &&	out,
		sim::MCShower const &	shower,
		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 151 of file DumpMCShowers_module.cc.

        {
  if (bIndentFirst) out << indent;
  out
    << "from GEANT track ID=" << shower.TrackID()
    << " PDG ID=" << shower.PdgCode()
    << " from " << OriginDescription(shower.Origin())
    << " via '" << shower.Process() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, shower.Start());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, shower.End());

  TVector3 const& startDir = shower.StartDir();
  out << "\n" << indent
    << "pointing toward ("
    << startDir.X() << ", " << startDir.Y() << ", " << startDir.Z() << ") cm";
  std::vector<double> const& charges = shower.Charge();
  std::vector<double> const& dQdx = shower.dQdx();
  size_t const nQPlanes = dQdx.size(), nChPlanes = charges.size();
  size_t const nPlanes = std::max(nQPlanes, nChPlanes);
  out << "\n" << indent;
  if (nPlanes > 0) {
    out
      << "dE/dx=" << shower.dEdx() << " MeV/cm and dQ/dx (charge) on "
      << nPlanes << " planes:";
    for (size_t iPlane = 0; iPlane < nPlanes; ++iPlane) {
      out << " [#" << iPlane << "] ";
      if (iPlane < dQdx.size()) out << dQdx[iPlane];
      else                      out << "<N/A>";
      if (iPlane < charges.size()) out << " (" << charges[iPlane] << ")";
      else                      out << "<N/A>";
    } // for plane
  }
  else out << "no energy or charge information available";

  std::vector<unsigned int> const& daughters = shower.DaughterTrackID();
  out << "\n" << indent
    << "combined energy deposition information: ";
  ::PrintMCStep(out, shower.DetProfile());
  out << "\n" << indent
    << daughters.size() << " daughters, ID:";
  for (size_t i = 0; i < daughters.size(); ++i) {
    if ((i % fDaughtersPerLine) == 0) out << "\n" << indent << "    ";
    out << " " << std::setw(8) << daughters[i];
  } // for

  out << "\n" << indent
    << "mother ID=" << shower.MotherTrackID()
    << " PDG ID=" << shower.MotherPdgCode()
    << " via '" << shower.MotherProcess() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, shower.MotherStart());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, shower.MotherEnd());

  out << "\n" << indent
    << "ancestor ID=" << shower.AncestorTrackID()
    << " PDG ID=" << shower.AncestorPdgCode()
    << " via '" << shower.AncestorProcess() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, shower.AncestorStart());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, shower.AncestorEnd());

} // sim::DumpMCShowers::DumpMCShower()

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

delete

DumpMCShowers& sim::DumpMCShowers::operator= ( DumpMCShowers &&  )

delete

Member Data Documentation

unsigned int sim::DumpMCShowers::fDaughtersPerLine

private

number of daughter IDs printed per line

Definition at line 133 of file DumpMCShowers_module.cc.

art::InputTag sim::DumpMCShowers::fInputShowers

private

name of MCShower's data product

Definition at line 131 of file DumpMCShowers_module.cc.

std::string sim::DumpMCShowers::fOutputCategory

private

name of the stream for output

Definition at line 132 of file DumpMCShowers_module.cc.

---

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

• larsim/larsim/MCDumpers/DumpMCShowers_module.cc