GlobalTrackingRegionWithVerticesProducer.h

Go to the documentation of this file.

#ifndef RecoTracker_TkTrackingRegions_GlobalTrackingRegionWithVerticesProducer_H
#define RecoTracker_TkTrackingRegions_GlobalTrackingRegionWithVerticesProducer_H

#include "DataFormats/Common/interface/DetSetVectorNew.h"
#include "DataFormats/SiPixelCluster/interface/SiPixelCluster.h"
#include "RecoTracker/TkTrackingRegions/interface/TrackingRegionProducer.h"
#include "RecoTracker/TkTrackingRegions/interface/GlobalTrackingRegion.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "DataFormats/VertexReco/interface/Vertex.h"
#include "DataFormats/VertexReco/interface/VertexFwd.h"
#include "DataFormats/BeamSpot/interface/BeamSpot.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"

class GlobalTrackingRegionWithVerticesProducer : public TrackingRegionProducer {
public:
  GlobalTrackingRegionWithVerticesProducer(const edm::ParameterSet& cfg, edm::ConsumesCollector&& iC) {
    edm::ParameterSet regionPSet = cfg.getParameter<edm::ParameterSet>("RegionPSet");

    thePtMin = regionPSet.getParameter<double>("ptMin");
    theOriginRadius = regionPSet.getParameter<double>("originRadius");
    theNSigmaZ = regionPSet.getParameter<double>("nSigmaZ");
    token_beamSpot = iC.consumes<reco::BeamSpot>(regionPSet.getParameter<edm::InputTag>("beamSpot"));
    thePrecise = regionPSet.getParameter<bool>("precise");
    theUseMS = regionPSet.getParameter<bool>("useMultipleScattering");

    theSigmaZVertex = regionPSet.getParameter<double>("sigmaZVertex");
    theFixedError = regionPSet.getParameter<double>("fixedError");

    theMaxNVertices = regionPSet.getParameter<int>("maxNVertices");

    theUseFoundVertices = regionPSet.getParameter<bool>("useFoundVertices");
    theUseFakeVertices = regionPSet.getParameter<bool>("useFakeVertices");
    theUseFixedError = regionPSet.getParameter<bool>("useFixedError");
    token_vertex = iC.consumes<reco::VertexCollection>(regionPSet.getParameter<edm::InputTag>("VertexCollection"));

    //information for Heavy ion region scaling
    theOriginRScaling = regionPSet.getParameter<bool>("originRScaling4BigEvts");
    thePtMinScaling = regionPSet.getParameter<bool>("ptMinScaling4BigEvts");
    theHalfLengthScaling = regionPSet.getParameter<bool>("halfLengthScaling4BigEvts");
    theAllowEmpty = regionPSet.getParameter<bool>("allowEmpty");
    theMinOriginR = regionPSet.getParameter<double>("minOriginR");
    theMaxPtMin = regionPSet.getParameter<double>("maxPtMin");
    theMinHalfLength = regionPSet.getParameter<double>("minHalfLength");
    theScalingStart = regionPSet.getParameter<double>("scalingStartNPix");
    theScalingEnd = regionPSet.getParameter<double>("scalingEndNPix");
    edm::InputTag pixelClustersForScaling = regionPSet.getParameter<edm::InputTag>("pixelClustersForScaling");
    if (theOriginRScaling || thePtMinScaling || theHalfLengthScaling)
      token_pc = iC.consumes<edmNew::DetSetVector<SiPixelCluster> >(pixelClustersForScaling);

    if (theUseMS) {
      token_msmaker = iC.esConsumes();
    }
  }

  ~GlobalTrackingRegionWithVerticesProducer() override {}

  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
    edm::ParameterSetDescription desc;

    desc.add<bool>("precise", true);
    desc.add<bool>("useMultipleScattering", false);
    desc.add<edm::InputTag>("beamSpot", edm::InputTag("offlineBeamSpot"));
    desc.add<bool>("useFixedError", true);
    desc.add<double>("originRadius", 0.2);
    desc.add<double>("sigmaZVertex", 3.0);
    desc.add<double>("fixedError", 0.2);
    desc.add<edm::InputTag>("VertexCollection", edm::InputTag("firstStepPrimaryVertices"));
    desc.add<double>("ptMin", 0.9);
    desc.add<bool>("useFoundVertices", true);
    desc.add<bool>("useFakeVertices", false);
    desc.add<int>("maxNVertices", -1)->setComment("-1 for all vertices");
    desc.add<double>("nSigmaZ", 4.0);
    desc.add<edm::InputTag>("pixelClustersForScaling", edm::InputTag("siPixelClusters"));
    desc.add<bool>("originRScaling4BigEvts", false);
    desc.add<bool>("ptMinScaling4BigEvts", false);
    desc.add<bool>("halfLengthScaling4BigEvts", false);
    desc.add<bool>("allowEmpty", false);
    desc.add<double>("minOriginR", 0);
    desc.add<double>("maxPtMin", 1000);
    desc.add<double>("minHalfLength", 0);
    desc.add<double>("scalingStartNPix", 0.0);
    desc.add<double>("scalingEndNPix", 1.0);

    // Only for backwards-compatibility
    edm::ParameterSetDescription descRegion;
    descRegion.add<edm::ParameterSetDescription>("RegionPSet", desc);

