#include "/cvmfs/nova.opensciencegrid.org/externals/art/v2_13_00/source/art/Framework/Core/EDFilter.h"

Inheritance diagram for art::EDFilter:

Public Types
using	ModuleType = EDFilter

using	WorkerType = WorkerT< EDFilter >

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

Public Member Functions
virtual	~EDFilter ()=default

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

bool	modifiesEvent () const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) 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 Types
using	CPC_exempt_ptr = cet::exempt_ptr< CurrentProcessingContext const >

Private Member Functions
bool	doEvent (EventPrincipal &ep, CPC_exempt_ptr cpc, CountingStatistics &)

void	doBeginJob ()

void	doEndJob ()

bool	doBeginRun (RunPrincipal &rp, CPC_exempt_ptr cpc)

bool	doEndRun (RunPrincipal &rp, CPC_exempt_ptr cpc)

bool	doBeginSubRun (SubRunPrincipal &srp, CPC_exempt_ptr cpc)

bool	doEndSubRun (SubRunPrincipal &srp, CPC_exempt_ptr cpc)

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

std::string	workerType () const

virtual bool	filter (Event &)=0

virtual void	beginJob ()

virtual void	endJob ()

virtual bool	beginRun (Run &)

virtual bool	endRun (Run &)

virtual bool	beginSubRun (SubRun &)

virtual bool	endSubRun (SubRun &)

virtual void	respondToOpenInputFile (FileBlock const &)

virtual void	respondToCloseInputFile (FileBlock const &)

virtual void	respondToOpenOutputFiles (FileBlock const &)

virtual void	respondToCloseOutputFiles (FileBlock const &)

void	setModuleDescription (ModuleDescription const &md)

Private Attributes
ModuleDescription	moduleDescription_ {}

CPC_exempt_ptr	current_context_ {nullptr}

bool	checkPutProducts_ {true}

Friends
template<typename T >
class	WorkerT

Detailed Description

Definition at line 30 of file EDFilter.h.

Member Typedef Documentation

using art::EDFilter::CPC_exempt_ptr = cet::exempt_ptr<CurrentProcessingContext const>

private

Definition at line 54 of file EDFilter.h.

using art::EDFilter::ModuleType = EDFilter

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >

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

Definition at line 46 of file EDFilter.h.

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

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

virtual art::EDFilter::~EDFilter ( )

virtualdefault

Member Function Documentation

virtual void art::EDFilter::beginJob ( )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >, trident::DimuonSliceAna, calib::MuondEdxAna, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::MuonTrackHits, filter::Filter, novaddt::Multiplet, showere::ShowerEnergyFilterMC, novaddt::UpMuTrigger, calib::DetRespDrift, calib::MuondEdx, chaninfo::FindSwappedChannels, bsf::BremShowerFilter, calib::TimingCalFilter, novaddt::NNFastMMTrigger, novaddt::ActivityTriggerAna, calib::CosmicCalib, EliminateBeamSpills, novaddt::MoonShadow, DataCheck::HardwareStatusCheck, EventFilter, novaddt::NuESelect, jmshower::RecoJMShowerFilter, util::RemoveBeamSpillsPrecise, calib::FindOutliers, calib::StopperSelection, calib::RockMuonStopperSelection, calib::ThroughgoingSelection, util::RemoveTBSpills, util::RemoveBeamSpills, tut::TutFilter, util::CopyCellHits, and util::NonEmptyCluster.

Definition at line 76 of file EDFilter.h.

77 {}

