HcalNoiseSummary.h

Go to the documentation of this file.

#ifndef _DATAFORMATS_METRECO_HCALNOISESUMMARY_H__
#define _DATAFORMATS_METRECO_HCALNOISESUMMARY_H__

//
// HcalNoiseSummary.h
//
//    description: Container class for HCAL noise summary information
//
//    author: J.P. Chou, Brown
//

#include "DataFormats/METReco/interface/HcalNoiseHPD.h"
#include "DataFormats/Common/interface/RefVector.h"
#include "DataFormats/Common/interface/Ref.h"
#include "DataFormats/Common/interface/RefProd.h"
#include "DataFormats/JetReco/interface/CaloJetCollection.h"
#include "DataFormats/CaloTowers/interface/CaloTowerCollection.h"

//
// forward declaration
//

namespace reco {
  class HcalNoiseInfoProducer;
}

//
// class definition
//

class HcalNoiseSummary
{
  friend class reco::HcalNoiseInfoProducer; // allows this class to fill the info

 public:
  // constructor
  HcalNoiseSummary();

  // destructor
  virtual ~HcalNoiseSummary();

  // whether or not the event passed the event filter
  // note that these methods are deprecated
  // please see the instructions here: https://twiki.cern.ch/twiki/bin/view/CMS/HcalNoiseInfoLibrary
  bool passLooseNoiseFilter(void) const;
  bool passTightNoiseFilter(void) const;
  bool passHighLevelNoiseFilter(void) const;

  // the status with which the filter failed: this is a bitset
  // 0 is no failure
  int noiseFilterStatus(void) const;

  // noise type: 1=HPD Ionfeedback, 2=HPD Discharge, 3=RBX Noise
  // won't work with non-noise event
  int noiseType(void) const;

  // quantities to calculate EM fraction and charge fraction
  // of the event (|eta|<2.0)
  float eventEMEnergy(void) const;
  float eventHadEnergy(void) const;
  float eventTrackEnergy(void) const;
  float eventEMFraction(void) const;
  float eventChargeFraction(void) const;

  // minimum/maximum/RMS rechit time
  // rechit energy>10 GeV or 25 GeV
  float min10GeVHitTime(void) const;
  float max10GeVHitTime(void) const;
  float rms10GeVHitTime(void) const;
  float min25GeVHitTime(void) const;
  float max25GeVHitTime(void) const;
  float rms25GeVHitTime(void) const;

  // # of hits with E>10 GeV or 25 GeV
  int num10GeVHits(void) const;
  int num25GeVHits(void) const;
  
  // E(2TS), E(10TS), and E(2TS)/E(10TS) for the minimum and maximum E(2TS)/E(10TS) found in an RBX in the event
  // the total energy in the RBX must be > 50 GeV
  float minE2TS(void) const;
  float minE10TS(void) const;
  float minE2Over10TS(void) const;
  float maxE2TS(void) const;
  float maxE10TS(void) const;
  float maxE2Over10TS(void) const;

  // largest number of zeros found in a single RBX in the event
  // total energy in the RBX must be > 10 GeV
  int maxZeros(void) const;

  // largest number of hits in a single HPD/RBX in the event
  // each hit is >= 1.5 GeV
  int maxHPDHits(void) const;
  int maxRBXHits(void) const;

  // largest number of hits in a single HPD when no other hits are present in the RBX
  int maxHPDNoOtherHits(void) const;

  // smallest EMF found in an HPD/RBX in the event
  // the total energy in the HPD/RBX must be >50 GeV
  float minHPDEMF(void) const;
  float minRBXEMF(void) const;

  // number of "problematic" RBXs
  int numProblematicRBXs(void) const;

  int numIsolatedNoiseChannels(void) const;
  float isolatedNoiseSumE(void) const;
  float isolatedNoiseSumEt(void) const;

  int numFlatNoiseChannels(void) const;
  float flatNoiseSumE(void) const;
  float flatNoiseSumEt(void) const;

  int numSpikeNoiseChannels(void) const;
  float spikeNoiseSumE(void) const;
  float spikeNoiseSumEt(void) const;

  int numTriangleNoiseChannels(void) const;
  float triangleNoiseSumE(void) const;
  float triangleNoiseSumEt(void) const;