    descriptions.add("globalTrackingRegionWithVertices", descRegion);
  }

  std::vector<std::unique_ptr<TrackingRegion> > regions(const edm::Event& ev,
                                                        const edm::EventSetup& es) const override {
    std::vector<std::unique_ptr<TrackingRegion> > result;

    GlobalPoint theOrigin;
    edm::Handle<reco::BeamSpot> bsHandle;
    ev.getByToken(token_beamSpot, bsHandle);
    double bsSigmaZ;
    if (bsHandle.isValid()) {
      const reco::BeamSpot& bs = *bsHandle;
      bsSigmaZ = theNSigmaZ * bs.sigmaZ();
      theOrigin = GlobalPoint(bs.x0(), bs.y0(), bs.z0());
    } else {
      throw cms::Exception("Seeding") << "ERROR: input beamSpot is not valid in GlobalTrackingRegionWithVertices";
    }

    const MultipleScatteringParametrisationMaker* msmaker = nullptr;
    if (theUseMS) {
      msmaker = &es.getData(token_msmaker);
    }

    if (theUseFoundVertices) {
      edm::Handle<reco::VertexCollection> vertexCollection;
      ev.getByToken(token_vertex, vertexCollection);

      edm::Handle<edmNew::DetSetVector<SiPixelCluster> > pixelClusterDSV;
      bool doScaling = theOriginRScaling || thePtMinScaling || theHalfLengthScaling;
      if (doScaling)
        ev.getByToken(token_pc, pixelClusterDSV);

      for (reco::VertexCollection::const_iterator iV = vertexCollection->begin(); iV != vertexCollection->end(); iV++) {
        if (!iV->isValid())
          continue;
        if (iV->isFake() && !(theUseFakeVertices && theUseFixedError))
          continue;
        GlobalPoint theOrigin_ = GlobalPoint(iV->x(), iV->y(), iV->z());

        //scaling origin radius, half length, min pt for high-occupancy HI events to keep timing reasonable
        if (doScaling) {
          //Use the unscaled radius unless one of the two conditions below is met
          double scaledOriginRadius = theOriginRadius;
          double scaledHalfLength = theFixedError;
          double scaledPtMin = thePtMin;

          //calculate nPixels (adapted from TkSeedGenerator/src/ClusterChecker.cc)
          double nPix = 0;

          const edmNew::DetSetVector<SiPixelCluster>& input = *pixelClusterDSV;
          nPix = input.dataSize();

          //first condition is for high occupancy, second makes sure we won't divide by zero or a negative number
          if ((nPix > theScalingEnd) || ((theScalingEnd - theScalingStart) <= 0)) {
            if (theOriginRScaling)
              scaledOriginRadius = theMinOriginR;  // sets parameters to minimum value from PSet
            if (theHalfLengthScaling)
              scaledHalfLength = theMinHalfLength;
            if (thePtMinScaling)
              scaledPtMin = theMaxPtMin;
          }
          //second condition - scale radius linearly by Npix in the region from ScalingStart to ScalingEnd
          else if ((nPix <= theScalingEnd) && (nPix > theScalingStart)) {
            float slopeFactor = (nPix - theScalingStart) / (theScalingEnd - theScalingStart);
            if (theOriginRScaling)
              scaledOriginRadius = theOriginRadius - (theOriginRadius - theMinOriginR) * slopeFactor;
            if (theHalfLengthScaling)
              scaledHalfLength = theFixedError - (theFixedError - theMinHalfLength) * slopeFactor;
            if (thePtMinScaling)
              scaledPtMin = thePtMin - (thePtMin - theMaxPtMin) * slopeFactor;
          }
          //if region has 0 size, return 'result' empty, otherwise make a tracking region
          if (scaledOriginRadius != 0 && scaledHalfLength != 0) {
            result.push_back(std::make_unique<GlobalTrackingRegion>(
                scaledPtMin, theOrigin_, scaledOriginRadius, scaledHalfLength, thePrecise, theUseMS, msmaker));
          }
        }  //end of region scaling code, pp behavior below

        else {
          double theOriginHalfLength_ = (theUseFixedError ? theFixedError : (iV->zError()) * theSigmaZVertex);
          result.push_back(std::make_unique<GlobalTrackingRegion>(
              thePtMin, theOrigin_, theOriginRadius, theOriginHalfLength_, thePrecise, theUseMS, msmaker));
          if (theMaxNVertices >= 0 && result.size() >= static_cast<unsigned>(theMaxNVertices))
            break;
        }
      }

      if (result.empty() && !(theOriginRScaling || thePtMinScaling || theHalfLengthScaling || theAllowEmpty)) {
        result.push_back(std::make_unique<GlobalTrackingRegion>(
            thePtMin, theOrigin, theOriginRadius, bsSigmaZ, thePrecise, theUseMS, msmaker));
      }
    } else {
      result.push_back(std::make_unique<GlobalTrackingRegion>(
          thePtMin, theOrigin, theOriginRadius, bsSigmaZ, thePrecise, theUseMS, msmaker));
    }

    return result;
  }

private:
  double thePtMin;
  double theOriginRadius;
  double theNSigmaZ;
  edm::InputTag theBeamSpotTag;

  double theSigmaZVertex;
  double theFixedError;
  int theMaxNVertices;
  bool thePrecise;
  bool theUseMS;

  bool theUseFoundVertices;
  bool theUseFakeVertices;
  bool theUseFixedError;
  edm::EDGetTokenT<reco::VertexCollection> token_vertex;
  edm::EDGetTokenT<reco::BeamSpot> token_beamSpot;
  edm::ESGetToken<MultipleScatteringParametrisationMaker, TrackerMultipleScatteringRecord> token_msmaker;

  //HI-related variables
  bool theOriginRScaling;
  bool thePtMinScaling;
  bool theHalfLengthScaling;
  bool theAllowEmpty;
  double theMinOriginR;
  double theMaxPtMin;
  double theMinHalfLength;
  double theScalingStart;
  double theScalingEnd;
  edm::EDGetTokenT<edmNew::DetSetVector<SiPixelCluster> > token_pc;
};

#endif