Inheritance diagram for sim::DumpGTruth:

Classes
struct	Config
	Collection of configuration parameters for the module. More...

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
	Type to enable module parameters description by art. More...

using	ModuleType = EDAnalyzer

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

	DumpGTruth (DumpGTruth const &)=delete

	DumpGTruth (DumpGTruth &&)=delete

DumpGTruth &	operator= (DumpGTruth const &)=delete

DumpGTruth &	operator= (DumpGTruth &&)=delete

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

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)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Static Public Member Functions
template<typename Handle >
static std::string	productName (Handle const &handle)
	Returns the name of the product in the form `"module_instance_process"`. More...

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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

Private Attributes
std::vector< art::InputTag >	fInputTruth
	Name of `GTruth` data products. More...

std::string	fOutputCategory
	Name of the stream for output. More...

bool	bAllTruth = false
	Whether to process all `GTruth` collections. More...

bool	bAllowNoTruth = false
	Whether to forgive when no truth is present. More...

Detailed Description

Definition at line 38 of file DumpGTruth_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

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

Type to enable module parameters description by art.

Definition at line 64 of file DumpGTruth_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 93 of file DumpGTruth_module.cc.

References bAllowNoTruth, bAllTruth, and art::errors::Configuration.

   : EDAnalyzer(config)
   , fInputTruth()
   , fOutputCategory(config().OutputCategory())
   , bAllTruth(!config().InputTruth(fInputTruth)) // true if InputTruth omitted
   , bAllowNoTruth(config().AllowNoTruth())
 {
   if (!bAllTruth && bAllowNoTruth) {
     throw art::Exception(art::errors::Configuration)
       << "'AllowNoTruth' is only allowed if no 'InputTruth' is specified.\n";
   }
 }

sim::DumpGTruth::DumpGTruth ( DumpGTruth const & )

delete

sim::DumpGTruth::DumpGTruth ( DumpGTruth && )

delete

Member Function Documentation

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

overridevirtual

Implements art::EDAnalyzer.

Definition at line 107 of file DumpGTruth_module.cc.

References bAllowNoTruth, bAllTruth, sim::dump::DumpGTruth(), fInputTruth, fOutputCategory, art::ProductRetriever::getValidHandle(), art::Handle< T >::product(), art::ValidHandle< T >::product(), productName(), art::errors::ProductNotFound, and art::Handle< T >::provenance().

 {
 
   //
   // prepare the data products to be dumped
   //
   struct ProductInfo_t {
     using Thruths_t = std::vector<simb::GTruth>;
     Thruths_t const* truths;
     std::string name;
 
     ProductInfo_t(art::Handle<Thruths_t> const& handle)
       : truths(handle.provenance()->isPresent() ? handle.product() : nullptr)
       , name(sim::DumpGTruth::productName(handle))
     {}
     ProductInfo_t(art::ValidHandle<Thruths_t> const& handle)
       : truths(handle.product()), name(sim::DumpGTruth::productName(handle))
     {}
 
   }; // ProductInfo_t
 
   std::vector<ProductInfo_t> AllTruths;
   if (bAllTruth) {
     //std::vector<art::Handle<std::vector<simb::GTruth>>> handles;
     //event.getManyByType(handles);
     auto handles = event.getMany<std::vector<simb::GTruth>>();
     std::copy(handles.begin(), handles.end(), std::back_inserter(AllTruths));
   }
   else {
     for (auto const& inputTag : fInputTruth) {
       AllTruths.emplace_back(event.getValidHandle<std::vector<simb::GTruth>>(inputTag));
     } // for
   }
 
   //
   // sanity check
   //
   if (AllTruths.empty() && !bAllowNoTruth) {
     throw art::Exception(art::errors::ProductNotFound) << "No GENIE truth found to be dumped!\n";
   }
 
   //
   // print an introduction
   //
   unsigned int const nTruths = std::accumulate(
     AllTruths.begin(), AllTruths.end(), 0U, [](unsigned int total, auto const& info) {
       return total + (info.truths ? info.truths->size() : 0);
     });
 
   if (bAllTruth) {
     mf::LogVerbatim(fOutputCategory)
       << "Event " << event.id() << " contains " << nTruths << " GENIE truth blocks in "
       << AllTruths.size() << " collections";
   }
   else if (AllTruths.size() == 1) {
     mf::LogVerbatim(fOutputCategory) << "Event " << event.id();
   }
   else {
     mf::LogVerbatim(fOutputCategory) << "Dumping " << nTruths << " GENIE truth blocks from "
                                      << AllTruths.size() << " collections in event " << event.id();
   }
 
   //
   // dump data product by data product
   //
   for (ProductInfo_t const& truths_info : AllTruths) {
 
     auto const* truths = truths_info.truths;
     std::string productName = truths_info.name;
 
     if (!truths) {
       mf::LogVerbatim(fOutputCategory)
         << "Data product '" << productName << "' has been dropped. No information available.";
     }
 
     if (AllTruths.size() > 1) {
       mf::LogVerbatim(fOutputCategory)
         << "Data product '" << productName << "' contains " << truths->size() << " truth blocks:";
     }
     else if (truths->size() > 1) {
       mf::LogVerbatim(fOutputCategory) << truths->size() << " truth blocks:";
     }
 
     //
     // dump each GENIE truth in the data product
     //
     unsigned int iTruth = 0;
     for (auto const& truth : *truths) {
 
       mf::LogVerbatim log(fOutputCategory);
 
       if (truths->size() > 1) log << "(#" << iTruth << ") ";
       sim::dump::DumpGTruth(log, truth, "  ", "");
 
       //
       // update counters
       //
       ++iTruth;
 
     } // for each truth in data product
 
   } // for truth data products
 
   //
   // all done
   //
 
 } // sim::DumpGTruth::analyze()

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::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
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

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

delete

DumpGTruth& sim::DumpGTruth::operator= ( DumpGTruth && )

delete

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

template<typename Handle >

std::string sim::DumpGTruth::productName ( Handle const & handle )

static

Returns the name of the product in the form "module_instance_process".

Definition at line 218 of file DumpGTruth_module.cc.

References DEFINE_ART_MODULE.

Referenced by analyze().

 {
   auto const* prov = handle.provenance();
   return prov->moduleLabel() + '_' + prov->productInstanceName() + '_' + prov->processName();
 } // sim::DumpGTruth::productName()

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

bool sim::DumpGTruth::bAllowNoTruth = false

private

Whether to forgive when no truth is present.

Definition at line 86 of file DumpGTruth_module.cc.

Referenced by analyze(), and DumpGTruth().

bool sim::DumpGTruth::bAllTruth = false

private

Whether to process all GTruth collections.

Definition at line 85 of file DumpGTruth_module.cc.

Referenced by analyze(), and DumpGTruth().

std::vector<art::InputTag> sim::DumpGTruth::fInputTruth

private

Name of GTruth data products.

Definition at line 83 of file DumpGTruth_module.cc.

Referenced by analyze().

std::string sim::DumpGTruth::fOutputCategory

private

Name of the stream for output.

Definition at line 84 of file DumpGTruth_module.cc.

Referenced by analyze().

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

larsim/v09_43_00/source/larsim/MCDumpers/DumpGTruth_module.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation