sim::DumpSimPhotons Class Reference

Inheritance diagram for sim::DumpSimPhotons:

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

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

Private Attributes
art::InputTag	fInputPhotons
	name of SimPhotons's data product More...
std::string	fOutputCategory
	name of the stream for output More...

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 )

override

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:

• DumpSimPhotons_module.cc