Port ProtoDUNE's hit filter to sbnd

Author: absolution1

sbndcode/Filters/NumberOfHitsFilter_module.cc

@@ -0,0 +1,122 @@
+////////////////////////////////////////////////////////////////////////
+//
+//  Port of ProtoDUNE's hit count filter
+//  Very simple module to filter out events with too many hits
+//  - Designed to prevent jobs hanging on very large events
+//
+//  Orginially by Leigh Whitehead - leigh.howard.whitehead@cern.ch
+//
+////////////////////////////////////////////////////////////////////////
+
+// Framework includes
+#include "art/Framework/Core/EDFilter.h"
+#include "art/Framework/Principal/Event.h"
+#include "art/Framework/Principal/Run.h"
+#include "art/Framework/Principal/Handle.h"
+#include "art/Framework/Services/Registry/ServiceHandle.h"
+#include "art_root_io/TFileService.h"
+#include "art/Framework/Core/ModuleMacros.h"
+#include "art/Framework/Services/Registry/ActivityRegistry.h"
+#include "messagefacility/MessageLogger/MessageLogger.h"
+#include "fhiclcpp/ParameterSet.h"
+
+#include "lardataobj/RecoBase/Hit.h"
+#include "lardata/DetectorInfoServices/DetectorPropertiesService.h"
+
+namespace hit{
+  class NumberOfHitsFilter;
+}
+
+class hit::NumberOfHitsFilter : public art::EDFilter{
+public:
+  
+  explicit NumberOfHitsFilter(fhicl::ParameterSet const& pset);
+  virtual ~NumberOfHitsFilter();
+  
+  void beginJob() override;
+  bool filter(art::Event& evt) override;
+  bool beginRun(art::Run& r) override;
+  void endJob() override;
+
+private:
+
+  bool fLimitPerTPC;
+  unsigned int fHitLimit;
+  std::string fHitModule;
+  bool fScaleThresholdForReadoutWindow;
+  bool fVerbose;
+};
+  
+//-----------------------------------------------------------------------
+hit::NumberOfHitsFilter::NumberOfHitsFilter(fhicl::ParameterSet const& pset):
+  EDFilter(pset)
+{
+70G  fLimitPerTPC = pset.get<bool>("LimitPerTPC");
+  fHitLimit = pset.get<unsigned int>("HitLimit");
+  fHitModule = pset.get<std::string>("HitModule");
+  fVerbose = pset.get<bool>("Verbose");
+  fScaleThresholdForReadoutWindow = pset.get<bool>("ScaleThresholdForReadoutWindow");
+}
+
+//-----------------------------------------------------------------------
+hit::NumberOfHitsFilter::~NumberOfHitsFilter(){}
+
+//-----------------------------------------------------------------------
+void hit::NumberOfHitsFilter::beginJob() {}
+//-----------------------------------------------------------------------
+bool hit::NumberOfHitsFilter::beginRun(art::Run& r){
+  if (fScaleThresholdForReadoutWindow){
+    unsigned int fSize = art::ServiceHandle<detinfo::DetectorPropertiesService const>{}->DataForJob().ReadOutWindowSize();
+    fHitLimit = (unsigned int)(fHitLimit*fSize/3400.); //tuned to the nominal window size for SBND
+    std::cout<<"Scale HitLimit based on readout window size "<<fSize<<std::endl;
+    std::cout<<"HitLimit = "<<fHitLimit<<std::endl;
+  }
+  return true;
+}
+//-----------------------------------------------------------------------
+bool hit::NumberOfHitsFilter::filter(art::Event& evt){
+
+  // Get the hit collection from the event 
+  auto allHits = evt.getValidHandle<std::vector<recob::Hit> >(fHitModule);  
+ 
+  bool result = true;
+
+  if(fLimitPerTPC){
+    // Find the number of hits per TPC and then filter based on a large value
+    std::map<unsigned int,unsigned int> hitsPerTPC;
+
+    for(auto const &hit : *allHits){
+      hitsPerTPC[hit.WireID().TPC]++;
+    }
+    
+    for(auto const m:  hitsPerTPC){
+
+      if (fVerbose) {
+        std::cout << m.second << " hits in TPC " << m.first << std::endl;
+      }
+
+      if(m.second > fHitLimit){
+        result = false;
+        break;
+      }
+    }
+  }
+  else{
+    if (fVerbose) {
+      std::cout << allHits->size() << " hits in all TPCs" << std::endl;
+    }
+
+
+    // This is the simplest thing we can do, just cut on the total number of hits
+    if (allHits->size() > fHitLimit){
+      result = false;
+    }
+  }
+
+
+  return result;
+}
+
+void hit::NumberOfHitsFilter::endJob() {}
+ 
+DEFINE_ART_MODULE(hit::NumberOfHitsFilter)

sbndcode/Filters/numberofhitsfilter.fcl

@@ -0,0 +1,14 @@
+BEGIN_PROLOG
+
+
+sbnd_numberofhitsfilter:
+{
+ module_type:                     "NumberOfHitsFilter"
+ LimitPerTPC:                     true
+ HitModule:                       "gaushit"
+ HitLimit:                        40000
+ ScaleThresholdForReadoutWindow:  true
+ Verbose:                         false
+}
+
+END_PROLOG