Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
art::EDFilter Class Referenceabstract

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

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

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< Tconsumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< Tconsumes (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< TconsumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< TmayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< TmayConsume (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< TmayConsumeView (InputTag const &it)
 
base_engine_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (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< Consumernon_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

Definition at line 54 of file EDFilter.h.

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.

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
virtual bool art::EDFilter::beginRun ( Run )
inlineprivatevirtual
virtual bool art::EDFilter::beginSubRun ( SubRun )
inlineprivatevirtual
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.

147 {
148  if (!moduleContext_)
149  return ProductToken<T>::invalid();
150 
151  consumables_[BT].emplace_back(ConsumableType::Product,
152  TypeID{typeid(T)},
153  it.label(),
154  it.instance(),
155  it.process());
156  return ProductToken<T>{it};
157 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 161 of file Consumer.h.

References T.

162 {
163  if (!moduleContext_)
164  return;
165 
166  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
167 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
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.

172 {
173  if (!moduleContext_)
174  return ViewToken<T>::invalid();
175 
176  consumables_[BT].emplace_back(ConsumableType::ViewElement,
177  TypeID{typeid(T)},
178  it.label(),
179  it.instance(),
180  it.process());
181  return ViewToken<T>{it};
182 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
base_engine_t& art::EngineCreator::createEngine ( seed_t  seed)
inherited
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
virtual bool art::EDFilter::endRun ( Run )
inlineprivatevirtual
virtual bool art::EDFilter::endSubRun ( SubRun )
inlineprivatevirtual
virtual bool art::EDFilter::filter ( Event )
privatepure virtual

Implemented in art::MixFilter< T >, 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
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().

132  {
133  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
134  instanceName);
135  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
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().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
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.

190 {
191  if (!moduleContext_)
192  return ProductToken<T>::invalid();
193 
194  consumables_[BT].emplace_back(ConsumableType::Product,
195  TypeID{typeid(T)},
196  it.label(),
197  it.instance(),
198  it.process());
199  return ProductToken<T>{it};
200 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 204 of file Consumer.h.

References T.

205 {
206  if (!moduleContext_)
207  return;
208 
209  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
210 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
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.

215 {
216  if (!moduleContext_)
217  return ViewToken<T>::invalid();
218 
219  consumables_[BT].emplace_back(ConsumableType::ViewElement,
220  TypeID{typeid(T)},
221  it.label(),
222  it.instance(),
223  it.process());
224  return ViewToken<T>{it};
225 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
bool art::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID(), and string.

41  {
42  return true;
43  }
static cet::exempt_ptr<Consumer> art::Consumer::non_module_context ( )
staticinherited
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().

116  {
118  // Since the module description in the Consumer base class is
119  // owned by pointer, we must give it the owned object of this
120  // class--i.e. moduleDescription_, not md.
122  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
void setModuleDescription(ModuleDescription const &md)
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().

70  {
71  return "WorkerT<EDFilter>";
72  }

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: