CandIsoDepositProducer.cc

Go to the documentation of this file.

#include "DataFormats/Common/interface/AssociationVector.h"
#include "DataFormats/Common/interface/Handle.h"
#include "DataFormats/Common/interface/RefToBaseProd.h"
#include "DataFormats/GsfTrackReco/interface/GsfTrack.h"
#include "DataFormats/MuonReco/interface/Muon.h"
#include "DataFormats/RecoCandidate/interface/IsoDeposit.h"
#include "DataFormats/RecoCandidate/interface/IsoDepositDirection.h"
#include "DataFormats/RecoCandidate/interface/IsoDepositFwd.h"
#include "DataFormats/RecoCandidate/interface/RecoCandidate.h"
#include "DataFormats/TrackReco/interface/Track.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/Framework/interface/EDProducer.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "PhysicsTools/IsolationAlgos/interface/IsoDepositExtractor.h"
#include "PhysicsTools/IsolationAlgos/interface/IsoDepositExtractorFactory.h"

#include <string>

class CandIsoDepositProducer : public edm::stream::EDProducer<> {
public:
  CandIsoDepositProducer(const edm::ParameterSet &);

  ~CandIsoDepositProducer() override;

  void produce(edm::Event &, const edm::EventSetup &) override;

private:
  inline const reco::Track *extractTrack(const reco::Candidate &cand, reco::Track *dummyStorage) const;
  enum TrackType { FakeT, BestT, StandAloneMuonT, CombinedMuonT, TrackT, GsfT, CandidateT };
  edm::ParameterSet theConfig;
  edm::EDGetTokenT<edm::View<reco::Candidate> > theCandCollectionToken;
  TrackType theTrackType;
  std::vector<std::string> theDepositNames;
  bool theMultipleDepositsFlag;
  std::unique_ptr<reco::isodeposit::IsoDepositExtractor> theExtractor;
};

using namespace edm;
using namespace reco;

CandIsoDepositProducer::CandIsoDepositProducer(const ParameterSet &par)
    : theConfig(par),
      theCandCollectionToken(consumes<edm::View<reco::Candidate> >(par.getParameter<edm::InputTag>("src"))),
      theDepositNames(std::vector<std::string>(1, "")),
      theMultipleDepositsFlag(par.getParameter<bool>("MultipleDepositsFlag")) {
  LogDebug("PhysicsTools|MuonIsolation") << " CandIsoDepositProducer CTOR";

  edm::ParameterSet extractorPSet = theConfig.getParameter<edm::ParameterSet>("ExtractorPSet");
  std::string extractorName = extractorPSet.getParameter<std::string>("ComponentName");
  theExtractor = IsoDepositExtractorFactory::get()->create(extractorName, extractorPSet, consumesCollector());

  if (!theMultipleDepositsFlag)
    produces<reco::IsoDepositMap>();
  else {
    theDepositNames = extractorPSet.getParameter<std::vector<std::string> >("DepositInstanceLabels");
    if (theDepositNames.size() > 10)
      throw cms::Exception("Configuration Error") << "This module supports only up to 10 deposits";
    for (unsigned int iDep = 0; iDep < theDepositNames.size(); ++iDep) {
      produces<reco::IsoDepositMap>(theDepositNames[iDep]);
    }
  }

  std::string trackType = par.getParameter<std::string>("trackType");
  if (trackType == "fake")
    theTrackType = FakeT;
  else if (trackType == "best")
    theTrackType = BestT;
  else if (trackType == "standAloneMuon")
    theTrackType = StandAloneMuonT;
  else if (trackType == "combinedMuon")
    theTrackType = CombinedMuonT;
  else if (trackType == "trackerMuon")
    theTrackType = TrackT;
  else if (trackType == "track")
    theTrackType = TrackT;
  else if (trackType == "gsf")
    theTrackType = GsfT;
  else if (trackType == "candidate")
    theTrackType = CandidateT;
  else
    throw cms::Exception("Error") << "Track type " << trackType << " not valid.";
}

CandIsoDepositProducer::~CandIsoDepositProducer() {
  LogDebug("PhysicsTools/CandIsoDepositProducer") << " CandIsoDepositProducer DTOR";
}

