HitPairEDProducer.cc

Go to the documentation of this file.

#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/Framework/interface/ProducesCollector.h"
#include "FWCore/Utilities/interface/EDGetToken.h"
#include "FWCore/Framework/interface/Event.h"
#include "DataFormats/Common/interface/Handle.h"
#include "FWCore/Utilities/interface/RunningAverage.h"

#include "RecoTracker/TkTrackingRegions/interface/TrackingRegion.h"
#include "DataFormats/Common/interface/OwnVector.h"
#include "TrackingTools/TransientTrackingRecHit/interface/SeedingLayerSetsHits.h"
#include "RecoTracker/TkTrackingRegions/interface/TrackingRegionsSeedingLayerSets.h"
#include "RecoTracker/TkHitPairs/interface/LayerHitMapCache.h"
#include "RecoTracker/TkHitPairs/interface/HitPairGeneratorFromLayerPair.h"
#include "RecoTracker/TkHitPairs/interface/IntermediateHitDoublets.h"
#include "RecoTracker/TkHitPairs/interface/RegionsSeedingHitSets.h"

namespace {
  class ImplBase;
}

class HitPairEDProducer : public edm::stream::EDProducer<> {
public:
  HitPairEDProducer(const edm::ParameterSet& iConfig);
  ~HitPairEDProducer() override = default;

  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

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

private:
  edm::EDGetTokenT<bool> clusterCheckToken_;

  std::unique_ptr<::ImplBase> impl_;
};

namespace {
  class ImplBase {
  public:
    ImplBase(const edm::ParameterSet& iConfig, edm::ConsumesCollector iC);
    virtual ~ImplBase() = default;

    virtual void produces(edm::ProducesCollector) const = 0;

    virtual void produce(const bool clusterCheckOk, edm::Event& iEvent, const edm::EventSetup& iSetup) = 0;

  protected:
    edm::RunningAverage localRA_;
    const unsigned int maxElement_;
    const unsigned int maxElementTotal_;

    HitPairGeneratorFromLayerPair generator_;
    std::vector<unsigned> layerPairBegins_;
  };
  ImplBase::ImplBase(const edm::ParameterSet& iConfig, edm::ConsumesCollector iC)
      : maxElement_(iConfig.getParameter<unsigned int>("maxElement")),
        maxElementTotal_(iConfig.getParameter<unsigned int>("maxElementTotal")),
        generator_(
            iC, 0, 1, nullptr, maxElement_),  // these indices are dummy, TODO: cleanup HitPairGeneratorFromLayerPair
        layerPairBegins_(iConfig.getParameter<std::vector<unsigned>>("layerPairs")) {
    if (layerPairBegins_.empty())
      throw cms::Exception("Configuration")
          << "HitPairEDProducer requires at least index for layer pairs (layerPairs parameter), none was given";
  }

  template <typename T_SeedingHitSets, typename T_IntermediateHitDoublets, typename T_RegionLayers>
  class Impl : public ImplBase {
  public:
    template <typename... Args>
    Impl(const edm::ParameterSet& iConfig, edm::ConsumesCollector iC, Args&&... args)
        : ImplBase(iConfig, iC), regionsLayers_(&layerPairBegins_, std::forward<Args>(args)..., iC) {}
    ~Impl() override = default;

    void produces(edm::ProducesCollector producesCollector) const override {
      T_SeedingHitSets::produces(producesCollector);
      T_IntermediateHitDoublets::produces(producesCollector);
    }

    void produce(const bool clusterCheckOk, edm::Event& iEvent, const edm::EventSetup& iSetup) override {
      auto regionsLayers = regionsLayers_.beginEvent(iEvent);

      auto seedingHitSetsProducer = T_SeedingHitSets(&localRA_);
      auto intermediateHitDoubletsProducer = T_IntermediateHitDoublets(regionsLayers.seedingLayerSetsHitsPtr());

      if (!clusterCheckOk) {
        seedingHitSetsProducer.putEmpty(iEvent);
        intermediateHitDoubletsProducer.putEmpty(iEvent);
        return;
      }

      seedingHitSetsProducer.reserve(regionsLayers.regionsSize());
      intermediateHitDoubletsProducer.reserve(regionsLayers.regionsSize());

      unsigned int nDoublets = 0;

      for (const auto& regionLayers : regionsLayers) {
        const TrackingRegion& region = regionLayers.region();
        auto hitCachePtr_filler_shs = seedingHitSetsProducer.beginRegion(&region, nullptr);
        auto hitCachePtr_filler_ihd =
            intermediateHitDoubletsProducer.beginRegion(&region, std::get<0>(hitCachePtr_filler_shs));
        auto hitCachePtr = std::get<0>(hitCachePtr_filler_ihd);

        for (SeedingLayerSetsHits::SeedingLayerSet layerSet : regionLayers.layerPairs()) {
          auto doublets = generator_.doublets(region, iEvent, iSetup, layerSet, *hitCachePtr);
          LogTrace("HitPairEDProducer") << " created " << doublets.size() << " doublets for layers "
                                        << layerSet[0].index() << "," << layerSet[1].index();
          if (doublets.empty())
            continue;  // don't bother if no pairs from these layers
          nDoublets += doublets.size();
          if (nDoublets >= maxElementTotal_) {
            edm::LogError("TooManyPairs") << "number of total pairs exceed maximum, no pairs produced";
            auto seedingHitSetsProducerDummy = T_SeedingHitSets(&localRA_);
            auto intermediateHitDoubletsProducerDummy =
                T_IntermediateHitDoublets(regionsLayers.seedingLayerSetsHitsPtr());
            seedingHitSetsProducerDummy.putEmpty(iEvent);
            intermediateHitDoubletsProducerDummy.putEmpty(iEvent);
            return;
          }
          seedingHitSetsProducer.fill(std::get<1>(hitCachePtr_filler_shs), doublets);
          intermediateHitDoubletsProducer.fill(std::get<1>(hitCachePtr_filler_ihd), layerSet, std::move(doublets));
        }
      }

      seedingHitSetsProducer.put(iEvent);
      intermediateHitDoubletsProducer.put(iEvent);
    }

  private:
    T_RegionLayers regionsLayers_;
  };

  class DoNothing {
  public:
    DoNothing(const SeedingLayerSetsHits*) {}
    DoNothing(edm::RunningAverage*) {}

    static void produces(edm::ProducesCollector){};

    void reserve(size_t) {}

    auto beginRegion(const TrackingRegion*, LayerHitMapCache* ptr) { return std::make_tuple(ptr, 0); }

    void fill(int, const HitDoublets&) {}
    void fill(int, const SeedingLayerSetsHits::SeedingLayerSet&, HitDoublets&&) {}

    void put(edm::Event&) {}
    void putEmpty(edm::Event&) {}
  };

  class ImplSeedingHitSets {
  public:
    ImplSeedingHitSets(edm::RunningAverage* localRA)
        : seedingHitSets_(std::make_unique<RegionsSeedingHitSets>()), localRA_(localRA) {}

    static void produces(edm::ProducesCollector producesCollector) {
      producesCollector.produces<RegionsSeedingHitSets>();
    }

    void reserve(size_t regionsSize) { seedingHitSets_->reserve(regionsSize, localRA_->upper()); }

    auto beginRegion(const TrackingRegion* region, LayerHitMapCache*) {
      hitCacheTmp_.clear();
      return std::make_tuple(&hitCacheTmp_, seedingHitSets_->beginRegion(region));
    }

    void fill(RegionsSeedingHitSets::RegionFiller& filler, const HitDoublets& doublets) {
      for (size_t i = 0, size = doublets.size(); i < size; ++i) {
        filler.emplace_back(doublets.hit(i, HitDoublets::inner), doublets.hit(i, HitDoublets::outer));
      }
    }

    void put(edm::Event& iEvent) {
      seedingHitSets_->shrink_to_fit();
      localRA_->update(seedingHitSets_->size());
      putEmpty(iEvent);
    }

    void putEmpty(edm::Event& iEvent) { iEvent.put(std::move(seedingHitSets_)); }

  private:
    std::unique_ptr<RegionsSeedingHitSets> seedingHitSets_;
    edm::RunningAverage* localRA_;
    LayerHitMapCache hitCacheTmp_;  // used if !produceIntermediateHitDoublets
  };

  class ImplIntermediateHitDoublets {
  public:
    ImplIntermediateHitDoublets(const SeedingLayerSetsHits* layers)
        : intermediateHitDoublets_(std::make_unique<IntermediateHitDoublets>(layers)), layers_(layers) {}

    static void produces(edm::ProducesCollector producesCollector) {
      producesCollector.produces<IntermediateHitDoublets>();
    }

    void reserve(size_t regionsSize) { intermediateHitDoublets_->reserve(regionsSize, layers_->size()); }

    auto beginRegion(const TrackingRegion* region, LayerHitMapCache*) {
      auto filler = intermediateHitDoublets_->beginRegion(region);
      return std::make_tuple(&(filler.layerHitMapCache()), filler);
    }

    void fill(IntermediateHitDoublets::RegionFiller& filler,
              const SeedingLayerSetsHits::SeedingLayerSet& layerSet,
              HitDoublets&& doublets) {
      filler.addDoublets(layerSet, std::move(doublets));
    }

    void put(edm::Event& iEvent) {
      intermediateHitDoublets_->shrink_to_fit();
      putEmpty(iEvent);
    }

    void putEmpty(edm::Event& iEvent) { iEvent.put(std::move(intermediateHitDoublets_)); }

  private:
    std::unique_ptr<IntermediateHitDoublets> intermediateHitDoublets_;
    const SeedingLayerSetsHits* layers_;
  };

  // For the usual case that TrackingRegions and seeding layers are read separately
  class RegionsLayersSeparate {
  public:
    class RegionLayers {
    public:
      RegionLayers(const TrackingRegion* region, const std::vector<SeedingLayerSetsHits::SeedingLayerSet>* layerPairs)
          : region_(region), layerPairs_(layerPairs) {}

      const TrackingRegion& region() const { return *region_; }
      const std::vector<SeedingLayerSetsHits::SeedingLayerSet>& layerPairs() const { return *layerPairs_; }

    private:
      const TrackingRegion* region_;
      const std::vector<SeedingLayerSetsHits::SeedingLayerSet>* layerPairs_;
    };

    class EventTmp {
    public:
      class const_iterator {
      public:
        using internal_iterator_type = edm::OwnVector<TrackingRegion>::const_iterator;
        using value_type = RegionLayers;
        using difference_type = internal_iterator_type::difference_type;

        const_iterator(internal_iterator_type iter,
                       const std::vector<SeedingLayerSetsHits::SeedingLayerSet>* layerPairs)
            : iter_(iter), layerPairs_(layerPairs) {}

        value_type operator*() const { return value_type(&(*iter_), layerPairs_); }

        const_iterator& operator++() {
          ++iter_;
          return *this;
        }
        const_iterator operator++(int) {
          const_iterator clone(*this);
          ++(*this);
          return clone;
        }

        bool operator==(const const_iterator& other) const { return iter_ == other.iter_; }
        bool operator!=(const const_iterator& other) const { return !operator==(other); }

      private:
        internal_iterator_type iter_;
        const std::vector<SeedingLayerSetsHits::SeedingLayerSet>* layerPairs_;
      };

      EventTmp(const SeedingLayerSetsHits* seedingLayerSetsHits,
               const edm::OwnVector<TrackingRegion>* regions,
               const std::vector<unsigned>& layerPairBegins)
          : seedingLayerSetsHits_(seedingLayerSetsHits), regions_(regions) {
        // construct the pairs from the sets
        if (seedingLayerSetsHits_->numberOfLayersInSet() > 2) {
          for (const auto& layerSet : *seedingLayerSetsHits_) {
            for (const auto pairBeginIndex : layerPairBegins) {
              if (pairBeginIndex + 1 >= seedingLayerSetsHits->numberOfLayersInSet()) {
                throw cms::Exception("LogicError")
                    << "Layer pair index " << pairBeginIndex
                    << " is out of bounds, input SeedingLayerSetsHits has only "
                    << seedingLayerSetsHits->numberOfLayersInSet()
                    << " layers per set, and the index+1 must be < than the number of layers in set";
              }

              // Take only the requested pair of the set
              SeedingLayerSetsHits::SeedingLayerSet pairCandidate = layerSet.slice(pairBeginIndex, pairBeginIndex + 1);

              // it would be trivial to use 128-bit bitfield for O(1) check
              // if a layer pair has been inserted, but let's test first how
              // a "straightforward" solution works
              auto found = std::find_if(
                  layerPairs.begin(), layerPairs.end(), [&](const SeedingLayerSetsHits::SeedingLayerSet& pair) {
                    return pair[0].index() == pairCandidate[0].index() && pair[1].index() == pairCandidate[1].index();
                  });
              if (found != layerPairs.end())
                continue;

              layerPairs.push_back(pairCandidate);
            }
          }
        } else {
          if (layerPairBegins.size() != 1) {
            throw cms::Exception("LogicError")
                << "With pairs of input layers, it doesn't make sense to specify more than one input layer pair, got "
                << layerPairBegins.size();
          }
          if (layerPairBegins[0] != 0) {
            throw cms::Exception("LogicError")
                << "With pairs of input layers, it doesn't make sense to specify other input layer pair than 0; got "
                << layerPairBegins[0];
          }

          layerPairs.reserve(seedingLayerSetsHits->size());
          for (const auto& set : *seedingLayerSetsHits)
            layerPairs.push_back(set);
        }
      }

      const SeedingLayerSetsHits* seedingLayerSetsHitsPtr() const { return seedingLayerSetsHits_; }

      size_t regionsSize() const { return regions_->size(); }

      const_iterator begin() const { return const_iterator(regions_->begin(), &layerPairs); }
      const_iterator cbegin() const { return begin(); }
      const_iterator end() const { return const_iterator(regions_->end(), &layerPairs); }
      const_iterator cend() const { return end(); }

    private:
      const SeedingLayerSetsHits* seedingLayerSetsHits_;
      const edm::OwnVector<TrackingRegion>* regions_;
      std::vector<SeedingLayerSetsHits::SeedingLayerSet> layerPairs;
    };

    RegionsLayersSeparate(const std::vector<unsigned>* layerPairBegins,
                          const edm::InputTag& seedingLayerTag,
                          const edm::InputTag& regionTag,
                          edm::ConsumesCollector iC)
        : layerPairBegins_(layerPairBegins),
          seedingLayerToken_(iC.consumes<SeedingLayerSetsHits>(seedingLayerTag)),
          regionToken_(iC.consumes<edm::OwnVector<TrackingRegion>>(regionTag)) {}

    EventTmp beginEvent(const edm::Event& iEvent) const {
      edm::Handle<SeedingLayerSetsHits> hlayers;
      iEvent.getByToken(seedingLayerToken_, hlayers);
      const auto* layers = hlayers.product();
      if (layers->numberOfLayersInSet() < 2)
        throw cms::Exception("LogicError")
            << "HitPairEDProducer expects SeedingLayerSetsHits::numberOfLayersInSet() to be >= 2, got "
            << layers->numberOfLayersInSet()
            << ". This is likely caused by a configuration error of this module, or SeedingLayersEDProducer.";
      edm::Handle<edm::OwnVector<TrackingRegion>> hregions;
      iEvent.getByToken(regionToken_, hregions);

      return EventTmp(layers, hregions.product(), *layerPairBegins_);
    }

  private:
    const std::vector<unsigned>* layerPairBegins_;
    edm::EDGetTokenT<SeedingLayerSetsHits> seedingLayerToken_;
    edm::EDGetTokenT<edm::OwnVector<TrackingRegion>> regionToken_;
  };

  // For the case of automated pixel inactive region recovery where
  // TrackingRegions and seeding layers become together
  class RegionsLayersTogether {
  public:
    class EventTmp {
    public:
      using const_iterator = TrackingRegionsSeedingLayerSets::const_iterator;

      explicit EventTmp(const TrackingRegionsSeedingLayerSets* regionsLayers) : regionsLayers_(regionsLayers) {
        if (regionsLayers->seedingLayerSetsHits().numberOfLayersInSet() != 2) {
          throw cms::Exception("LogicError")
              << "With trackingRegionsSeedingLayers input, the seeding layer sets may only contain layer pairs, now "
                 "got sets with "
              << regionsLayers->seedingLayerSetsHits().numberOfLayersInSet() << " layers";
        }
      }

      const SeedingLayerSetsHits* seedingLayerSetsHitsPtr() const { return &(regionsLayers_->seedingLayerSetsHits()); }

      size_t regionsSize() const { return regionsLayers_->regionsSize(); }

      const_iterator begin() const { return regionsLayers_->begin(); }
      const_iterator cbegin() const { return begin(); }
      const_iterator end() const { return regionsLayers_->end(); }
      const_iterator cend() const { return end(); }

    private:
      const TrackingRegionsSeedingLayerSets* regionsLayers_;
    };

    RegionsLayersTogether(const std::vector<unsigned>* layerPairBegins,
                          const edm::InputTag& regionLayerTag,
                          edm::ConsumesCollector iC)
        : regionLayerToken_(iC.consumes<TrackingRegionsSeedingLayerSets>(regionLayerTag)) {
      if (layerPairBegins->size() != 1) {
        throw cms::Exception("LogicError") << "With trackingRegionsSeedingLayers mode, it doesn't make sense to "
                                              "specify more than one input layer pair, got "
                                           << layerPairBegins->size();
      }
      if ((*layerPairBegins)[0] != 0) {
        throw cms::Exception("LogicError") << "With trackingRegionsSeedingLayers mode, it doesn't make sense to "
                                              "specify other input layer pair than 0; got "
                                           << (*layerPairBegins)[0];
      }
    }

    EventTmp beginEvent(const edm::Event& iEvent) const {
      edm::Handle<TrackingRegionsSeedingLayerSets> hregions;
      iEvent.getByToken(regionLayerToken_, hregions);
      return EventTmp(hregions.product());
    }

  private:
    edm::EDGetTokenT<TrackingRegionsSeedingLayerSets> regionLayerToken_;
  };
}  // namespace

