LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
filt::EmptyFilter Class Reference
Inheritance diagram for filt::EmptyFilter:
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

 EmptyFilter (fhicl::ParameterSet const &)
 
virtual ~EmptyFilter ()
 
bool filter (art::Event &evt)
 
void reconfigure (fhicl::ParameterSet const &p)
 
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_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 Attributes

std::string fHitsModuleLabel
 
double fMinIonization
 
int fMinNumHits
 
TH1I * totHitHist
 
TH1I * selHitHist
 
TH1I * rejHitHist
 
TH2D * totIonSelHist
 
TH2D * totIonRejHist
 
TH1I * numEventHist
 
TH2I * resultTable
 

Detailed Description

Definition at line 44 of file EmptyFilter_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

filt::EmptyFilter::EmptyFilter ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 75 of file EmptyFilter_module.cc.

References reconfigure().

76  {
77  this->reconfigure(pset);
78  }
void reconfigure(fhicl::ParameterSet const &p)
filt::EmptyFilter::~EmptyFilter ( )
virtual

Definition at line 81 of file EmptyFilter_module.cc.

82  {
83  }

Member Function Documentation

void filt::EmptyFilter::beginJob ( )
virtual

Reimplemented from art::EDFilter.

Definition at line 94 of file EmptyFilter_module.cc.

References art::TFileDirectory::make(), numEventHist, rejHitHist, resultTable, selHitHist, totHitHist, totIonRejHist, and totIonSelHist.

95  {
97  totHitHist = tfs->make<TH1I>("totHitHist","Hit Number Per Event",750,0,1500);
98  totIonSelHist = tfs->make<TH2D>("totIonSelHist","Ionization Per selected Event",500,0,20000,500,0,20000);
99  totIonRejHist = tfs->make<TH2D>("totIonRejHist","Ionization Per rejected Event",500,0,20000,500,0,20000);
100  selHitHist= tfs->make<TH1I>("selHitHist","Hit Number Per selected Event",750, 0 ,1500);
101  rejHitHist= tfs->make<TH1I>("rejHitHist","Hit Number Per rejected Event",750, 0 ,1500);
102  numEventHist = tfs->make<TH1I>("numEventHist","Number of Events Processed and Selected",2,0,2);
103  resultTable = tfs->make<TH2I>("resultTable","Event number is x axis, y axis bins 0=selected,1= hit num, 2= one plane empty, 3= too little ionization",40000,0,40000,4,0,4);
104 
105  }
T * make(ARGS...args) const
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 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
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 }
ConsumableProducts consumables_
Definition: Consumer.h:138
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 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
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 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
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 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
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  }
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
bool filt::EmptyFilter::filter ( art::Event evt)
virtual

Implements art::EDFilter.

Definition at line 108 of file EmptyFilter_module.cc.

References DEFINE_ART_MODULE, art::EventID::event(), fHitsModuleLabel, fMinIonization, fMinNumHits, art::DataViewImpl::getByLabel(), art::Event::id(), numEventHist, art::PtrVector< T >::push_back(), rejHitHist, resultTable, selHitHist, art::PtrVector< T >::size(), totHitHist, totIonRejHist, and totIonSelHist.

109  {
110 
111  numEventHist->Fill(0);
112  int failFlag = 0;
113  double indIon(0.0), colIon(0.0);
114  int event = evt.id().event();
115 
118  evt.getByLabel(fHitsModuleLabel,hitHandle);
120  for(unsigned int i = 0; i < hitHandle->size(); ++i){
121  art::Ptr<recob::Hit> prod(hitHandle, i);
122  hitvec.push_back(prod);
123  }
124 
125  int numHits = hitvec.size();
126  if( numHits> 0) {
127  totHitHist->Fill(numHits);
128  if(numHits < fMinNumHits) {
129  mf::LogWarning("EmptyFilterModule") << "Too few hits: "<< numHits;
130  failFlag=1;
131  }
132  if(failFlag==0) {
133  //Check to see if either plane is empty
134 /* BB: This code section is broken.
135  if(geom->Cryostat(cs).TPC(tpc).Plane(plane).SignalType() == geo::kInduction){
136  std::cout << "Induction empty." << std::endl;
137  failFlag=2;
138  }
139 */
140  unsigned int j(0);
141  //advances j to collection plane
142  while(hitvec[j]->WireID().Plane == 0) {
143  indIon+=hitvec[j]->Integral();
144  j++;
145  if(j == hitvec.size()) {
146  failFlag=2;
147  mf::LogWarning("EmptyFilterModule") << "Collection empty.";
148  }
149  }
150  for(; j < hitvec.size(); j++){
151  colIon+=hitvec[j]->Integral();
152  }
153  double minIon=0;
154  if((1.92*indIon)>colIon) minIon = colIon;
155  else minIon=1.92*indIon;
156  mf::LogWarning("EmptyFilterModule") <<"min ionization " << minIon
157  << " " << fMinIonization;
158  if (minIon < fMinIonization) failFlag=3;
159  }
160  }
161  else failFlag = 1;
162  resultTable->Fill(event,failFlag);
163  if(failFlag>0){
164  totIonRejHist->Fill(indIon,colIon);
165  rejHitHist->Fill(numHits);
166  return false;
167  }
168  numEventHist->Fill(1);
169  totIonSelHist->Fill(indIon,colIon);
170  selHitHist->Fill(numHits);
171 
172  return true;
173  }
std::string fHitsModuleLabel
void push_back(Ptr< U > const &p)
Definition: PtrVector.h:441
size_type size() const
Definition: PtrVector.h:308
bool getByLabel(std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
Definition: DataViewImpl.h:344
MaybeLogger_< ELseverityLevel::ELsev_warning, false > LogWarning
EventNumber_t event() const
Definition: EventID.h:117
recob::tracking::Plane Plane
Definition: TrackState.h:17
EventID id() const
Definition: Event.h:56
Event finding and building.
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  }
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  }
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 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
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 }
ConsumableProducts consumables_
Definition: Consumer.h:138
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 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
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  }
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 }
bool requireConsumes_
Definition: Consumer.h:137
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
void filt::EmptyFilter::reconfigure ( fhicl::ParameterSet const &  p)

Definition at line 86 of file EmptyFilter_module.cc.

References fHitsModuleLabel, fMinIonization, fMinNumHits, and fhicl::ParameterSet::get().

Referenced by EmptyFilter().

87  {
88  fHitsModuleLabel = p.get< std::string > ("HitsModuleLabel");
89  fMinIonization = p.get< double > ("MinIonization");
90  fMinNumHits = p.get< int > ("MinHits");
91  }
std::string fHitsModuleLabel
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 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
bool moduleContext_
Definition: Consumer.h:136
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_) {
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 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
bool requireConsumes_
Definition: Consumer.h:137
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
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 filt::EmptyFilter::fHitsModuleLabel
private

Definition at line 59 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

double filt::EmptyFilter::fMinIonization
private

Definition at line 60 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

int filt::EmptyFilter::fMinNumHits
private

Definition at line 61 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

TH1I* filt::EmptyFilter::numEventHist
private

Definition at line 67 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

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

Definition at line 32 of file EDFilter.h.

TH1I* filt::EmptyFilter::rejHitHist
private

Definition at line 64 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2I* filt::EmptyFilter::resultTable
private

Definition at line 68 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH1I* filt::EmptyFilter::selHitHist
private

Definition at line 63 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH1I* filt::EmptyFilter::totHitHist
private

Definition at line 62 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2D* filt::EmptyFilter::totIonRejHist
private

Definition at line 66 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2D* filt::EmptyFilter::totIonSelHist
private

Definition at line 65 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().


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