inline const reco::Track *CandIsoDepositProducer::extractTrack(const reco::Candidate &c, reco::Track *dummy) const {
  if (theTrackType == CandidateT) {
    return nullptr;
  } else if (theTrackType == FakeT) {
    *dummy = Track(10, 10, c.vertex(), c.momentum(), c.charge(), reco::Track::CovarianceMatrix());
    return dummy;
  } else {
    const RecoCandidate *rc = dynamic_cast<const RecoCandidate *>(&c);
    if (rc == nullptr)
      throw cms::Exception("Error") << " Candidate is not RecoCandidate: can't get a real track from it!";
    switch (theTrackType) {
      case FakeT:
        break;  // to avoid warning
      case CandidateT:
        break;  // to avoid warning
      case BestT:
        return rc->bestTrack();
        break;
      case StandAloneMuonT:
        return &*rc->standAloneMuon();
        break;
      case CombinedMuonT:
        return &*rc->combinedMuon();
        break;
      case TrackT:
        return &*rc->track();
        break;
      case GsfT:
        return static_cast<const Track *>(rc->gsfTrack().get());
        break;
    }
    return nullptr;
  }
}

void CandIsoDepositProducer::produce(Event &event, const EventSetup &eventSetup) {
  static const std::string metname = "CandIsoDepositProducer";

  edm::Handle<edm::View<reco::Candidate> > hCands;
  event.getByToken(theCandCollectionToken, hCands);

  unsigned int nDeps = theMultipleDepositsFlag ? theDepositNames.size() : 1;

  static const unsigned int MAX_DEPS = 10;

  if (nDeps > MAX_DEPS)
    LogError(metname) << "Unable to handle more than 10 input deposits";

  size_t nMuons = hCands->size();
  std::vector<std::vector<IsoDeposit> > deps2D(nDeps, std::vector<IsoDeposit>(nMuons));

  if (nMuons > 0) {
    theExtractor->initEvent(event, eventSetup);

    Track dummy;
    for (size_t i = 0; i < nMuons; ++i) {
      const Candidate &c = (*hCands)[i];
      const Track *track = extractTrack(c, &dummy);
      if ((theTrackType != CandidateT) && (!track)) {
        edm::LogWarning("CandIsoDepositProducer")
            << "Candidate #" << i << " has no bestTrack(), it will produce no deposit";
        reco::IsoDeposit emptyDep;
        for (size_t iDep = 0; iDep < nDeps; ++iDep) {
          deps2D[iDep][i] = emptyDep;  
        }
        continue;
      }
      if (!theMultipleDepositsFlag) {
        deps2D[0][i] = ((theTrackType == CandidateT) ? theExtractor->deposit(event, eventSetup, c)
                                                     : theExtractor->deposit(event, eventSetup, *track));
      } else {
        std::vector<IsoDeposit> deps =
            ((theTrackType == CandidateT) ? theExtractor->deposits(event, eventSetup, c)
                                          : theExtractor->deposits(event, eventSetup, *track));
        for (unsigned int iDep = 0; iDep < nDeps; ++iDep) {
          deps2D[iDep][i] = deps[iDep];
        }
      }
    }  
  }    //if (nMuons>0)

  for (unsigned int iDep = 0; iDep < nDeps; ++iDep) {
    for (unsigned int iMu = 0; iMu < nMuons; ++iMu) {
      LogTrace(metname) << "Contents of " << theDepositNames[iDep] << " for a muon at index " << iMu;
      LogTrace(metname) << deps2D[iDep][iMu].print();
    }

    auto depMap = std::make_unique<reco::IsoDepositMap>();
    reco::IsoDepositMap::Filler filler(*depMap);
    filler.insert(hCands, deps2D[iDep].begin(), deps2D[iDep].end());
    deps2D[iDep].clear();
    filler.fill();
    event.put(std::move(depMap), theDepositNames[iDep]);
  }  
}

#include "FWCore/Framework/interface/MakerMacros.h"
DEFINE_FWK_MODULE(CandIsoDepositProducer);