Prints the content of all the deposited energies on screen. More...

Inheritance diagram for sim::DumpSimEnergyDeposits:

Classes
struct	Config

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

Public Member Functions
	DumpSimEnergyDeposits (Parameters const &config)
	Constructor: reads the configuration. More...

void	analyze (art::Event const &evt)
	Does the printing. More...

Private Member Functions
template<typename Stream >
void	dumpEnergyDeposit (Stream &out, sim::SimEnergyDeposit const &dep) const

Private Attributes
art::InputTag	fEnergyDepositTag
	Tag for input data product. More...

std::string	fOutputCategory
	Category for LogInfo output. More...

bool	bShowLocation = true
	Print the center of the deposition. More...

bool	bShowStep = true
	Print the step ends. More...

bool	bShowEmission = true
	Print the photons and electrons emitted. More...

bool	bSplitPhotons = true
	Print photons by emission speed. More...

Detailed Description

Prints the content of all the deposited energies on screen.

This analyzer prints the content of all the hits into the LogInfo/LogVerbatim stream.

Configuration parameters

EnergyDepositTag (input tag, default: "largeant:TPCActive"): tag of data product containing the deposits to dump (memento: format is "moduleLabel:instanceName";
OutputCategory (string, default: "DumpSimEnergyDeposits"): the category used for the output (useful for filtering)

Definition at line 52 of file DumpSimEnergyDeposits_module.cc.

Member Typedef Documentation

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

Definition at line 99 of file DumpSimEnergyDeposits_module.cc.

Constructor & Destructor Documentation

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

explicit

Constructor: reads the configuration.

Definition at line 127 of file DumpSimEnergyDeposits_module.cc.

   : EDAnalyzer       (config)
   , fEnergyDepositTag(config().EnergyDepositTag())
   , fOutputCategory  (config().OutputCategory())
   , bShowLocation(config().ShowLocation())
   , bShowStep    (config().ShowStep())
   , bShowEmission(config().ShowEmission())
   , bSplitPhotons(config().SplitPhotons())
   {}

Member Function Documentation

void sim::DumpSimEnergyDeposits::analyze ( art::Event const & evt )

Does the printing.

Definition at line 139 of file DumpSimEnergyDeposits_module.cc.

                                                             {
 
   using namespace util::quantities::energy_literals;
   using namespace util::quantities::space_literals;
   using util::quantities::megaelectronvolt;
   using util::quantities::centimeter;
 
   // fetch the data to be dumped on screen
   auto const& Deps = *(
     event.getValidHandle<std::vector<sim::SimEnergyDeposit>>(fEnergyDepositTag)
     );
 
   mf::LogVerbatim(fOutputCategory)
     << "Event " << event.id() << " contains " << Deps.size() << " '"
     << fEnergyDepositTag.encode() << "' energy deposits";
 
   megaelectronvolt TotalE = 0_MeV;
   centimeter TotalLength { 0.0 };
   unsigned int TotalElectrons = 0U, TotalPhotons = 0U,
     TotalPhotonsFast = 0U, TotalPhotonsSlow = 0U;
 
   for (auto const& [ iDep, dep ]: util::enumerate(Deps)) {
 
     // print a header for the cluster
     mf::LogVerbatim log(fOutputCategory);
     log << "[#" << iDep << "]  ";
     dumpEnergyDeposit(log, dep);
 
     // collect statistics
     TotalE += megaelectronvolt{ dep.Energy() };
     TotalLength += centimeter{ dep.StepLength() };
     TotalElectrons += dep.NumElectrons();
     TotalPhotons += dep.NumPhotons();
     TotalPhotonsSlow += dep.NumSPhotons();
     TotalPhotonsFast += dep.NumFPhotons();
 
   } // for depositions
 
   mf::LogVerbatim(fOutputCategory)
     << "Event " << event.id() << " energy deposits '"
     << fEnergyDepositTag.encode() << "' include "
     << TotalE << " worth of energy, " << TotalElectrons
     << " electrons and " << TotalPhotons << " photons ("
     << TotalPhotonsFast << " fast and " << TotalPhotonsSlow
     << " slow); tracked particles crossed " << TotalLength << " of space."
     ;
 
 } // sim::DumpSimEnergyDeposits::analyze()

template<typename Stream >

void sim::DumpSimEnergyDeposits::dumpEnergyDeposit	(	Stream &	out,
		sim::SimEnergyDeposit const &	dep
	)		const

private

Definition at line 192 of file DumpSimEnergyDeposits_module.cc.

 {
   using util::quantities::megaelectronvolt, util::quantities::gigaelectronvolt;
   using util::quantities::centimeter;
   using util::quantities::nanosecond;
 
   auto const time { nanosecond(dep.Time()) };
   auto const energy { megaelectronvolt(dep.Energy()) };
   auto const length { centimeter(dep.StepLength()) };
 
   out << "TrkID=" << dep.TrackID()
     << " (" << sim::ParticleName(dep.PdgCode()) << "): "
     << energy << " on " << time;
   if (bShowLocation) out << " at " << dep.MidPoint();
   if (bShowStep) out << " from " << dep.Start() << " to " << dep.End();
   out << " (step: " << length << ")";
   if (bShowEmission) {
     out << "; electrons: " << dep.NumElectrons();
     if (bSplitPhotons) {
       out << "; photons: " << dep.NumFPhotons() << " (fast), "
         << dep.NumSPhotons() << " (slow)";
     }
     else out << "; photons: " << dep.NumPhotons();
   }
   
 } // sim::DumpSimEnergyDeposits::dumpEnergyDeposit()