#include "MixFilter.h"

Inheritance diagram for art::MixFilter< T >:

Public Types
typedef T	MixDetail

using	ModuleType = EDFilter

using	WorkerType = WorkerT< EDFilter >

template<typename UserConfig >
using	Table = ProducerBase::Table< UserConfig >

Public Member Functions
	MixFilter (fhicl::ParameterSet const &p)

void	beginJob () override

void	respondToOpenInputFile (FileBlock const &fb) override

void	respondToCloseInputFile (FileBlock const &fb) override

void	respondToOpenOutputFiles (FileBlock const &fb) override

void	respondToCloseOutputFiles (FileBlock const &fb) override

bool	filter (Event &e) override

bool	beginSubRun (SubRun &sr) override

bool	endSubRun (SubRun &sr) override

bool	beginRun (Run &r) override

bool	endRun (Run &r) override

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

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

Static Public Attributes
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

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

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Member Functions
fhicl::ParameterSet const &	initEngine_ (fhicl::ParameterSet const &p)

Private Attributes
MixHelper	helper_

MixDetail	detail_

Detailed Description

template<class T>
class art::MixFilter< T >

Definition at line 153 of file MixFilter.h.

Member Typedef Documentation

template<class T >

typedef T art::MixFilter< T >::MixDetail

Definition at line 622 of file MixFilter.h.

using art::EDFilter::ModuleType = EDFilter

inherited

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >

using art::EDFilter::Table = ProducerBase::Table<UserConfig>

inherited

Definition at line 46 of file EDFilter.h.

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

inherited

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

template<class T >

art::MixFilter< T >::MixFilter ( fhicl::ParameterSet const & p )

explicit

Definition at line 643 of file MixFilter.h.

References art::MixFilter< T >::detail_, art::MixFilter< T >::helper_, and fhicl::detail::atom::value().

   : helper_(initEngine_(p), *this)
   , // See note below
   detail_(p, helper_)
 {
   // Note that the random number engine is created in the initializer
   // list by calling initEngine(). This enables the engine to be
   // obtained by the helper and or detail objects in their constructors
   // via a service handle to the random number generator service. The
   // initEngine() function returns a ParameterSet simply so that it may
   // be called in this place without having to resort to comma-separated
   // bundles to do the job.
   std::conditional_t<detail::has_eventsToSkip<T>::value,
                      detail::setup_eventsToSkip<T>,
                      detail::do_not_setup_eventsToSkip<T>>
     maybe_setup_skipper(helper_, detail_);
 }

Member Function Documentation

template<class T >

void art::MixFilter< T >::beginJob ( )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 663 of file MixFilter.h.

664 {}

template<class T >

bool art::MixFilter< T >::beginRun ( Run & r )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 773 of file MixFilter.h.

References art::MixFilter< T >::detail_, and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_beginRun<T>::value,
                      detail::call_beginRun<T>,
                      detail::do_not_call_beginRun<T>>
     maybe_call_beginRun;
   maybe_call_beginRun(detail_, r);
   return true;
 }

template<class T >

bool art::MixFilter< T >::beginSubRun ( SubRun & sr )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 749 of file MixFilter.h.

References art::MixFilter< T >::detail_, and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_beginSubRun<T>::value,
                      detail::call_beginSubRun<T>,
                      detail::do_not_call_beginSubRun<T>>
     maybe_call_beginSubRun;
   maybe_call_beginSubRun(detail_, sr);
   return true;
 }

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::EDFilter::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDFilter.cc.

References art::EDFilter::current_context_.

   {
     return current_context_.get();
   }

template<class T >

bool art::MixFilter< T >::endRun ( Run & r )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 785 of file MixFilter.h.

References art::MixFilter< T >::detail_, and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_endRun<T>::value,
                      detail::call_endRun<T>,
                      detail::do_not_call_endRun<T>>
     maybe_call_endRun;
   maybe_call_endRun(detail_, r);
   return true;
 }

template<class T >

bool art::MixFilter< T >::endSubRun ( SubRun & sr )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 761 of file MixFilter.h.

References art::MixFilter< T >::detail_, and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_endSubRun<T>::value,
                      detail::call_endSubRun<T>,
                      detail::do_not_call_endSubRun<T>>
     maybe_call_endSubRun;
   maybe_call_endSubRun(detail_, sr);
   return true;
 }

template<class T >

bool art::MixFilter< T >::filter ( art::Event & e )

overridevirtual

Implements art::EDFilter.

Definition at line 704 of file MixFilter.h.

