Describes on screen the current geometry. More...

Inheritance diagram for geo::DumpGeometry:

Classes
struct	Config

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

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpGeometry (Parameters const &config)

	DumpGeometry (DumpGeometry const &)=delete

	DumpGeometry (DumpGeometry &&)=delete

DumpGeometry &	operator= (DumpGeometry const &)=delete

DumpGeometry &	operator= (DumpGeometry &&)=delete

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

virtual void	beginJob () override
	Dumps the geometry at once. More...

virtual void	beginRun (art::Run const &run) override
	Dumps the geometry if changed from the previous run. More...

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)

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 Member Functions
template<typename Stream >
void	dumpGeometryCore (Stream &&out, geo::GeometryCore const &geom) const
	Dumps the specified geometry into the specified output stream. More...

template<typename Stream >
void	dump (Stream &&out, geo::GeometryCore const &geom)
	Dumps the geometry and records it. More...

bool	shouldDumpGeometry (geo::GeometryCore const &geom) const
	Returns whether the specified geometry should be dumped. More...

Private Attributes
std::string	fOutputCategory
	Name of the category for output. More...

std::string	fLastDetectorName
	Name of the last geometry dumped. More...

Detailed Description

Describes on screen the current geometry.

One print is performed at the beginning of each run.

Configuration parameters

OutputCategory (string, default: DumpGeometry): output category used by the message facility to output information (INFO level)

Definition at line 44 of file DumpGeometry_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

using geo::DumpGeometry::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 59 of file DumpGeometry_module.cc.

Constructor & Destructor Documentation

geo::DumpGeometry::DumpGeometry ( Parameters const & config )

explicit

Definition at line 100 of file DumpGeometry_module.cc.

101 : EDAnalyzer(config), fOutputCategory(config().outputCategory())

102 {}

art::EDAnalyzer::EDAnalyzer

EDAnalyzer(fhicl::ParameterSet const &pset)

Definition: EDAnalyzer.cc:6

geo::DumpGeometry::fOutputCategory

std::string fOutputCategory

Name of the category for output.

Definition: DumpGeometry_module.cc:79

geo::DumpGeometry::DumpGeometry ( DumpGeometry const & )

delete

geo::DumpGeometry::DumpGeometry ( DumpGeometry && )

delete

Member Function Documentation

virtual void geo::DumpGeometry::analyze ( art::Event const & )

inlineoverridevirtual

Implements art::EDAnalyzer.

Definition at line 70 of file DumpGeometry_module.cc.

References beginJob(), and beginRun().

70 {}

void geo::DumpGeometry::beginJob ( )

overridevirtual

Dumps the geometry at once.

Reimplemented from art::EDAnalyzer.

Definition at line 105 of file DumpGeometry_module.cc.

References dump(), and fOutputCategory.

Referenced by analyze().

 {
 
   auto const& geom = *(lar::providerFrom<geo::Geometry>());
   dump(mf::LogVerbatim(fOutputCategory), geom);
 
 } // geo::DumpGeometry::beginJob()

void geo::DumpGeometry::beginRun ( art::Run const & run )

overridevirtual

Dumps the geometry if changed from the previous run.

Reimplemented from art::EDAnalyzer.

Definition at line 114 of file DumpGeometry_module.cc.

References dump(), fOutputCategory, art::Run::id(), and shouldDumpGeometry().

Referenced by analyze().

 {
 
   auto const& geom = *(lar::providerFrom<geo::Geometry>());
   if (shouldDumpGeometry(geom)) {
     mf::LogVerbatim log(fOutputCategory);
     log << "\nGeometry used in " << run.id() << ":\n";
     dump(log, geom);
   }
 
 } // geo::DumpGeometry::beginRun()

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);
   }

template<typename Stream >

void geo::DumpGeometry::dump	(	Stream &&	out,
		geo::GeometryCore const &	geom
	)

private

Dumps the geometry and records it.

Definition at line 138 of file DumpGeometry_module.cc.

References geo::GeometryCore::DetectorName(), dumpGeometryCore(), and fLastDetectorName.

Referenced by beginJob(), and beginRun().

 {
 
   fLastDetectorName = geom.DetectorName();
   dumpGeometryCore(std::forward<Stream>(out), geom);
 
 } // geo::DumpGeometry::dump()

template<typename Stream >

void geo::DumpGeometry::dumpGeometryCore	(	Stream &&	out,
		geo::GeometryCore const &	geom
	)		const

private

Dumps the specified geometry into the specified output stream.

Definition at line 128 of file DumpGeometry_module.cc.

References geo::GeometryCore::Print(), and geo::GeometryCore::ROOTFile().

Referenced by dump().

 {
 
   out << "Detector description: '" << geom.ROOTFile() << "'\n";
   geom.Print(std::forward<Stream>(out));
 
 } // geo::DumpGeometry::dumpGeometryCore()

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";
   }

DumpGeometry& geo::DumpGeometry::operator= ( DumpGeometry const & )

delete

DumpGeometry& geo::DumpGeometry::operator= ( DumpGeometry && )

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_;
   }

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

bool geo::DumpGeometry::shouldDumpGeometry ( geo::GeometryCore const & geom ) const

private

Returns whether the specified geometry should be dumped.

Definition at line 147 of file DumpGeometry_module.cc.

References DEFINE_ART_MODULE, geo::GeometryCore::DetectorName(), and fLastDetectorName.

Referenced by beginRun().

 {
 
   // only dump if not already dumped
   return geom.DetectorName() != fLastDetectorName;
 
 } // geo::DumpGeometry::shouldDumpGeometry()

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

std::string geo::DumpGeometry::fLastDetectorName

private

Name of the last geometry dumped.

Definition at line 80 of file DumpGeometry_module.cc.

Referenced by dump(), and shouldDumpGeometry().

std::string geo::DumpGeometry::fOutputCategory

private

Name of the category for output.

Definition at line 79 of file DumpGeometry_module.cc.

Referenced by beginJob(), and beginRun().

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

larcore/v09_11_01/source/larcore/Geometry/DumpGeometry_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation