DTCombinatorialPatternReco.h

Go to the documentation of this file.

#ifndef DTSegment_DTCombinatorialPatternReco_h
#define DTSegment_DTCombinatorialPatternReco_h

/* Base Class Headers */
#include "RecoLocalMuon/DTSegment/src/DTRecSegment2DBaseAlgo.h"
#include "FWCore/Framework/interface/FrameworkfwdMostUsed.h"

/* Collaborating Class Declarations */
namespace edm {
  class ParameterSet;
  class EventSetup;
  //  class ESHandle;
}  // namespace edm
class DTSegmentUpdator;
class DTSegmentCleaner;
class DTHitPairForFit;
class DTSegmentCand;
class MuonGeometryRecord;

/* C++ Headers */
#include <deque>
#include <functional>
#include <unordered_set>
#include <utility>
#include <vector>

#include "Geometry/DTGeometry/interface/DTGeometry.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Utilities/interface/ESGetToken.h"
#include "RecoLocalMuon/DTSegment/src/DTSegmentCand.h"

/* ====================================================================== */

/* Class DTCombinatorialPatternReco Interface */

class DTCombinatorialPatternReco : public DTRecSegment2DBaseAlgo {
public:
  DTCombinatorialPatternReco(const edm::ParameterSet& pset, edm::ConsumesCollector);

  ~DTCombinatorialPatternReco() override;

  /* Operations */

  edm::OwnVector<DTSLRecSegment2D> reconstruct(const DTSuperLayer* sl,
                                               const std::vector<DTRecHit1DPair>& hits) override;

  std::string algoName() const override { return theAlgoName; }

  void setES(const edm::EventSetup& setup) override;

protected:
private:
  friend class DTCombinatorialPatternReco4D;

  // typedef std::pair<DTHitPairForFit*, DTEnums::DTCellSide> AssPoint;

  // create the DTHitPairForFit from the pairs for easy use
  std::vector<std::shared_ptr<DTHitPairForFit>> initHits(const DTSuperLayer* sl,
                                                         const std::vector<DTRecHit1DPair>& hits);

  // search for candidate, starting from pairs of hits in different layers
  std::vector<DTSegmentCand*> buildSegments(const DTSuperLayer* sl,
                                            const std::vector<std::shared_ptr<DTHitPairForFit>>& hits);

  // find all the hits compatible with the candidate
  std::vector<DTSegmentCand::AssPoint> findCompatibleHits(const LocalPoint& pos,
                                                          const LocalVector& dir,
                                                          const std::vector<std::shared_ptr<DTHitPairForFit>>& hits);

  // build segments from hits collection
  DTSegmentCand* buildBestSegment(std::vector<DTSegmentCand::AssPoint>& assHits, const DTSuperLayer* sl);

  bool checkDoubleCandidates(std::vector<DTSegmentCand*>& segs, DTSegmentCand* seg);

  void buildPointsCollection(std::vector<DTSegmentCand::AssPoint>& points,
                             std::deque<std::shared_ptr<DTHitPairForFit>>& pointsNoLR,
                             std::vector<DTSegmentCand*>& candidates,
                             const DTSuperLayer* sl);

private:
  std::string theAlgoName;
  unsigned int theMaxAllowedHits;
  double theAlphaMaxTheta;
  double theAlphaMaxPhi;
  bool debug;
  bool usePairs;
  DTSegmentUpdator* theUpdator;  // the updator and fitter
  DTSegmentCleaner* theCleaner;  // the cleaner

  edm::ESHandle<DTGeometry> theDTGeometry;  // the DT geometry
  const edm::ESGetToken<DTGeometry, MuonGeometryRecord> theDTGeometryToken;

public:
  // The type must be public, as otherwise the global 'hash_value' function can't locate it
  class TriedPattern {
  public:
    typedef std::vector<short unsigned int> values;

    // empty costructor
    TriedPattern() : hash_(1) { values_.reserve(8); }

    // equality operator
    bool operator==(const TriedPattern& other) const {
      return (hash_ == other.hash_) &&    // cheap
             (values_ == other.values_);  // expensive last resort
    }

    //Same implementation as boost::hash_combine
    template <class T>
    inline void hash_combine(std::size_t& seed, const T& v) {
      std::hash<T> hasher;
      seed ^= hasher(v) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
    }

    void push_back(short unsigned int i) {
      hash_combine(hash_, i);
      values_.push_back(i);
    }
    size_t hash() const { return hash_; }

    // some extra methods to look like a std::vector
    typedef values::const_iterator const_iterator;
    const_iterator begin() const { return values_.begin(); }
    const_iterator end() const { return values_.end(); }
    values::size_type size() const { return values_.size(); }

    //Custom hash functor for std::unordered_set
    class HashFunction {
    public:
      size_t operator()(const TriedPattern& p) const { return p.hash(); }
    };

  private:
    values values_;
    size_t hash_;
  };
  typedef std::unordered_set<TriedPattern, TriedPattern::HashFunction> TriedPatterns;

private:
  TriedPatterns theTriedPattern;
};

inline std::size_t hash_value(const DTCombinatorialPatternReco::TriedPattern& t) { return t.hash(); }

#endif  // DTSegment_DTCombinatorialPatternReco_h