References art::MixFilter< T >::detail_, art::errors::FileReadError, art::MixHelper::generateEventSequence(), art::MixFilter< T >::helper_, art::MixHelper::mixAndPut(), and fhicl::detail::atom::value().

 {
   // 1. Call detail object's startEvent() if it exists.
   std::conditional_t<detail::has_startEvent<T>::value,
                      detail::call_startEvent<T>,
                      detail::do_not_call_startEvent<T>>
     maybe_call_startEvent(e);
   maybe_call_startEvent(detail_);
   // 2. Ask detail object how many events to read.
   size_t nSecondaries = detail_.nSecondaries();
   // 3. Decide which events we're reading and prime the event tree cache.
   EntryNumberSequence enSeq;
   EventIDSequence eIDseq;
   enSeq.reserve(nSecondaries);
   eIDseq.reserve(nSecondaries);
   if (!helper_.generateEventSequence(nSecondaries, enSeq, eIDseq)) {
     throw Exception(errors::FileReadError)
       << "Insufficient secondary events available to mix.\n";
   }
   // 4. Give the event ID sequence to the detail object.
   std::conditional_t<detail::has_processEventIDs<T>::value,
                      detail::call_processEventIDs<T>,
                      detail::do_not_call_processEventIDs<T>>
     maybe_call_processEventIDs;
   maybe_call_processEventIDs(detail_, eIDseq);
   // 5. Give the event auxiliary sequence to the detail object.
   std::conditional_t<detail::has_processEventAuxiliaries<T>::value,
                      detail::call_processEventAuxiliaries<T>,
                      detail::do_not_call_processEventAuxiliaries<T>>
     maybe_call_processEventAuxiliaries;
   maybe_call_processEventAuxiliaries(detail_, helper_, enSeq, nSecondaries);
   // 6. Make the MixHelper read info into all the products, invoke the
   // mix functions and put the products into the event.
   helper_.mixAndPut(enSeq, eIDseq, e);
   // 7. Call detail object's finalizeEvent() if it exists.
   std::conditional_t<detail::has_finalizeEvent<T>::value,
                      detail::call_finalizeEvent<T>,
                      detail::do_not_call_finalizeEvent<T>>
     maybe_call_finalizeEvent;
   maybe_call_finalizeEvent(detail_, e);
   return true;
 }

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

template<typename PROD , BranchType B>

ProductID art::EDFilter::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 131 of file EDFilter.h.

References art::EDFilter::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<class T >

fhicl::ParameterSet const & art::MixFilter< T >::initEngine_ ( fhicl::ParameterSet const & p )

private

Definition at line 797 of file MixFilter.h.

References art::EngineCreator::createEngine(), and art::EngineCreator::get_seed_value().

 {
   // If we can't create one of these, the helper will deal with the
   // situation accordingly.
   if (ServiceRegistry::isAvailable<RandomNumberGenerator>()) {
     createEngine(get_seed_value(p));
   }
   return p;
 }

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::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

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

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

template<class T >

void art::MixFilter< T >::respondToCloseInputFile ( FileBlock const & fb )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 677 of file MixFilter.h.

References art::MixFilter< T >::detail_, fb(), and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_respondToCloseInputFile<T>::value,
                      detail::call_respondToCloseInputFile<T>,
                      detail::do_not_call_respondToXXX<T>>(detail_, fb);
 }

template<class T >

void art::MixFilter< T >::respondToCloseOutputFiles ( FileBlock const & fb )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 695 of file MixFilter.h.

References art::MixFilter< T >::detail_, fb(), and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_respondToCloseOutputFiles<T>::value,
                      detail::call_respondToCloseOutputFiles<T>,
                      detail::do_not_call_respondToXXX<T>>(detail_, fb);
 }

template<class T >

void art::MixFilter< T >::respondToOpenInputFile ( FileBlock const & fb )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 668 of file MixFilter.h.

References art::MixFilter< T >::detail_, fb(), and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_respondToOpenInputFile<T>::value,
                      detail::call_respondToOpenInputFile<T>,
                      detail::do_not_call_respondToXXX<T>>(detail_, fb);
 }

template<class T >

void art::MixFilter< T >::respondToOpenOutputFiles ( FileBlock const & fb )

overridevirtual

Reimplemented from art::EDFilter.

Definition at line 686 of file MixFilter.h.

References art::MixFilter< T >::detail_, fb(), and fhicl::detail::atom::value().

 {
   std::conditional_t<detail::has_respondToOpenOutputFiles<T>::value,
                      detail::call_respondToOpenOutputFiles<T>,
                      detail::do_not_call_respondToXXX<T>>(detail_, fb);
 }

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

Member Data Documentation

template<class T >

MixDetail art::MixFilter< T >::detail_

private

Definition at line 639 of file MixFilter.h.

Referenced by art::MixFilter< T >::beginRun(), art::MixFilter< T >::beginSubRun(), art::MixFilter< T >::endRun(), art::MixFilter< T >::endSubRun(), art::MixFilter< T >::filter(), art::MixFilter< T >::MixFilter(), art::MixFilter< T >::respondToCloseInputFile(), art::MixFilter< T >::respondToCloseOutputFiles(), art::MixFilter< T >::respondToOpenInputFile(), and art::MixFilter< T >::respondToOpenOutputFiles().

constexpr bool art::EDFilter::Fail {false}

staticinherited

Definition at line 33 of file EDFilter.h.

template<class T >

MixHelper art::MixFilter< T >::helper_

private

Definition at line 638 of file MixFilter.h.

Referenced by art::MixFilter< T >::filter(), and art::MixFilter< T >::MixFilter().

constexpr bool art::EDFilter::Pass {true}

staticinherited

Definition at line 32 of file EDFilter.h.

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

art/Framework/Modules/MixFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<class T> class art::MixFilter< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class art::MixFilter< T >