  int numTS4TS5NoiseChannels(void) const;
  float TS4TS5NoiseSumE(void) const;
  float TS4TS5NoiseSumEt(void) const;

  int numNegativeNoiseChannels(void) const;
  float NegativeNoiseSumE(void) const;
  float NegativeNoiseSumEt(void) const;

  int GetRecHitCount(void) const;
  int GetRecHitCount15(void) const;
  double GetRecHitEnergy(void) const;
  double GetRecHitEnergy15(void) const;

  double GetTotalCalibCharge(void) const;

  bool HasBadRBXTS4TS5(void) const;
  bool HasBadRBXRechitR45Loose(void) const;
  bool HasBadRBXRechitR45Tight(void) const;
  bool goodJetFoundInLowBVRegion(void) const;

  double GetCalibChargeHF(void) const;
  int    GetCalibCountHF(void)  const;

  // Get charge only in TS45
  int GetCalibCountTS45(void) const;  // get number of HBHE calibration channels
  int GetCalibgt15CountTS45(void) const; // get number of HBHE calib channels > 15 fC
  double GetCalibChargeTS45(void) const; // get Calib charge
  double GetCalibgt15ChargeTS45(void) const; // get charge from all channels gt 15 fC

  int GetHitsInNonLaserRegion(void) const; // get number of channels in HBHE regions with no laser
  int GetHitsInLaserRegion(void) const; // get number of channels in HBHE region where laser pulses are seen
  double GetEnergyInNonLaserRegion(void) const; // get energy in region with no laser
  double GetEnergyInLaserRegion(void) const; // get energy in non-laser region
  
  // reference to problematic jets
  edm::RefVector<reco::CaloJetCollection> problematicJets(void) const;

  // reference to calotowers which fail loose, tight, and high-level noise criteria
  edm::RefVector<CaloTowerCollection> looseNoiseTowers(void) const;
  edm::RefVector<CaloTowerCollection> tightNoiseTowers(void) const;
  edm::RefVector<CaloTowerCollection> highLevelNoiseTowers(void) const;

 private:

  // data members corresponding to the values above
  int filterstatus_, noisetype_;
  float emenergy_, hadenergy_, trackenergy_;
  float min10_, max10_, rms10_;
  float min25_, max25_, rms25_;
  int cnthit10_, cnthit25_;
  float mine2ts_, mine10ts_;
  float maxe2ts_, maxe10ts_;
  int maxzeros_;
  int maxhpdhits_, maxhpdhitsnoother_, maxrbxhits_;
  float minhpdemf_, minrbxemf_;
  int nproblemRBXs_;
  int nisolnoise_;
  float isolnoisee_, isolnoiseet_;
  int nflatnoise_;
  float flatnoisee_, flatnoiseet_;
  int nspikenoise_;
  float spikenoisee_, spikenoiseet_;
  int ntrianglenoise_;
  float trianglenoisee_, trianglenoiseet_;
  int nts4ts5noise_;
  float ts4ts5noisee_, ts4ts5noiseet_;
  int nnegativenoise_;
  float negativenoisee_, negativenoiseet_;

  int rechitCount_;
  int rechitCount15_;
  double rechitEnergy_;
  double rechitEnergy15_;
  double calibCharge_;

  bool hasBadRBXTS4TS5_;
  bool hasBadRBXRechitR45Loose_;
  bool hasBadRBXRechitR45Tight_;
  bool goodJetFoundInLowBVRegion_;

  int calibCountTS45_;
  int calibCountgt15TS45_;
  double calibChargeTS45_;
  double calibChargegt15TS45_;

  int calibCountHF_; // calibration channels only in HF; no threshold used for determining HF noise
  double calibChargeHF_;

  int hitsInLaserRegion_;
  int hitsInNonLaserRegion_;
  double energyInLaserRegion_;
  double energyInNonLaserRegion_;

  edm::RefVector<reco::CaloJetCollection> problemjets_;

  edm::RefVector<CaloTowerCollection> loosenoisetwrs_;
  edm::RefVector<CaloTowerCollection> tightnoisetwrs_;
  edm::RefVector<CaloTowerCollection> hlnoisetwrs_;
};

#endif