virtual bool art::EDFilter::beginRun ( Run & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >, runh::BadDataFilter, calib::MuondEdxAna, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::MuonTrackHits, calib::DetRespDrift, calib::MuondEdx, util::TimeFilter, util::RunEventFilter, calhit::HasCellHits, util::EventFilterNoSlice, calib::CosmicCalib, comi::NumiFiltering, and novaddt::ContainedSlice.

Definition at line 82 of file EDFilter.h.

     {
       return true;
     }

virtual bool art::EDFilter::beginSubRun ( SubRun & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >, runh::BadDataFilter, skim::CellHitSkimmer, util::TimeFilter, chaninfo::FindSwappedChannels, util::RunEventFilter, calhit::HasCellHits, util::EventFilterNoSlice, DataCheck::HardwareStatusCheck, skim::RandomEventFilter, jmshower::RecoJMShowerFilter, and novaddt::ContainedSlice.

Definition at line 92 of file EDFilter.h.

     {
       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 146 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

 {
   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 161 of file Consumer.h.

References T.

 {
   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 171 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

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

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

inherited

Referenced by evgen::CosmicPionGen::CosmicPionGen(), evgen::CosmicsGen::CosmicsGen(), fuzz::FuzzyKVertex::FuzzyKVertex(), g4n::G4Gen::G4Gen(), photrans::ImprovedTransport::ImprovedTransport(), art::MixFilter< T >::initEngine_(), evgen::IsoGen::IsoGen(), rsim::MakeNoiseSpectrumFile::MakeNoiseSpectrumFile(), photrans::PhotonSystRewriter::PhotonSystRewriter(), photrans::PhotonTransport::PhotonTransport(), rsim::ReadoutSim::ReadoutSim(), evgen::SingleGen::SingleGen(), and evgen::SupernovaGen::SupernovaGen().

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

inherited

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

inherited

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

protected

void art::EDFilter::doBeginJob ( )

private

bool art::EDFilter::doBeginRun	(	RunPrincipal &	rp,
		CPC_exempt_ptr	cpc
	)

private

bool art::EDFilter::doBeginSubRun	(	SubRunPrincipal &	srp,
		CPC_exempt_ptr	cpc
	)

private

void art::EDFilter::doEndJob ( )

private

bool art::EDFilter::doEndRun	(	RunPrincipal &	rp,
		CPC_exempt_ptr	cpc
	)

private

bool art::EDFilter::doEndSubRun	(	SubRunPrincipal &	srp,
		CPC_exempt_ptr	cpc
	)

private

bool art::EDFilter::doEvent	(	EventPrincipal &	ep,
		CPC_exempt_ptr	cpc,
		CountingStatistics &
	)

private

void art::EDFilter::doRespondToCloseInputFile ( FileBlock const & fb )

private

void art::EDFilter::doRespondToCloseOutputFiles ( FileBlock const & fb )

private

void art::EDFilter::doRespondToOpenInputFile ( FileBlock const & fb )

private

void art::EDFilter::doRespondToOpenOutputFiles ( FileBlock const & fb )

private

virtual void art::EDFilter::endJob ( )

inlineprivatevirtual

Reimplemented in trident::DimuonSliceAna, calib::MuondEdxAna, novaddt::MichelETrigger, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::MuonTrackHits, novaddt::Multiplet, showere::ShowerEnergyFilterMC, novaddt::UpMuTrigger, calib::DetRespDrift, calib::MuondEdx, novaddt::HorizontalMuonTrigger, novaddt::Merge2DTracks, novaddt::HoughTracker, novaddt::NNFastMMTrigger, calib::CosmicCalib, novaddt::UpMuTestTrigger, DataCheck::HardwareStatusCheck, novaddt::MoonShadow, novaddt::SupernovaTrigger, novaddt::NuESelect, novaddt::NuMuTrigger, novaddt::DDTTrackMerge, calib::StopperSelection, novaddt::SlicePrescale, calib::RockMuonStopperSelection, novaddt::DDTStreamer, calib::ThroughgoingSelection, novaddt::SingletonRejection, novaddt::EventPrescale, novaddt::ContainedSlice, novaddt::RemoveOneDSlices, novaddt::RemoveSpatialNoise, novaddt::Slicer3D, and novaddt::RestrictHitsByPlane.

Definition at line 79 of file EDFilter.h.

80 {}

virtual bool art::EDFilter::endRun ( Run & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >, calib::MuondEdxAna, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::MuonTrackHits, calib::DetRespDrift, calib::MuondEdx, skim::RandomEventFilter, calib::FindOutliers, calib::SumRunsCalib, and calib::SumSubrunsCalib.

Definition at line 87 of file EDFilter.h.

     {
       return true;
     }

virtual bool art::EDFilter::endSubRun ( SubRun & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::TimingCalFilter, calib::CosmicCalib, calib::FindOutliers, and calib::SumSubrunsCalib.

Definition at line 97 of file EDFilter.h.

     {
       return true;
     }

virtual bool art::EDFilter::filter ( Event & )

privatepure virtual

Implemented in art::MixFilter< T >, trident::DimuonSliceAna, runh::BadDataFilter, calib::MuondEdxAna, novaddt::MichelETrigger, skim::CellHitSkimmer, calib::DCMTimingOffset, calib::MuonTrackHits, novaddt::UpMuTrigger, novaddt::Multiplet, mono::MonopoleTrack, filter::Filter, art::EventIDFilter, util::TimeFilter, showere::ShowerEnergyFilterMC, calib::DetRespDrift, calib::MuondEdx, novaddt::Merge2DTracks, novaddt::HorizontalMuonTrigger, chaninfo::FindSwappedChannels, util::RunEventFilter, bsf::BremShowerFilter, mono::SlowMonopoleFilt, calhit::HasCellHits, calib::TimingCalFilter, filter::TruthContain, novaddt::SlowMMTrigger, util::EventFilterNoSlice, novaddt::HoughTracker, novaddt::NNFastMMTrigger, mono::MonopoleCluster, util::HasStandardRecord, novaddt::ClusterConvert, novaddt::DropoutDCMFilter, novaddt::FastMMTrigger, mono::EventSelector, novaddt::UpMuTestTrigger, comi::NumiFiltering, novaddt::ActivityTriggerAna, evgen::GENIEFilter, novaddt::SlowMonopoleTrigger, supernova::HighEFinder, calib::StopperFilter, EliminateBeamSpills, novaddt::FEBFlashFilter, novaddt::ActiveDCMFilter, EventFilter, novaddt::MoonShadow, novaddt::SupernovaTrigger, skim::RandomEventFilter, DataCheck::HardwareStatusCheck, beamlinereco::DigitizerSaturationFilter, calib::CosmicCalib, novaddt::FEBOverflowTrigger, beamlinereco::ToFFilter, novaddt::ActivityTrigger, filter::FLSFilter, novaddt::NuESelect, jmshower::RecoJMShowerFilter, EvTimeFilter, snutil::DDSNEWSfilter, util::RemoveBeamSpillsPrecise, calib::FindOutliers, mono::HighEnergySliceRemoval, novaddt::DDTTrackMerge, novaddt::TriCellTrigger, novaddt::DDTDemo, novaddt::SlicePrescale, novaddt::DBSlicer, art::BlockingPrescaler, novaddt::DDTStreamer, novaddt::NuMuTrigger, beamlinereco::GoodBeamlineEventFilter, util::RemoveTBSpills, util::RemoveBeamSpills, novaddt::SingletonRejection, novaddt::HighETrigger, air::AirFilter, calib::StopperSelection, novaddt::EventPrescale, novaddt::TimeSlice, calib::RockMuonStopperSelection, novaddt::TimeDCMSlice, calib::ThroughgoingSelection, evgen::OccupiedSpillFilter, novaddt::DCMSlice, novaddt::HighADCFilter, highe::HighEnergyFilt, novaddt::RemoveOneDSlices, novaddt::RemoveSpatialNoise, novaddt::SpaceSlice, novaddt::ContainedSlice, novaddt::Slicer3D, art::Prescaler, calib::SumRunsCalib, novaddt::RemoveNoise, novaddt::RestrictHitsByPlane, comi::CanaFilter, tut::TutFilter, novaddt::TDSlice, novaddt::Clusterer, calib::SumSubrunsCalib, novaddt::HighSortByTDC, novaddt::SortByDCM, novaddt::SortByPlane, novaddt::SortByTDC, util::MergeSubruns, lem::BackgroundEnricher, util::CopyCellHits, util::NonEmptyCluster, filter::SkipNEvents, lem::ApplyFilter, and evgen::CRVFilter.

Referenced by workerType().

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

inherited

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

template<typename PROD , BranchType B>

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

inline

Definition at line 131 of file EDFilter.h.

References moduleDescription_.

Referenced by novaddt::HoughTrackMaker::create_associations().

   {
     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 art::ModuleDescription::moduleLabel().

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

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

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 189 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

 {
   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 204 of file Consumer.h.

References T.

 {
   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 214 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

 {
   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(), and string.

     {
       return true;
     }

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

staticinherited

Referenced by art::RootOutput::beginSubRun(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EmptyEvent::readRun_(), and art::EmptyEvent::readSubRun_().

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

protectedinherited

virtual void art::EDFilter::respondToCloseInputFile ( FileBlock const & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 105 of file EDFilter.h.

106 {}

virtual void art::EDFilter::respondToCloseOutputFiles ( FileBlock const & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 111 of file EDFilter.h.

112 {}

virtual void art::EDFilter::respondToOpenInputFile ( FileBlock const & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 102 of file EDFilter.h.

103 {}

virtual void art::EDFilter::respondToOpenOutputFiles ( FileBlock const & )

inlineprivatevirtual

Reimplemented in art::MixFilter< T >.

Definition at line 108 of file EDFilter.h.

109 {}

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

inlineprivate

Definition at line 115 of file EDFilter.h.

References fetch_tb_beamline_files::md, moduleDescription_, and art::Consumer::setModuleDescription().

     {
       moduleDescription_ = md;
       // Since the module description in the Consumer base class is
       // owned by pointer, we must give it the owned object of this
       // class--i.e. moduleDescription_, not md.
       Consumer::setModuleDescription(moduleDescription_);
     }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Referenced by art::RootOutput::endJob().

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

protectedinherited

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

inlineprivate

Definition at line 69 of file EDFilter.h.

References filter().

     {
       return "WorkerT<EDFilter>";
     }

Friends And Related Function Documentation

template<typename T >

friend class WorkerT

friend

Definition at line 36 of file EDFilter.h.

Member Data Documentation

bool art::EDFilter::checkPutProducts_ {true}

private

Definition at line 126 of file EDFilter.h.

CPC_exempt_ptr art::EDFilter::current_context_ {nullptr}

private

Definition at line 125 of file EDFilter.h.

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

static

Definition at line 33 of file EDFilter.h.

Referenced by evgen::GENIEFilter::filter().

ModuleDescription art::EDFilter::moduleDescription_ {}

private

Definition at line 124 of file EDFilter.h.

Referenced by getProductID(), and setModuleDescription().

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

static

Definition at line 32 of file EDFilter.h.

Referenced by evgen::GENIEFilter::filter().

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

art/Framework/Core/EDFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation