LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
simfilter::FilterPrimaryPDG Class Reference
Inheritance diagram for simfilter::FilterPrimaryPDG:
art::EDFilter art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper

Public Types

using ModuleType = EDFilter
 
using WorkerType = WorkerT< EDFilter >
 
template<typename UserConfig >
using Table = ProducerBase::Table< UserConfig >
 

Public Member Functions

 FilterPrimaryPDG (fhicl::ParameterSet const &pset)
 
virtual ~FilterPrimaryPDG ()
 
bool filter (art::Event &)
 
virtual void reconfigure (fhicl::ParameterSet const &)
 
virtual void beginJob ()
 
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 Attributes

std::string fG4ModuleLabel
 
std::vector< int > fPrimaryVec
 

Detailed Description

Definition at line 48 of file FilterPrimaryPDG_module.cc.

Member Typedef Documentation

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

simfilter::FilterPrimaryPDG::FilterPrimaryPDG ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 85 of file FilterPrimaryPDG_module.cc.

86  {
87  this->reconfigure(pset);
88  }
simfilter::FilterPrimaryPDG::reconfigure
virtual void reconfigure(fhicl::ParameterSet const &)
Definition: FilterPrimaryPDG_module.cc:105
simfilter::FilterPrimaryPDG::~FilterPrimaryPDG ( )
virtual

Definition at line 92 of file FilterPrimaryPDG_module.cc.

93  {
94  }

Member Function Documentation

void simfilter::FilterPrimaryPDG::beginJob ( )
virtual

Reimplemented from art::EDFilter.

Definition at line 97 of file FilterPrimaryPDG_module.cc.

98  {
99  // art::ServiceHandle<art::TFileService> tfs;
100  art::ServiceHandle<geo::Geometry> geo;
101 
102  }
geo
Namespace collecting geometry-related classes utilities.
Definition: TrackContainmentAlg.hh:20
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().

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

Definition at line 162 of file Consumer.h.

163 {
164  if (!moduleContext_)
165  return;
166 
167  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
168 }
art::Consumer::consumables_
ConsumableProducts consumables_
Definition: Consumer.h:138
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
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().

173 {
174  if (!moduleContext_)
175  return ViewToken<T>::invalid();
176 
177  consumables_[BT].emplace_back(ConsumableType::ViewElement,
178  TypeID{typeid(T)},
179  it.label(),
180  it.instance(),
181  it.process());
182  return ViewToken<T>{it};
183 }
art::ViewToken::invalid
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
art::Consumer::consumables_
ConsumableProducts consumables_
Definition: Consumer.h:138
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
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().

27 {
28  return rng()->createEngine(placeholder_schedule_id(), seed);
29 }
seed
long seed
Definition: chem4.cc:68
art::EngineCreator::rng
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
Definition: EngineCreator.cc:58
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().

34 {
35  return rng()->createEngine(
36  placeholder_schedule_id(), seed, kind_of_engine_to_make);
37 }
seed
long seed
Definition: chem4.cc:68
art::EngineCreator::rng
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
Definition: EngineCreator.cc:58
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().

43 {
44  return rng()->createEngine(
45  placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
46 }
seed
long seed
Definition: chem4.cc:68
art::EngineCreator::rng
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
Definition: EngineCreator.cc:58
CurrentProcessingContext const * art::EDFilter::currentContext ( ) const
protectedinherited

Definition at line 120 of file EDFilter.cc.

References art::EDFilter::current_context_.

121  {
122  return current_context_.get();
123  }
art::EDFilter::current_context_
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
bool simfilter::FilterPrimaryPDG::filter ( art::Event &  evt)
virtual

Implements art::EDFilter.

Definition at line 112 of file FilterPrimaryPDG_module.cc.

References DEFINE_ART_MODULE, cheat::ParticleInventoryService::ParticleList(), s, and sim::ParticleList::size().

113  {
114 
115  //get the list of particles from this event
116  art::ServiceHandle<cheat::ParticleInventoryService> pi_serv;
117  art::ServiceHandle<geo::Geometry> geom;
118 
119  // get the particles from the back tracker
120  const sim::ParticleList& Particles = pi_serv->ParticleList();
121  std::vector<const simb::MCParticle*> pvec;
122  pvec.reserve(Particles.size());
123  for (const auto& PartPair: Particles) {
124  pvec.push_back(PartPair.second);
125  // fPDGCodes->Fill(PartPair.second->PdgCode());
126  }
127 
128  bool pdgDesired(false);
129  for(unsigned int i = 0; i < pvec.size(); ++i)
130  {
131  for (int pdg : fPrimaryVec)
132  {
133  const std::string sprim("primary");
134  if(pvec[i]->PdgCode() == pdg)
135  {
136  Char_t tProcess[50];
137  for(unsigned int s = 0; s < pvec[i]->Process().length(); ++s)
138  *(tProcess+s) = pvec[i]->Process()[s];
139  std::string sProcess(tProcess);
140  if (!sProcess.compare(sprim))
141  {
142  mf::LogInfo("FilterPrimaryPDG") << " Found a primary " << pdg << " in event.";
143  pdgDesired = true;
144  }
145  }
146  }
147 
148  }
149 
150  return pdgDesired;
151  }
s
Float_t s
Definition: plot.C:23
mf::LogInfo
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
Definition: MessageLogger.h:212
sim::ParticleList::size
size_type size() const
Definition: ParticleList.h:313
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_().

52 {
53  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
54  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
55 }
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_.

132  {
133  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
134  instanceName);
135  }
art::EDFilter::moduleDescription_
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 B, and 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  }
B
Int_t B
Definition: plot.C:25
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().

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

Definition at line 205 of file Consumer.h.

206 {
207  if (!moduleContext_)
208  return;
209 
210  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
211 }
art::Consumer::consumables_
ConsumableProducts consumables_
Definition: Consumer.h:138
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
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().

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

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

41  {
42  return true;
43  }
cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )
staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), 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::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

77 {
78  static Consumer invalid{InvalidTag{}};
79  return &invalid;
80 }
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().

90 {
91  if (!moduleContext_)
92  return;
93 
94  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
95  for (auto& consumablesPerBranch : consumables_) {
96  cet::sort_all(consumablesPerBranch);
97  }
98 }
art::Consumer::requireConsumes_
bool requireConsumes_
Definition: Consumer.h:137
art::Consumer::consumables_
ConsumableProducts consumables_
Definition: Consumer.h:138
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
void simfilter::FilterPrimaryPDG::reconfigure ( fhicl::ParameterSet const &  p)
virtual

Definition at line 105 of file FilterPrimaryPDG_module.cc.

References fhicl::ParameterSet::get().

106  {
107  fPrimaryVec = p.get<std::vector<int> >("PrimaryParticles");
108  return;
109  }
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().

126 {
127  if (!moduleContext_)
128  return;
129 
130  // If none of the branches have missing consumes statements, exit early.
131  if (std::all_of(cbegin(missingConsumes_),
132  cend(missingConsumes_),
133  [](auto const& perBranch) { return perBranch.empty(); }))
134  return;
135 
136  constexpr cet::HorizontalRule rule{60};
137  mf::LogPrint log{"MTdiagnostics"};
138  log << '\n'
139  << rule('=') << '\n'
140  << "The following consumes (or mayConsume) statements are missing from\n"
141  << module_context(moduleDescription_) << '\n'
142  << rule('-') << '\n';
143 
144  cet::for_all_with_index(
145  missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
146  for (auto const& pi : perBranch) {
147  log << " "
148  << assemble_consumes_statement(static_cast<BranchType>(i), pi)
149  << '\n';
150  }
151  });
152  log << rule('=');
153 }
mf::MaybeLogger_
Definition: MessageLogger.h:114
art::Consumer::moduleDescription_
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
util::pi
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
Definition: PhysicalConstants.h:80
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
art::Consumer::missingConsumes_
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

103 {
104  // Early exits if consumes tracking has been disabled or if the
105  // consumed product is an allowed consumable.
106  if (!moduleContext_)
107  return;
108 
109  if (cet::binary_search_all(consumables_[bt], pi))
110  return;
111 
112  if (requireConsumes_) {
113  throw Exception(errors::ProductRegistrationFailure,
114  "Consumer: an error occurred during validation of a "
115  "retrieved product\n\n")
116  << "The following consumes (or mayConsume) statement is missing from\n"
117  << module_context(moduleDescription_) << ":\n\n"
118  << " " << assemble_consumes_statement(bt, pi) << "\n\n";
119  }
120 
121  missingConsumes_[bt].insert(pi);
122 }
art::Consumer::moduleDescription_
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
art::Consumer::requireConsumes_
bool requireConsumes_
Definition: Consumer.h:137
art::Exception
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
util::pi
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
Definition: PhysicalConstants.h:80
art::Consumer::consumables_
ConsumableProducts consumables_
Definition: Consumer.h:138
art::Consumer::moduleContext_
bool moduleContext_
Definition: Consumer.h:136
art::Consumer::missingConsumes_
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139

Member Data Documentation

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

Definition at line 33 of file EDFilter.h.

std::string simfilter::FilterPrimaryPDG::fG4ModuleLabel
private

Definition at line 69 of file FilterPrimaryPDG_module.cc.

std::vector<int> simfilter::FilterPrimaryPDG::fPrimaryVec
private

Definition at line 70 of file FilterPrimaryPDG_module.cc.

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: