Describes on screen the current geometry. More...

Inheritance diagram for geo::DumpGeometry:

Classes
struct	Config

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

using	WorkerType = WorkerT< EDAnalyzer >

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

std::string	workerType () const

bool	modifiesEvent () const

void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const

bool	wantEvent (Event const &e)

fhicl::ParameterSetID	selectorConfig () const

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

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

detail::CachedProducts &	cachedProducts ()

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

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 40 of file DumpGeometry_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

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

Definition at line 56 of file DumpGeometry_module.cc.

using art::EDAnalyzer::WorkerType = WorkerT<EDAnalyzer>

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 108 of file DumpGeometry_module.cc.

   : EDAnalyzer(config)
   , fOutputCategory(config().outputCategory())
   {}

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 67 of file DumpGeometry_module.cc.

References beginJob(), and beginRun().

67 {}

void geo::DumpGeometry::beginJob ( )

overridevirtual

Dumps the geometry at once.

Reimplemented from art::EDAnalyzer.

Definition at line 115 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 124 of file DumpGeometry_module.cc.

References dump(), dumpGeometryCore(), 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()

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

   {
     return selectors_;
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

   {
     return current_context_.get();
   }

template<typename Stream >

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

private

Dumps the geometry and records it.

Definition at line 150 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 139 of file DumpGeometry_module.cc.

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

Referenced by beginRun(), and dump().

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

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

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

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

   {
     return selectors_.getOneTriggerResults(e);
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

   {
     return false;
   }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

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

delete

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

delete

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

   {
     return process_name_;
   }

void art::EventObserverBase::registerProducts	(	MasterProductRegistry &	,
		ProductDescriptions &	,
		ModuleDescription const &
	)

inlineinherited

Definition at line 33 of file EventObserverBase.h.

36 {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

   {
     return selector_config_id_;
   }

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

private

Returns whether the specified geometry should be dumped.

Definition at line 159 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::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

   {
     return wantAllEvents_;
   }

bool art::EventObserverBase::wantEvent ( Event const & e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

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

   {
     return selectors_.wantEvent(e);
   }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

     {
       return "WorkerT<EDAnalyzer>";
     }

Member Data Documentation

std::string geo::DumpGeometry::fLastDetectorName

private

Name of the last geometry dumped.

Definition at line 78 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 77 of file DumpGeometry_module.cc.

Referenced by beginJob(), and beginRun().

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

/cvmfs/larsoft.opensciencegrid.org/products/larcore/v07_00_05/source/larcore/Geometry/DumpGeometry_module.cc

Classes

Public Types

Public Member Functions

Static 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