HcalRawToDigi/plugins/HcalLaserHFFilter2012.cc

0001 // -*- C++ -*-
0002 //
0003 // Package:    HcalLaserHFFilter2012
0004 // Class:      HcalLaserHFFilter2012
0005 //
0006 /**\class HcalLaserHFFilter2012 HcalLaserHFFilter2012.cc UserCode/HcalLaserHFFilter2012/src/HcalLaserHFFilter2012.cc
0007
0008  Description: [one line class summary]
0009
0010  Implementation:
0011      [Notes on implementation]
0012 */
0013 //
0014 // Original Author:
0015 //         Created:  Fri Oct 19 13:15:44 EDT 2012
0016 //
0017 //
0018
0019 // system include files
0020 #include <memory>
0021
0022 // user include files
0023 #include "FWCore/Framework/interface/Frameworkfwd.h"
0024 #include "FWCore/Framework/interface/one/EDFilter.h"
0025
0026 #include "FWCore/Framework/interface/Event.h"
0027 #include "FWCore/Framework/interface/MakerMacros.h"
0028
0029 #include "FWCore/ParameterSet/interface/ParameterSet.h"
0030
0031 #include "FWCore/Framework/interface/ESHandle.h"
0032
0033 #include <cmath>
0034 #include <iostream>
0035 #include <sstream>
0036 #include <fstream>
0037
0038 #include "FWCore/Framework/interface/Run.h"
0039 #include "FWCore/Framework/interface/LuminosityBlock.h"
0040
0041 #include "DataFormats/HcalRecHit/interface/HcalRecHitCollections.h"
0042
0043 #include "DataFormats/HcalDigi/interface/HcalDigiCollections.h"
0044 #include "CalibFormats/HcalObjects/interface/HcalCoderDb.h"
0045
0046 //
0047 // class declaration
0048 //
0049
0050 class HcalLaserHFFilter2012 : public edm::one::EDFilter<> {
0051 public:
0052   explicit HcalLaserHFFilter2012(const edm::ParameterSet&);
0053   ~HcalLaserHFFilter2012() override;
0054
0055   static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
0056
0057 private:
0058   bool filter(edm::Event&, const edm::EventSetup&) override;
0059   void endJob() override;
0060
0061   // ----------member data ---------------------------
0062   bool verbose_;  // if set to true, then the run:LS:event for any event failing the cut will be printed out
0063   std::string
0064       prefix_;  // prefix will be printed before any event if verbose mode is true, in order to make searching for events easier
0065   int minCalibChannelsHFLaser_;  // set minimum number of HF Calib events that causes an event to be considered a bad (i.e., HF laser) event
0066   edm::InputTag digiLabel_;
0067   edm::EDGetTokenT<HcalCalibDigiCollection> tok_calib_;
0068
0069   bool WriteBadToFile_;
0070   bool forceFilterTrue_;
0071   std::ofstream outfile_;
0072 };
0073
0074 //
0075 // constants, enums and typedefs
0076 //
0077
0078 //
0079 // static data member definitions
0080 //
0081
0082 //
0083 // constructors and destructor
0084 //
0085 HcalLaserHFFilter2012::HcalLaserHFFilter2012(const edm::ParameterSet& ps) {
0086   //now do what ever initialization is needed
0087   verbose_ = ps.getUntrackedParameter<bool>("verbose", false);
0088   prefix_ = ps.getUntrackedParameter<std::string>("prefix", "");
0089   minCalibChannelsHFLaser_ = ps.getUntrackedParameter<int>("minCalibChannelsHFLaser", 10);
0090   edm::InputTag digi_default("hcalDigis");
0091   digiLabel_ = ps.getUntrackedParameter<edm::InputTag>("digiLabel", digi_default);
0092   tok_calib_ = consumes<HcalCalibDigiCollection>(digiLabel_);
0093   WriteBadToFile_ = ps.getUntrackedParameter<bool>("WriteBadToFile", false);
0094   if (WriteBadToFile_)
0095     outfile_.open("badHcalLaserList_hffilter.txt");
0096   forceFilterTrue_ = ps.getUntrackedParameter<bool>("forceFilterTrue", false);
0097
0098 }  // HcalLaserHFFilter2012::HcalLaserHFFilter2012  constructor
0099
0100 HcalLaserHFFilter2012::~HcalLaserHFFilter2012() {
0101   // do anything here that needs to be done at destruction time
0102   // (e.g. close files, deallocate resources etc.)
0103 }
0104
0105 //
0106 // member functions
0107 //
0108
0109 // ------------ method called on each new Event  ------------
0110 bool HcalLaserHFFilter2012::filter(edm::Event& iEvent, const edm::EventSetup& iSetup) {
0111   // Step 1:: try to get calib digi collection.
0112   // Return true if collection not found?  Or false?  What should default behavior be?
0113   edm::Handle<HcalCalibDigiCollection> calib_digi;
0114   if (!(iEvent.getByToken(tok_calib_, calib_digi))) {
0115     edm::LogWarning("HcalLaserHFFilter2012") << digiLabel_ << " calib_digi not available";
0116     return true;
0117   }
0118
0119   if (!(calib_digi.isValid())) {
0120     edm::LogWarning("HcalLaserHFFilter2012") << digiLabel_ << " calib_digi is not valid";
0121     return true;
0122   }
0123
0124   // Step 2:  Count HF digi calib channels
0125   int ncalibHF = 0;  // this will track number of HF digi channels
0126
0127   for (HcalCalibDigiCollection::const_iterator Calibiter = calib_digi->begin(); Calibiter != calib_digi->end();
0128        ++Calibiter) {
0129     const HcalCalibDataFrame digi = (const HcalCalibDataFrame)(*Calibiter);
0130     if (digi.zsMarkAndPass())
0131       continue;  // skip digis labeled as "mark and pass" in NZS events
0132     HcalCalibDetId myid = (HcalCalibDetId)digi.id();
0133     if (myid.hcalSubdet() != HcalForward)
0134       continue;
0135     ++ncalibHF;
0136     if (ncalibHF >= minCalibChannelsHFLaser_) {
0137       if (verbose_)
0138         std::cout << prefix_ << iEvent.id().run() << ":" << iEvent.luminosityBlock() << ":" << iEvent.id().event()
0139                   << std::endl;
0140       if (WriteBadToFile_)
0141         outfile_ << iEvent.id().run() << ":" << iEvent.luminosityBlock() << ":" << iEvent.id().event() << std::endl;
0142       if (forceFilterTrue_)
0143         return true;  // if special input boolean set, always return true, regardless of filter decision
0144       else
0145         return false;
0146     }
0147   }
0148
0149   return true;
0150 }  // HcalLaserHFFilter2012::filter
0151
0152 // ------------ method called once each job just after ending the event loop  ------------
0153 void HcalLaserHFFilter2012::endJob() {
0154   if (WriteBadToFile_)
0155     outfile_.close();
0156 }
0157
0158 // ------------ method fills 'descriptions' with the allowed parameters for the module  ------------
0159 void HcalLaserHFFilter2012::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
0160   //The following says we do not know what parameters are allowed so do no validation
0161   // Please change this to state exactly what you do use, even if it is no parameters
0162   edm::ParameterSetDescription desc;
0163   desc.setUnknown();
0164   descriptions.addDefault(desc);
0165 }
0166 //define this as a plug-in
0167 DEFINE_FWK_MODULE(HcalLaserHFFilter2012);