Inheritance diagram for sim::DumpSimPhotons:

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

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

using	ModuleType = EDAnalyzer

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

	DumpSimPhotons (DumpSimPhotons const &)=delete

	DumpSimPhotons (DumpSimPhotons &&)=delete

DumpSimPhotons &	operator= (DumpSimPhotons const &)=delete

DumpSimPhotons &	operator= (DumpSimPhotons &&)=delete

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

template<typename Stream >
void	DumpElement (Stream &&out, sim::SimPhotons const &simphotons, std::string indent="", bool bIndentFirst=true) const
	Dumps the content of the specified SimPhotons in the output stream. More...

template<typename Stream >
void	DumpOnePhoton (Stream &&out, sim::OnePhoton const &photon) const
	Dumps a sim::OnePhoton on a single line. 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	fInputPhotons
	name of SimPhotons'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 115 of file DumpSimPhotons_module.cc.

Member Typedef Documentation

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

Definition at line 118 of file DumpSimPhotons_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 170 of file DumpSimPhotons_module.cc.

   : EDAnalyzer(config)
   , fInputPhotons(config().InputPhotons())
   , fOutputCategory(config().OutputCategory())
 {}

sim::DumpSimPhotons::DumpSimPhotons ( DumpSimPhotons const & )

delete

sim::DumpSimPhotons::DumpSimPhotons ( DumpSimPhotons && )

delete

Member Function Documentation

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

overridevirtual

Implements art::EDAnalyzer.

Definition at line 219 of file DumpSimPhotons_module.cc.

                                                      {
 
   // get the particles from the event
   auto const& SimPhotons
     = *(event.getValidHandle<std::vector<sim::SimPhotons>>(fInputPhotons));
 
   mf::LogVerbatim(fOutputCategory) << "Event " << event.id()
     << " : data product '" << fInputPhotons.encode() << "' contains "
     << SimPhotons.size() << " SimPhotons";
 
   unsigned int iPhoton = 0;
   for (sim::SimPhotons const& photons: SimPhotons) {
 
     mf::LogVerbatim log(fOutputCategory);
     // a bit of a header
     log << "[#" << (iPhoton++) << "] ";
     DumpElement(log, photons, "  ", false);
 
   } // for
   mf::LogVerbatim(fOutputCategory) << "\n"; // just an empty line
 
 } // sim::DumpSimPhotons::analyze()

template<typename Stream >

void sim::DumpSimPhotons::DumpElement	(	Stream &&	out,
		sim::SimPhotons const &	simphotons,
		std::string	indent = `""`,
		bool	bIndentFirst = `true`
	)		const

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

Template Parameters

Stream the type of output stream

Parameters

out	the output stream
simphotons	the SimPhotons 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 192 of file DumpSimPhotons_module.cc.

         {
   if (bIndentFirst) out << indent;
   out << "channel=" << simphotons.OpChannel() << " has ";
   if (simphotons.empty()) {
     out << simphotons.size() << " no photons";
   }
   else {
     out << simphotons.size() << " photons:";
 
     auto sortedPhotonPtrs = util::makePointerVector(simphotons);
     std::sort
       (sortedPhotonPtrs.begin(), sortedPhotonPtrs.end(), OnePhotonSorter());
 
     for (auto const* onephoton: sortedPhotonPtrs) {
       out << "\n" << indent << "  ";
       DumpOnePhoton(out, *onephoton);
     } // for
 
   }
 
 } // sim::DumpSimPhotons::DumpSimPhotons()

template<typename Stream >

void sim::DumpSimPhotons::DumpOnePhoton	(	Stream &&	out,
		sim::OnePhoton const &	photon
	)		const

Dumps a sim::OnePhoton on a single line.

Definition at line 179 of file DumpSimPhotons_module.cc.

 {
   out << "E=" << onephoton.Energy << " t=" << onephoton.Time
     << " from " << onephoton.InitialPosition << " cm"
     << " to " << onephoton.FinalLocalPosition << " cm"
     ;
   if (onephoton.SetInSD) out << " [in SD]"; // in sensitive detector?
   out << " from track ID=" << onephoton.MotherTrackID;
 } // sim::DumpSimPhotons::DumpOnePhoton()

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

delete

DumpSimPhotons& sim::DumpSimPhotons::operator= ( DumpSimPhotons && )

delete

Member Data Documentation

art::InputTag sim::DumpSimPhotons::fInputPhotons

private

name of SimPhotons's data product

Definition at line 160 of file DumpSimPhotons_module.cc.

std::string sim::DumpSimPhotons::fOutputCategory

private

name of the stream for output

Definition at line 161 of file DumpSimPhotons_module.cc.

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

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