TempTrajectory.h

Go to the documentation of this file.

#ifndef CkfPattern_TempTrajectory_H
#define CkfPattern_TempTrajectory_H

#include "TrackingTools/PatternTools/interface/TrajectoryMeasurement.h"
#include "DataFormats/TrackCandidate/interface/TrajectoryStopReasons.h"
#include "DataFormats/TrajectorySeed/interface/PropagationDirection.h"
#include "DataFormats/TrackingRecHit/interface/TrackingRecHit.h"
#include "DataFormats/Common/interface/OwnVector.h"
#include "FWCore/Utilities/interface/Visibility.h"

#include <vector>
#include <algorithm>
#include <limits>
#include "TrackingTools/PatternTools/interface/bqueue.h"

#include "TrackingTools/PatternTools/interface/Trajectory.h"

class TempTrajectory {
public:
  typedef cmsutils::bqueue<TrajectoryMeasurement> DataContainer;
  typedef TrackingRecHit::ConstRecHitContainer ConstRecHitContainer;
  typedef ConstRecHitContainer RecHitContainer;

  struct Payload {
    float theChiSquared = 0;
    float theDPhiCache = 0;
    float theCCCThreshold_ = std::numeric_limits<float>::max();

    uint8_t theNumberOfFoundHits = 0;
    uint8_t theNumberOfFoundPixelHits = 0;
    uint8_t theNumberOfLostHits = 0;
    uint8_t theNumberOfTrailingFoundHits = 0;
    uint8_t theNumberOfCCCBadHits_ = 0;

    // PropagationDirection
    int8_t theDirection = anyDirection;

    uint8_t theNHseed = 0;
    uint8_t theNLoops = 0;
    StopReason stopReason_ = StopReason::UNINITIALIZED;
  };

  TempTrajectory() {}

  TempTrajectory(PropagationDirection dir, unsigned char nhseed) : thePayload(std::make_unique<Payload>()) {
    thePayload->theDirection = dir;
    thePayload->theNHseed = nhseed;
  }

  TempTrajectory(TempTrajectory const& rh)
      : theData(rh.theData), thePayload(rh.thePayload ? std::make_unique<Payload>(*rh.thePayload) : nullptr) {}

  TempTrajectory& operator=(TempTrajectory const& rh) {
    theData = rh.theData;
    thePayload = rh.thePayload ? std::make_unique<Payload>(*rh.thePayload) : nullptr;
    return *this;
  }

  TempTrajectory(TempTrajectory&& rh) noexcept : theData(std::move(rh.theData)), thePayload(std::move(rh.thePayload)) {}

  TempTrajectory& operator=(TempTrajectory&& rh) noexcept {
    using std::swap;
    swap(theData, rh.theData);
    swap(thePayload, rh.thePayload);
    return *this;
  }

  void swap(TempTrajectory& rh) noexcept {
    using std::swap;
    swap(theData, rh.theData);
    swap(thePayload, rh.thePayload);
  }

  explicit TempTrajectory(Trajectory&& traj);

  ~TempTrajectory() = default;

  void push(const TrajectoryMeasurement& tm) { push(tm, tm.estimate()); }

  void push(TrajectoryMeasurement&& tm) { push(std::forward<TrajectoryMeasurement>(tm), tm.estimate()); }

  template <typename... Args>
  void emplace(Args&&... args) {
    theData.emplace_back(std::forward<Args>(args)...);
    pushAux(theData.back().estimate());
  }

  void push(TempTrajectory const& segment);

  void join(TempTrajectory& segment);

  void push(const TrajectoryMeasurement& tm, double chi2Increment) {
    theData.push_back(tm);
    pushAux(chi2Increment);
  }

  void push(TrajectoryMeasurement&& tm, double chi2Increment) {
    theData.push_back(std::move(tm));
    pushAux(chi2Increment);
  }

  template <typename... Args>
  void emplace(double chi2Increment, Args&&... args) {  // works only because the first Arg is never a double!
    theData.emplace_back(std::forward<Args>(args)...);
    pushAux(chi2Increment);
  }

  void pop();

  const TrajectoryMeasurement& lastMeasurement() const {
    check();
    return theData.back();
  }

  const TrajectoryMeasurement& firstMeasurement() const {
    check();
    return theData.front();
  }

  const DataContainer& measurements() const { return theData; }

  int foundHits() const { return thePayload->theNumberOfFoundHits; }

  int foundPixelHits() const { return thePayload->theNumberOfFoundPixelHits; }

  int lostHits() const { return thePayload->theNumberOfLostHits; }

  int trailingFoundHits() const { return thePayload->theNumberOfTrailingFoundHits; }

  int cccBadHits() const { return thePayload->theNumberOfCCCBadHits_; }

  //number of hits in seed
  unsigned int seedNHits() const { return thePayload->theNHseed; }

  bool empty() const { return theData.empty(); }

  float chiSquared() const { return thePayload->theChiSquared; }

  PropagationDirection direction() const;

  bool isValid() const { return bool(thePayload); }

  void invalidate() { thePayload.reset(); }

  static bool inactive(  //const Det& det
  ) {
    return false;
  }  //FIXME

  const DetLayer* lastLayer() const {
    check();
    return theData.back().layer();
  }

  Trajectory toTrajectory() const;

  void popInvalidTail();

  float dPhiCacheForLoopersReconstruction() const { return thePayload->theDPhiCache; }

  void setDPhiCacheForLoopersReconstruction(float dphi) { thePayload->theDPhiCache = dphi; }

  bool isLooper() const { return (thePayload->theNLoops > 0); }
  signed char nLoops() const { return thePayload->theNLoops; }

  void setNLoops(int8_t value) { thePayload->theNLoops = value; }
  void incrementLoops() { thePayload->theNLoops++; }

  StopReason stopReason() const { return thePayload->stopReason_; }
  void setStopReason(StopReason s) { thePayload->stopReason_ = s; }

  int numberOfCCCBadHits(float ccc_threshold);

  static bool lost(const TrackingRecHit& hit) dso_internal;

private:
  bool badForCCC(const TrajectoryMeasurement& tm) dso_internal;
  void updateBadForCCC(float ccc_threshold) dso_internal;

  void pushAux(double chi2Increment);

private:
  DataContainer theData;
  std::unique_ptr<Payload> thePayload;

  void check() const;
};

#endif