PFAlgo.h

Go to the documentation of this file.

#ifndef RecoParticleFlow_PFProducer_PFAlgo_h
#define RecoParticleFlow_PFProducer_PFAlgo_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"
#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 "DataFormats/Common/interface/ValueMap.h"
#include "RecoParticleFlow/PFProducer/interface/PFCandConnector.h"
#include "RecoParticleFlow/PFProducer/interface/PFMuonAlgo.h"
#include "RecoParticleFlow/PFProducer/interface/PFEGammaFilters.h"

#include <iostream>

#include "RecoParticleFlow/PFClusterTools/interface/PFEnergyCalibration.h"
#include "RecoParticleFlow/PFClusterTools/interface/PFEnergyCalibrationHF.h"


class PFMuonAlgo;

class ElementIndices {
public:
  std::vector<unsigned> hcalIs;
  std::vector<unsigned> hoIs;
  std::vector<unsigned> ecalIs;
  std::vector<unsigned> trackIs;
  std::vector<unsigned> ps1Is;
  std::vector<unsigned> ps2Is;

  std::vector<unsigned> hfEmIs;
  std::vector<unsigned> hfHadIs;
};

class PFAlgo {
public:
  PFAlgo(double nSigmaECAL,
         double nSigmaHCAL,
         double nSigmaHFEM,
         double nSigmaHFHAD,
         std::vector<double> resolHF_square,
         PFEnergyCalibration& calibration,
         PFEnergyCalibrationHF& thepfEnergyCalibrationHF,
         const edm::ParameterSet& pset);

  void setHOTag(bool ho) { useHO_ = ho; }
  void setMuonHandle(const edm::Handle<reco::MuonCollection>&);

  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);
  }

  PFMuonAlgo* getPFMuonAlgo();

  void setEGammaParameters(bool use_EGammaFilters, bool useProtectionsForJetMET);

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

  void setPostHFCleaningParameters(bool postHFCleaning, const edm::ParameterSet& pfHFCleaningParams);

  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, reco::VertexCollection const& primaryVertices);

  // FlorianB : Collection of e/g electrons
  void setEGElectronCollection(const reco::GsfElectronCollection& egelectrons);

  void reconstructParticles(const reco::PFBlockHandle& blockHandle, PFEGammaFilters const* pfegamma);

  void checkCleaning(const reco::PFRecHitCollection& cleanedHF);

  reco::PFCandidateCollection& getCleanedCandidates() { return pfCleanedCandidates_; }

  reco::PFCandidateCollection makeConnectedCandidates() { return connector_.connect(*pfCandidates_); }

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

private:
  void egammaFilters(const reco::PFBlockRef& blockref, std::vector<bool>& active, PFEGammaFilters const* pfegamma);
  void conversionAlgo(const edm::OwnVector<reco::PFBlockElement>& elements, std::vector<bool>& active);
  bool checkAndReconstructSecondaryInteraction(const reco::PFBlockRef& blockref,
                                               const edm::OwnVector<reco::PFBlockElement>& elements,
                                               bool isActive,
                                               int iElement);
  bool checkHasDeadHcal(const std::multimap<double, unsigned>& hcalElems, const std::vector<bool>& deadArea);
  void relinkTrackToHcal(const reco::PFBlock& block,
                         std::multimap<double, unsigned>& ecalElems,
                         std::multimap<double, unsigned>& hcalElems,
                         const std::vector<bool>& active,
                         reco::PFBlock::LinkData& linkData,
                         unsigned int iTrack);
  bool checkGoodTrackDeadHcal(const reco::TrackRef& trackRef, bool hasDeadHcal);
  void elementLoop(const reco::PFBlock& block,
                   reco::PFBlock::LinkData& linkData,
                   const edm::OwnVector<reco::PFBlockElement>& elements,
                   std::vector<bool>& active,
                   const reco::PFBlockRef& blockref,
                   ElementIndices& inds,
                   std::vector<bool>& deadArea);
  int decideType(const edm::OwnVector<reco::PFBlockElement>& elements,
                 const reco::PFBlockElement::Type type,
                 std::vector<bool>& active,
                 ElementIndices& inds,
                 std::vector<bool>& deadArea,
                 unsigned int iEle);
  bool recoTracksNotHCAL(const reco::PFBlock& block,
                         reco::PFBlock::LinkData& linkData,
                         const edm::OwnVector<reco::PFBlockElement>& elements,
                         const reco::PFBlockRef& blockref,
                         std::vector<bool>& active,
                         bool goodTrackDeadHcal,
                         bool hasDeadHcal,
                         unsigned int iTrack,
                         std::multimap<double, unsigned>& ecalElems,
                         reco::TrackRef& trackRef);

  //Looks for a HF-associated element in the block and produces a PFCandidate from it with HF_EM and/or HF_HAD calibrations
  void createCandidatesHF(const reco::PFBlock& block,
                          reco::PFBlock::LinkData& linkData,
                          const edm::OwnVector<reco::PFBlockElement>& elements,
                          std::vector<bool>& active,
                          const reco::PFBlockRef& blockref,
                          ElementIndices& inds);

  void createCandidatesHCAL(const reco::PFBlock& block,
                            reco::PFBlock::LinkData& linkData,
                            const edm::OwnVector<reco::PFBlockElement>& elements,
                            std::vector<bool>& active,
                            const reco::PFBlockRef& blockref,
                            ElementIndices& inds,
                            std::vector<bool>& deadArea);
  void createCandidatesHCALUnlinked(const reco::PFBlock& block,
                                    reco::PFBlock::LinkData& linkData,
                                    const edm::OwnVector<reco::PFBlockElement>& elements,
                                    std::vector<bool>& active,
                                    const reco::PFBlockRef& blockref,
                                    ElementIndices& inds,
                                    std::vector<bool>& deadArea);

  void createCandidatesECAL(const reco::PFBlock& block,
                            reco::PFBlock::LinkData& linkData,
                            const edm::OwnVector<reco::PFBlockElement>& elements,
                            std::vector<bool>& active,
                            const reco::PFBlockRef& blockref,
                            ElementIndices& inds,
                            std::vector<bool>& deadArea);

  void processBlock(const reco::PFBlockRef& blockref,
                    std::list<reco::PFBlockRef>& hcalBlockRefs,
                    std::list<reco::PFBlockRef>& ecalBlockRefs,
                    PFEGammaFilters const* pfegamma);

  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 neutralHadronEnergyResolution(double clusterEnergy, double clusterEta) const;

  double nSigmaHCAL(double clusterEnergy, double clusterEta) const;

  double hfEnergyResolution(double clusterEnergy) const;

  double nSigmaHFEM(double clusterEnergy) const;
  double nSigmaHFHAD(double clusterEnergy) const;

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

  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();

  const double nSigmaECAL_;

  const double nSigmaHCAL_;

  const double nSigmaHFEM_;
  const double nSigmaHFHAD_;

  // HF resolution
  const std::vector<double> resolHF_square_;

  PFEnergyCalibration& calibration_;
  PFEnergyCalibrationHF& thepfEnergyCalibrationHF_;

  bool useHO_;

  std::unique_ptr<PFMuonAlgo> pfmu_;

  bool useEGammaFilters_;
  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_ = false;

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

  // Named constants
  const double nSigmaEConstHCAL = 100.;
  const double nSigmaEConstHFEM = 100.;
  const double nSigmaEConstHFHAD = 100.;
};

#endif