#include "MixFilter.h"

Inheritance diagram for art::MixFilter< T, IOPolicy >:

Public Types
using	MixDetail = T

using	Parameters = typename detail::maybe_has_Parameters< T >::Parameters

using	ModuleType = EDFilter

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

Public Member Functions
template<typename U = Parameters>
	MixFilter (std::enable_if_t< std::is_same_v< U, fhicl::ParameterSet >, fhicl::ParameterSet > const &p)

template<typename U = Parameters>
	MixFilter (std::enable_if_t<!std::is_same_v< U, fhicl::ParameterSet >, U > const &p)

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

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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 Attributes
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions
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
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

Private Attributes
MixHelper	helper_

MixDetail	detail_

Detailed Description

template<typename T, typename IOPolicy>
class art::MixFilter< T, IOPolicy >

Definition at line 155 of file MixFilter.h.

Member Typedef Documentation

template<typename T , typename IOPolicy >

using art::MixFilter< T, IOPolicy >::MixDetail = T

Definition at line 384 of file MixFilter.h.

using art::EDFilter::ModuleType = EDFilter

inherited

Definition at line 18 of file EDFilter.h.

template<typename T , typename IOPolicy >

using art::MixFilter< T, IOPolicy >::Parameters = typename detail::maybe_has_Parameters<T>::Parameters

Definition at line 386 of file MixFilter.h.

template<typename UserConfig >

using art::detail::Filter::Table = Modifier::Table<UserConfig>

inherited

Definition at line 32 of file Filter.h.

Constructor & Destructor Documentation

template<typename T , typename IOPolicy >

template<typename U >

art::MixFilter< T, IOPolicy >::MixFilter ( std::enable_if_t< std::is_same_v< U, fhicl::ParameterSet >, fhicl::ParameterSet > const & p )

explicit

Definition at line 412 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_, art::MixFilter< T, IOPolicy >::helper_, art::ProductRegistryHelper::producesCollector(), and art::MixHelper::setEventsToSkipFunction().

   : EDFilter{p}
   , helper_{p,
             p.template get<std::string>("module_label"),
             producesCollector(),
             std::make_unique<IOPolicy>()}
   , detail_{p, helper_}
 {
   if constexpr (detail::has_eventsToSkip<T>::value) {
     helper_.setEventsToSkipFunction([this] { return detail_.eventsToSkip(); });
   }
 }

template<typename T , typename IOPolicy >

template<typename U >

art::MixFilter< T, IOPolicy >::MixFilter ( std::enable_if_t<!std::is_same_v< U, fhicl::ParameterSet >, U > const & p )

explicit

Definition at line 429 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_, art::MixFilter< T, IOPolicy >::helper_, art::ProductRegistryHelper::producesCollector(), and art::MixHelper::setEventsToSkipFunction().

   : EDFilter{p}
   , helper_{p().mixHelper(),
             p.get_PSet().template get<std::string>("module_label"),
             producesCollector(),
             std::make_unique<IOPolicy>()}
   , detail_{p().userConfig, helper_}
 {
   if constexpr (detail::has_eventsToSkip<T>::value) {
     helper_.setEventsToSkipFunction([this] { return detail_.eventsToSkip(); });
   }
 }

Member Function Documentation

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 546 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_beginRun<T>::value) {
     detail_.beginRun(r);
   }
   return true;
 }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 526 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_beginSubRun<T>::value) {
     detail_.beginSubRun(sr);
   }
   return true;
 }

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::Filter::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 29 of file Filter.cc.

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

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

inherited

Definition at line 72 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

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

inherited

Definition at line 92 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

void art::detail::Filter::doEndJob ( )

inherited

Definition at line 37 of file Filter.cc.

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

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

inherited

Definition at line 82 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

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

inherited

Definition at line 102 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

bool art::detail::Filter::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 112 of file Filter.cc.

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

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = filterWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     if (rc) {
       ++counts_passed;
     } else {
       ++counts_failed;
     }
     return rc;
   }

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

inherited

Definition at line 51 of file Filter.cc.

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

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

inherited

Definition at line 65 of file Filter.cc.

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

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

inherited

Definition at line 44 of file Filter.cc.

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

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

inherited

Definition at line 58 of file Filter.cc.

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

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 556 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_endRun<T>::value) {
     detail_.endRun(r);
   }
   return true;
 }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 536 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_endSubRun<T>::value) {
     detail_.endSubRun(sr);
   }
   return true;
 }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Implements art::EDFilter.

Definition at line 481 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_, art::errors::FileReadError, art::MixHelper::generateEventAuxiliarySequence(), art::MixHelper::generateEventSequence(), art::MixFilter< T, IOPolicy >::helper_, and art::MixHelper::mixAndPut().

 {
   // 1. Call detail object's startEvent() if it exists.
   if constexpr (detail::has_startEvent<T>::value) {
     detail_.startEvent(e);
   }
 
   // 2. Ask detail object how many events to read.
   size_t const 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.
   if constexpr (detail::has_processEventIDs<T>::value) {
     detail_.processEventIDs(eIDseq);
   }
 
   // 5. Give the event auxiliary sequence to the detail object.
   if constexpr (detail::has_processEventAuxiliaries<T>::value) {
     auto const auxseq = helper_.generateEventAuxiliarySequence(enSeq);
     detail_.processEventAuxiliaries(auxseq);
   }
 
   // 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.
   if constexpr (detail::has_finalizeEvent<T>::value) {
     detail_.finalizeEvent(e);
   }
   return true;
 }

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

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

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 454 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_respondToCloseInputFile<T>::value) {
     detail_.respondToCloseInputFile(fb);
   }
 }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 472 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_respondToCloseOutputFiles<T>::value) {
     detail_.respondToCloseOutputFiles(fb);
   }
 }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 445 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_respondToOpenInputFile<T>::value) {
     detail_.respondToOpenInputFile(fb);
   }
 }

template<typename T , typename IOPolicy >

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

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 463 of file MixFilter.h.

References art::MixFilter< T, IOPolicy >::detail_.

 {
   if constexpr (detail::has_respondToOpenOutputFiles<T>::value) {
     detail_.respondToOpenOutputFiles(fb);
   }
 }

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

Member Data Documentation

template<typename T , typename IOPolicy >

MixDetail art::MixFilter< T, IOPolicy >::detail_

private

Definition at line 407 of file MixFilter.h.

constexpr bool art::detail::Filter::Fail {false}

staticinherited

Definition at line 29 of file Filter.h.

template<typename T , typename IOPolicy >

MixHelper art::MixFilter< T, IOPolicy >::helper_

private

Definition at line 406 of file MixFilter.h.

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

constexpr bool art::detail::Filter::Pass {true}

staticinherited

Definition at line 28 of file Filter.h.

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

art/Framework/Modules/MixFilter.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename T, typename IOPolicy> class art::MixFilter< T, IOPolicy >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, typename IOPolicy>
class art::MixFilter< T, IOPolicy >