PFAlgo.h

Go to the documentation of this file.

#ifndef RecoParticleFlow_PFProducer_PFAlgo_h
#define RecoParticleFlow_PFProducer_PFAlgo_h 

#include <iostream>

#include "CondFormats/EgammaObjects/interface/GBRForest.h"
#include "DataFormats/Common/interface/Handle.h"
#include "DataFormats/Common/interface/OrphanHandle.h"

#include "DataFormats/MuonReco/interface/MuonFwd.h"
#include "DataFormats/ParticleFlowReco/interface/PFBlockFwd.h"
#include "DataFormats/ParticleFlowReco/interface/PFBlock.h"

// next include is necessary for inline functions. 
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidate.h"

#include "DataFormats/ParticleFlowCandidate/interface/PFCandidateFwd.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidateElectronExtra.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidateElectronExtraFwd.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidatePhotonExtra.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidatePhotonExtraFwd.h"
#include "DataFormats/ParticleFlowReco/interface/PFBlockElement.h"

#include "DataFormats/ParticleFlowReco/interface/PFRecHitFwd.h"
#include "DataFormats/ParticleFlowReco/interface/PFClusterFwd.h"
#include "DataFormats/ParticleFlowReco/interface/PFRecTrackFwd.h"
#include "DataFormats/TrackReco/interface/TrackFwd.h"
#include "DataFormats/VertexReco/interface/VertexFwd.h"
#include "DataFormats/EgammaCandidates/interface/GsfElectronFwd.h"
#include "RecoParticleFlow/PFProducer/interface/PFCandConnector.h"
#include "RecoParticleFlow/PFProducer/interface/PFMuonAlgo.h"
#include "RecoParticleFlow/PFProducer/interface/PFEGammaFilters.h"
#include "DataFormats/Common/interface/ValueMap.h"


class PFEnergyCalibration;
class PFSCEnergyCalibration;
class PFEnergyCalibrationHF;
class PFElectronAlgo;
class PFPhotonAlgo;
class PFMuonAlgo;

class PFAlgo {

 public:

  PFAlgo();

  ~PFAlgo();

  void setHOTag(bool ho) { useHO_ = ho;}
  void setAlgo( int algo ) {algo_ = algo;}
  void setPFMuonAlgo(PFMuonAlgo* algo) {pfmu_ =algo;}
  void setMuonHandle(const edm::Handle<reco::MuonCollection>&);
  void setDebug( bool debug ) {debug_ = debug; connector_.setDebug(debug_); if (pfegamma_) pfegamma_->setDebug(debug); }

  void setParameters(double nSigmaECAL,
                     double nSigmaHCAL, 
                     const std::shared_ptr<PFEnergyCalibration>& calibration,
             const std::shared_ptr<PFEnergyCalibrationHF>& thepfEnergyCalibrationHF);
  
  void setCandConnectorParameters( const edm::ParameterSet& iCfgCandConnector ){
    connector_.setParameters(iCfgCandConnector);
  }
 
  void setCandConnectorParameters(bool bCorrect, 
                  bool bCalibPrimary, 
                  double dptRel_PrimaryTrack, 
                  double dptRel_MergedTrack, 
                  double ptErrorSecondary, 
                  const std::vector<double>& nuclCalibFactors){
    connector_.setParameters(bCorrect, bCalibPrimary, dptRel_PrimaryTrack, dptRel_MergedTrack, ptErrorSecondary, nuclCalibFactors);
  }


  void setPFMuonAndFakeParameters(const edm::ParameterSet& pset);

  void setBadHcalTrackParams(const edm::ParameterSet& pset);
   
  PFMuonAlgo*  getPFMuonAlgo();
  
  void setPFEleParameters(double mvaEleCut,
              std::string mvaWeightFileEleID,
              bool usePFElectrons,
              const std::shared_ptr<PFSCEnergyCalibration>& thePFSCEnergyCalibration,
              const std::shared_ptr<PFEnergyCalibration>& thePFEnergyCalibration,
              double sumEtEcalIsoForEgammaSC_barrel,
              double sumEtEcalIsoForEgammaSC_endcap,
              double coneEcalIsoForEgammaSC,
              double sumPtTrackIsoForEgammaSC_barrel,
              double sumPtTrackIsoForEgammaSC_endcap,
              unsigned int nTrackIsoForEgammaSC,
              double coneTrackIsoForEgammaSC,
              bool applyCrackCorrections=false,
              bool usePFSCEleCalib=true,
              bool useEGElectrons=false,
              bool useEGammaSupercluster = true);

  void setPFPhotonParameters(bool usePFPhoton,
                 std::string mvaWeightFileConvID,
                 double mvaConvCut,
                 bool useReg,
                 std::string X0_Map,
                 const std::shared_ptr<PFEnergyCalibration>& thePFEnergyCalibration,
                 double sumPtTrackIsoForPhoton,
                 double sumPtTrackIsoSlopeForPhoton);

  void setEGammaParameters(bool use_EGammaFilters,
               std::string ele_iso_path_mvaWeightFile,
               double ele_iso_pt,
               double ele_iso_mva_barrel,
               double ele_iso_mva_endcap,
               double ele_iso_combIso_barrel,
               double ele_iso_combIso_endcap,
               double ele_noniso_mva,
               unsigned int ele_missinghits,
               bool useProtectionsForJetMET,
               const edm::ParameterSet& ele_protectionsForJetMET,
               const edm::ParameterSet& ele_protectionsForBadHcal,
               double ph_MinEt,
               double ph_combIso,
               double ph_HoE,
               double ph_sietaieta_eb,
               double ph_sietaieta_ee,
               const edm::ParameterSet& ph_protectionsForJetMET,
               const edm::ParameterSet& ph_protectionsForBadHcal);

  
  void setEGammaCollections(const edm::View<reco::PFCandidate> & pfEgammaCandidates,
                const edm::ValueMap<reco::GsfElectronRef> & valueMapGedElectrons, 
                const edm::ValueMap<reco::PhotonRef> & valueMapGedPhotons); 
  
  

  // void setPFPhotonRegWeights(
  //             const GBRForest *LCorrForest,
  //             const GBRForest *GCorrForest,
  //             const GBRForest *ResForest
                 
  //             ); 
  void setPFPhotonRegWeights(
                 const GBRForest *LCorrForestEB,
                 const GBRForest *LCorrForestEE,
                 const GBRForest *GCorrForestBarrel,
                 const GBRForest *GCorrForestEndcapHr9,
                 const GBRForest *GCorrForestEndcapLr9,
                 const GBRForest *PFEcalResolution
                 ); 
  void setPostHFCleaningParameters(bool postHFCleaning,
                   double minHFCleaningPt,
                   double minSignificance,
                   double maxSignificance,
                   double minSignificanceReduction,
                   double maxDeltaPhiPt,
                   double minDeltaMet);

  void setDisplacedVerticesParameters(bool rejectTracks_Bad,
                      bool rejectTracks_Step45,
                      bool usePFNuclearInteractions,
                      bool usePFConversions,
                      bool usePFDecays,
                      double dptRel_DispVtx);
  
  //MIKEB : Parameters for the vertices..
  void setPFVertexParameters(bool useVertex,
                 const reco::VertexCollection*  primaryVertices);              
  
  // FlorianB : Collection of e/g electrons
  void setEGElectronCollection(const reco::GsfElectronCollection & egelectrons);

  void reconstructParticles( const reco::PFBlockHandle& blockHandle );

  void reconstructParticles( const reco::PFBlockCollection& blocks );
  
  void checkCleaning( const reco::PFRecHitCollection& cleanedHF );

  // Post Electron Extra Ref
  void setElectronExtraRef(const edm::OrphanHandle<reco::PFCandidateElectronExtraCollection >& extrah); 
       
  // Post Photon Extra Ref
  void setPhotonExtraRef(const edm::OrphanHandle<reco::PFCandidatePhotonExtraCollection >& pf_extrah);  

  const std::unique_ptr<reco::PFCandidateCollection>& pfCandidates() const {
    return pfCandidates_;
  }

  std::unique_ptr<reco::PFCandidateCollection> transferElectronCandidates() {
    return std::move(pfElectronCandidates_);
  }

  // done this way because the pfElectronExtra is needed later in the code to create the Refs and with a unique_ptr, it would be destroyed
  std::unique_ptr<reco::PFCandidateElectronExtraCollection> transferElectronExtra() {
    auto result = std::make_unique<reco::PFCandidateElectronExtraCollection>();
    result->insert(result->end(),pfElectronExtra_.begin(),pfElectronExtra_.end());
    return result;
  }


  // done this way because the pfPhotonExtra is needed later in the code to create the Refs and with a unique_ptr, it would be destroyed
  std::unique_ptr< reco::PFCandidatePhotonExtraCollection> transferPhotonExtra()  {
    auto result = std::make_unique<reco::PFCandidatePhotonExtraCollection>();
    result->insert(result->end(),pfPhotonExtra_.begin(),pfPhotonExtra_.end());
    return result;
  }


  std::unique_ptr<reco::PFCandidateCollection> transferCleanedCandidates() {
    return std::move(pfCleanedCandidates_);
  }
  
  std::unique_ptr< reco::PFCandidateCollection> transferCandidates() {
    return connector_.connect(pfCandidates_);
  }
  
  std::shared_ptr<PFEnergyCalibration> thePFEnergyCalibration() { 
    return calibration_;
  }

  friend std::ostream& operator<<(std::ostream& out, const PFAlgo& algo);
  
 private:

  void processBlock( const reco::PFBlockRef& blockref,
                             std::list<reco::PFBlockRef>& hcalBlockRefs, 
                             std::list<reco::PFBlockRef>& ecalBlockRefs ); 
  
  unsigned reconstructTrack( const reco::PFBlockElement& elt,bool allowLoose= false);


  unsigned reconstructCluster( const reco::PFCluster& cluster,
                               double particleEnergy,
                   bool useDirection = false,
                   double particleX=0.,
                   double particleY=0.,
                   double particleZ=0.);

  void setHcalDepthInfo(reco::PFCandidate & cand, const reco::PFCluster& cluster) const ;

  // double gammaCalibratedEnergy( double clusterEnergy ) const;

  // double neutralHadronCalibratedEnergy( double energyHCAL, 
  //                                    double energyECAL=-1) const;
  

  double neutralHadronEnergyResolution( double clusterEnergy,
                    double clusterEta ) const;

 
  double nSigmaHCAL( double clusterEnergy, 
             double clusterEta ) const;

  std::unique_ptr<reco::PFCandidateCollection>    pfCandidates_;
  std::unique_ptr<reco::PFCandidateCollection>    pfElectronCandidates_;
  std::unique_ptr<reco::PFCandidateCollection>    pfPhotonCandidates_;
  // the post-HF-cleaned candidates
  std::unique_ptr<reco::PFCandidateCollection>    pfCleanedCandidates_;

  reco::PFCandidateElectronExtraCollection    pfElectronExtra_;
  reco::PFCandidatePhotonExtraCollection      pfPhotonExtra_; 

  void associatePSClusters(unsigned iEcal,
               reco::PFBlockElement::Type psElementType,
               const reco::PFBlock& block,
               const edm::OwnVector< reco::PFBlockElement >& elements, 
               const reco::PFBlock::LinkData& linkData, 
               std::vector<bool>& active, 
               std::vector<double>& psEne);

  bool isFromSecInt(const reco::PFBlockElement& eTrack,  std::string order) const;


  // Post HF Cleaning
  void postCleaning();

  reco::PFBlockRef createBlockRef( const reco::PFBlockCollection& blocks, 
                   unsigned bi );
    
  reco::PFBlockHandle    blockHandle_;

  double             nSigmaECAL_;
  
  double             nSigmaHCAL_;
  
  std::shared_ptr<PFEnergyCalibration>  calibration_;
  std::shared_ptr<PFEnergyCalibrationHF>  thepfEnergyCalibrationHF_;
  std::shared_ptr<PFSCEnergyCalibration> thePFSCEnergyCalibration_;

  bool               useHO_;
  int                algo_;
  bool               debug_;

  std::string mvaWeightFileEleID_;
  std::vector<double> setchi2Values_;
  double mvaEleCut_;
  bool usePFElectrons_;
  bool usePFPhotons_;
  bool applyCrackCorrectionsElectrons_;
  bool usePFSCEleCalib_;
  bool useEGElectrons_;
  bool useEGammaSupercluster_;
  double sumEtEcalIsoForEgammaSC_barrel_;
  double sumEtEcalIsoForEgammaSC_endcap_;
  double coneEcalIsoForEgammaSC_;
  double sumPtTrackIsoForEgammaSC_barrel_;
  double sumPtTrackIsoForEgammaSC_endcap_;
  double coneTrackIsoForEgammaSC_;
  unsigned int nTrackIsoForEgammaSC_;
  PFElectronAlgo *pfele_;
  PFPhotonAlgo *pfpho_;
  PFMuonAlgo *pfmu_;


  bool useEGammaFilters_;
  PFEGammaFilters *pfegamma_;
  bool useProtectionsForJetMET_;
  const edm::View<reco::PFCandidate> * pfEgammaCandidates_;
  const edm::ValueMap<reco::GsfElectronRef> * valueMapGedElectrons_;
  const edm::ValueMap<reco::PhotonRef> * valueMapGedPhotons_;  


  // Option to let PF decide the muon momentum
  bool usePFMuonMomAssign_;

  bool rejectTracks_Bad_;
  bool rejectTracks_Step45_;

  bool usePFNuclearInteractions_;
  bool usePFConversions_;
  bool usePFDecays_;

  double dptRel_DispVtx_;
  int nVtx_;

  PFCandConnector connector_;
    
  std::vector<double> muonHCAL_;
  std::vector<double> muonECAL_;
  std::vector<double> muonHO_;
  double nSigmaTRACK_;
  double ptError_;
  std::vector<double> factors45_;

  float goodTrackDeadHcal_ptErrRel_;
  float goodTrackDeadHcal_chi2n_;
  int   goodTrackDeadHcal_layers_;
  float goodTrackDeadHcal_validFr_;
  float goodTrackDeadHcal_dxy_;

  float goodPixelTrackDeadHcal_minEta_;
  float goodPixelTrackDeadHcal_maxPt_;
  float goodPixelTrackDeadHcal_ptErrRel_;
  float goodPixelTrackDeadHcal_chi2n_;
  int   goodPixelTrackDeadHcal_maxLost3Hit_;
  int   goodPixelTrackDeadHcal_maxLost4Hit_;
  float goodPixelTrackDeadHcal_dxy_;
  float goodPixelTrackDeadHcal_dz_;


  // Parameters for post HF cleaning
  bool postHFCleaning_;
  bool postMuonCleaning_;
  double minHFCleaningPt_;
  double minSignificance_;
  double maxSignificance_;
  double minSignificanceReduction_;
  double maxDeltaPhiPt_;
  double minDeltaMet_;
  double useBestMuonTrack_;

  //MIKE -May19th: Add option for the vertices....
  reco::Vertex       primaryVertex_;
  bool               useVertices_; 

  edm::Handle<reco::MuonCollection> muonHandle_;

};


#endif