HitPairEDProducer::HitPairEDProducer(const edm::ParameterSet& iConfig) {
  auto layersTag = iConfig.getParameter<edm::InputTag>("seedingLayers");
  auto regionTag = iConfig.getParameter<edm::InputTag>("trackingRegions");
  auto regionLayerTag = iConfig.getParameter<edm::InputTag>("trackingRegionsSeedingLayers");
  const bool useRegionLayers = !regionLayerTag.label().empty();
  if (useRegionLayers) {
    if (!regionTag.label().empty()) {
      throw cms::Exception("Configuration")
          << "HitPairEDProducer requires either trackingRegions or trackingRegionsSeedingLayers to be set, now both "
             "are set to non-empty value. Set the unneeded parameter to empty value.";
    }
    if (!layersTag.label().empty()) {
      throw cms::Exception("Configuration")
          << "With non-empty trackingRegionsSeedingLayers, please set also seedingLayers to empty value to reduce "
             "confusion, because the parameter is not used";
    }
  }
  if (regionTag.label().empty() && regionLayerTag.label().empty()) {
    throw cms::Exception("Configuration")
        << "HitPairEDProducer requires either trackingRegions or trackingRegionsSeedingLayers to be set, now both are "
           "set to empty value. Set the needed parameter to a non-empty value.";
  }

  const bool produceSeedingHitSets = iConfig.getParameter<bool>("produceSeedingHitSets");
  const bool produceIntermediateHitDoublets = iConfig.getParameter<bool>("produceIntermediateHitDoublets");

  if (produceSeedingHitSets && produceIntermediateHitDoublets) {
    if (useRegionLayers)
      throw cms::Exception("Configuration")
          << "Mode 'trackingRegionsSeedingLayers' makes sense only with 'produceSeedingHitsSets', now also "
             "'produceIntermediateHitDoublets is active";
    impl_ = std::make_unique<::Impl<::ImplSeedingHitSets, ::ImplIntermediateHitDoublets, ::RegionsLayersSeparate>>(
        iConfig, consumesCollector(), layersTag, regionTag);
  } else if (produceSeedingHitSets) {
    if (useRegionLayers) {
      impl_ = std::make_unique<::Impl<::ImplSeedingHitSets, ::DoNothing, ::RegionsLayersTogether>>(
          iConfig, consumesCollector(), regionLayerTag);
    } else {
      impl_ = std::make_unique<::Impl<::ImplSeedingHitSets, ::DoNothing, ::RegionsLayersSeparate>>(
          iConfig, consumesCollector(), layersTag, regionTag);
    }
  } else if (produceIntermediateHitDoublets) {
    if (useRegionLayers)
      throw cms::Exception("Configuration")
          << "Mode 'trackingRegionsSeedingLayers' makes sense only with 'produceSeedingHitsSets', now "
             "'produceIntermediateHitDoublets is active instead";
    impl_ = std::make_unique<::Impl<::DoNothing, ::ImplIntermediateHitDoublets, ::RegionsLayersSeparate>>(
        iConfig, consumesCollector(), layersTag, regionTag);
  } else
    throw cms::Exception("Configuration")
        << "HitPairEDProducer requires either produceIntermediateHitDoublets or produceSeedingHitSets to be True. If "
           "neither are needed, just remove this module from your sequence/path as it doesn't do anything useful";

  auto clusterCheckTag = iConfig.getParameter<edm::InputTag>("clusterCheck");
  if (!clusterCheckTag.label().empty())
    clusterCheckToken_ = consumes<bool>(clusterCheckTag);

  impl_->produces(producesCollector());
}

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

  desc.add<edm::InputTag>("seedingLayers", edm::InputTag("seedingLayersEDProducer"))
      ->setComment("Set this empty if 'trackingRegionsSeedingLayers' is non-empty");
  desc.add<edm::InputTag>("trackingRegions", edm::InputTag("globalTrackingRegionFromBeamSpot"))
      ->setComment(
          "Input tracking regions when using all layer sets in 'seedingLayers' (conflicts with "
          "'trackingRegionsSeedingLayers', set this empty to use the other)");
  desc.add<edm::InputTag>("trackingRegionsSeedingLayers", edm::InputTag(""))
      ->setComment(
          "Input tracking regions and corresponding layer sets in case of dynamically limiting the seeding layers "
          "(conflicts with 'trackingRegions', set this empty to use the other; if using this set also 'seedingLayers' "
          "to empty)");
  desc.add<edm::InputTag>("clusterCheck", edm::InputTag("trackerClusterCheck"));
  desc.add<bool>("produceSeedingHitSets", false);
  desc.add<bool>("produceIntermediateHitDoublets", false);
  desc.add<unsigned int>("maxElement", 1000000);
  desc.add<unsigned int>("maxElementTotal", 50000000);
  desc.add<std::vector<unsigned>>("layerPairs", std::vector<unsigned>{0})
      ->setComment("Indices to the pairs of consecutive layers, i.e. 0 means (0,1), 1 (1,2) etc.");

  descriptions.add("hitPairEDProducerDefault", desc);
}

void HitPairEDProducer::produce(edm::Event& iEvent, const edm::EventSetup& iSetup) {
  bool clusterCheckOk = true;
  if (!clusterCheckToken_.isUninitialized()) {
    edm::Handle<bool> hclusterCheck;
    iEvent.getByToken(clusterCheckToken_, hclusterCheck);
    clusterCheckOk = *hclusterCheck;
  }

  impl_->produce(clusterCheckOk, iEvent, iSetup);
}

#include "FWCore/PluginManager/interface/ModuleDef.h"
#include "FWCore/Framework/interface/MakerMacros.h"
DEFINE_FWK_MODULE(HitPairEDProducer);