HBHENoiseFilter.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    HBHENoiseFilter
// Class:      HBHENoiseFilter
// 
//
// Original Author:  John Paul Chou (Brown)
//
//

#include <iostream>

#include "CommonTools/RecoAlgos/interface/HBHENoiseFilter.h"

#include "DataFormats/METReco/interface/HcalNoiseSummary.h"
#include "DataFormats/JetReco/interface/PFJetCollection.h"

//
// constants, enums and typedefs
//

//
// static data member definitions
//

//
// constructors and destructor
//

HBHENoiseFilter::HBHENoiseFilter(const edm::ParameterSet& iConfig)
{
  //now do what ever initialization is needed
  noiselabel_ = iConfig.getParameter<edm::InputTag>("noiselabel");
  minRatio_ = iConfig.getParameter<double>("minRatio");
  maxRatio_ = iConfig.getParameter<double>("maxRatio");
  minHPDHits_ = iConfig.getParameter<int>("minHPDHits");
  minRBXHits_ = iConfig.getParameter<int>("minRBXHits");
  minHPDNoOtherHits_ = iConfig.getParameter<int>("minHPDNoOtherHits");
  minZeros_ = iConfig.getParameter<int>("minZeros");
  minHighEHitTime_ = iConfig.getParameter<double>("minHighEHitTime");
  maxHighEHitTime_ = iConfig.getParameter<double>("maxHighEHitTime");
  maxRBXEMF_ = iConfig.getParameter<double>("maxRBXEMF");
  minNumIsolatedNoiseChannels_ = iConfig.getParameter<int>("minNumIsolatedNoiseChannels");
  minIsolatedNoiseSumE_ = iConfig.getParameter<double>("minIsolatedNoiseSumE");
  minIsolatedNoiseSumEt_ = iConfig.getParameter<double>("minIsolatedNoiseSumEt");  
  useTS4TS5_ = iConfig.getParameter<bool>("useTS4TS5");

  IgnoreTS4TS5ifJetInLowBVRegion_ = iConfig.getParameter<bool>("IgnoreTS4TS5ifJetInLowBVRegion");
  jetlabel_ =  iConfig.getParameter<edm::InputTag>("jetlabel");
  maxjetindex_ = iConfig.getParameter<int>("maxjetindex");
  maxNHF_ = iConfig.getParameter<double>("maxNHF");

}


HBHENoiseFilter::~HBHENoiseFilter()
{

}


//
// member functions
//

// ------------ method called on each new Event  ------------
bool
HBHENoiseFilter::filter(edm::Event& iEvent, const edm::EventSetup& iSetup)
{
   using namespace edm;

  // get the Noise summary object
  edm::Handle<HcalNoiseSummary> summary_h;
  iEvent.getByLabel(noiselabel_, summary_h);
  if(!summary_h.isValid()) {
    throw edm::Exception(edm::errors::ProductNotFound) << " could not find HcalNoiseSummary.\n";
    return true;
  }
  const HcalNoiseSummary summary = *summary_h;

  //  if(summary.HasBadRBXTS4TS5() == true) std::cout << "TS4TS5 rejection!" << std::endl;
  //  else                                  std::cout << "TS4TS5 passing!" << std::endl;
  

  // One HBHE region has HPD with low BV, which increases hits in HPD, and
  // often causes otherwise good events to be flagged as noise.

  bool goodJetFoundInLowBVRegion=false; // checks whether a jet is in a low BV region, where false noise flagging rate is higher.
  if ( IgnoreTS4TS5ifJetInLowBVRegion_==true)
    {
      edm::Handle<reco::PFJetCollection> pfjet_h;
      iEvent.getByLabel(jetlabel_, pfjet_h);
      if (pfjet_h.isValid()) 
    {
      // Loop over all jets up to (and including) maxjetindex.
      // If jet found in low-BV region, set goodJetFoundInLowBVRegion = true
      int jetindex=0;
      for( reco::PFJetCollection::const_iterator jet = pfjet_h->begin(); jet != pfjet_h->end(); ++jet) 
        {
          if (jetindex>maxjetindex_) break; // only look at first N jets (N specified by user)
          // Check whether jet is in low-BV region (0<eta<1.4, -1.8<phi<-1.4)
          if (jet->eta()>0 && jet->eta()<1.4 && 
          jet->phi()>-1.8 && jet->phi()<-1.4) 
        {
          if (maxNHF_<0 || (maxNHF_>0 &&  jet->neutralHadronEnergyFraction()<maxNHF_))
            {
              //std::cout <<"JET eta = "<<jet->eta()<<"  phi = "<<jet->phi()<<"  Energy = "<<jet->energy()<<"  neutral had fraction = "<<jet->neutralHadronEnergy()/jet->energy() <<std::endl;
              goodJetFoundInLowBVRegion=true;
              break;
            }
        }
          ++jetindex;
        }
    } //if (pfjet_h.isValid())
      else // no valid jet collection found
    {
      // If no jet collection found, do we want to throw a fatal exception?  Or just proceed normally, not treating the lowBV region as special?
      //throw edm::Exception(edm::errors::ProductNotFound) << " could not find PFJetCollection with label "<<jetlabel_<<".\n";
    }
    } // if (IgnoreTS4TS5ifJetInLowBVRegion_==true)

  if(summary.minE2Over10TS()<minRatio_) return false;
  if(summary.maxE2Over10TS()>maxRatio_) return false;
  if(summary.maxHPDHits()>=minHPDHits_) return false;
  if(summary.maxRBXHits()>=minRBXHits_) return false;
  if(summary.maxHPDNoOtherHits()>=minHPDNoOtherHits_) return false;
  if(summary.maxZeros()>=minZeros_) return false;
  if(summary.min25GeVHitTime()<minHighEHitTime_) return false;
  if(summary.max25GeVHitTime()>maxHighEHitTime_) return false;
  if(summary.minRBXEMF()<maxRBXEMF_) return false;
  if(summary.numIsolatedNoiseChannels()>=minNumIsolatedNoiseChannels_) return false;
  if(summary.isolatedNoiseSumE()>=minIsolatedNoiseSumE_) return false;
  if(summary.isolatedNoiseSumEt()>=minIsolatedNoiseSumEt_) return false;
  // Only use TS4TS5 test if jet is not in low BV region
  if(useTS4TS5_ == true && summary.HasBadRBXTS4TS5() == true && goodJetFoundInLowBVRegion==false) return false;

  return true;
}

//define this as a plug-in
DEFINE_FWK_MODULE(HBHENoiseFilter);