BaseCkfTrajectoryBuilder.h

Go to the documentation of this file.

#ifndef RecoTracker_CkfPattern_BaseCkfTrajectoryBuilder_h
#define RecoTracker_CkfPattern_BaseCkfTrajectoryBuilder_h

#include "TrackingTools/PatternTools/interface/TrajectoryMeasurement.h"
#include "TrackingTools/PatternTools/interface/TrajectoryBuilder.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/Utilities/interface/ESGetToken.h"
#include "DataFormats/TrajectorySeed/interface/TrajectorySeed.h"

#include <cassert>
#include "TrackingTools/PatternTools/interface/TempTrajectory.h"

class CkfDebugger;
class Chi2MeasurementEstimatorBase;
class DetGroup;
class FreeTrajectoryState;
class IntermediateTrajectoryCleaner;
class LayerMeasurements;
class MeasurementTracker;
class MeasurementTrackerEvent;
class MeasurementEstimator;
class NavigationSchool;
class Propagator;
class TrajectoryStateUpdator;
class TrajectoryMeasurement;
class TrajectoryContainer;
class TrajectoryStateOnSurface;
class TrajectoryFitter;
class TransientRecHitRecord;
class TransientTrackingRecHitBuilder;
class Trajectory;
class TempTrajectory;
class TrajectoryFilter;
class TrackingRegion;
class TrajectoryMeasurementGroup;
class TrajectoryCleaner;
class TrackingComponentsRecord;
namespace edm {
  class ConsumesCollector;
}

#include "TrackingTools/PatternTools/interface/bqueue.h"
#include "RecoTracker/CkfPattern/interface/PrintoutHelper.h"

#include <string>

class BaseCkfTrajectoryBuilder : public TrajectoryBuilder {
protected:
  // short names
  typedef FreeTrajectoryState FTS;
  typedef TrajectoryStateOnSurface TSOS;
  typedef TrajectoryMeasurement TM;
  typedef std::pair<TSOS, std::vector<const DetLayer*> > StateAndLayers;

public:
  typedef std::vector<Trajectory> TrajectoryContainer;
  typedef std::vector<TempTrajectory> TempTrajectoryContainer;
  typedef TrajectoryContainer::iterator TrajectoryIterator;

  // Claims ownership of TrajectoryFilter pointers
  BaseCkfTrajectoryBuilder(const edm::ParameterSet& conf,
                           edm::ConsumesCollector iC,
                           std::unique_ptr<TrajectoryFilter> filter,
                           std::unique_ptr<TrajectoryFilter> inOutFilter = nullptr);
  BaseCkfTrajectoryBuilder(const BaseCkfTrajectoryBuilder&) = delete;
  BaseCkfTrajectoryBuilder& operator=(const BaseCkfTrajectoryBuilder&) = delete;
  ~BaseCkfTrajectoryBuilder() override;

  static void fillPSetDescription(edm::ParameterSetDescription& iDesc);

  // new interface returning the start Trajectory...
  virtual TempTrajectory buildTrajectories(const TrajectorySeed& seed,
                                           TrajectoryContainer& ret,
                                           unsigned int& nCandPerSeed,
                                           const TrajectoryFilter*) const {
    assert(0 == 1);
    return TempTrajectory();
  }

  virtual void rebuildTrajectories(TempTrajectory const& startingTraj,
                                   const TrajectorySeed& seed,
                                   TrajectoryContainer& result) const {
    assert(0 == 1);
  }

  void setNavigationSchool(NavigationSchool const* nv) { theNavigationSchool = nv; }

  void setEvent(const edm::Event& event) const override;
  void unset() const override;

  void setEvent(const edm::Event& iEvent, const edm::EventSetup& iSetup, const MeasurementTrackerEvent* data);

  virtual void setDebugger(CkfDebugger* dbg) const { ; }

  //  int       maxLostHit()        {return theMaxLostHit;}

  //  int       maxConsecLostHit()  {return theMaxConsecLostHit;}

  const TransientTrackingRecHitBuilder* hitBuilder() const { return theTTRHBuilder; }

protected:
  static std::unique_ptr<TrajectoryFilter> createTrajectoryFilter(const edm::ParameterSet& pset,
                                                                  edm::ConsumesCollector& iC);

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

  //methods for dubugging
  virtual bool analyzeMeasurementsDebugger(Trajectory& traj,
                                           const std::vector<TrajectoryMeasurement>& meas,
                                           const MeasurementTrackerEvent* theMeasurementTracker,
                                           const Propagator* theForwardPropagator,
                                           const Chi2MeasurementEstimatorBase* theEstimator,
                                           const TransientTrackingRecHitBuilder* theTTRHBuilder) const {
    return true;
  }
  virtual bool analyzeMeasurementsDebugger(TempTrajectory& traj,
                                           const std::vector<TrajectoryMeasurement>& meas,
                                           const MeasurementTrackerEvent* theMeasurementTracker,
                                           const Propagator* theForwardPropagator,
                                           const Chi2MeasurementEstimatorBase* theEstimator,
                                           const TransientTrackingRecHitBuilder* theTTRHBuilder) const {
    return true;
  }
  virtual void fillSeedHistoDebugger(std::vector<TrajectoryMeasurement>::iterator begin,
                                     std::vector<TrajectoryMeasurement>::iterator end) const {
    ;
  }

protected:
  TempTrajectory createStartingTrajectory(const TrajectorySeed& seed) const;

  // If inOut is true, this is being called part-way through tracking, after the in-out tracking phase is complete.
  // If inOut is false, it is called at the end of tracking.
  bool toBeContinued(TempTrajectory& traj, bool inOut = false) const;

  bool qualityFilter(const TempTrajectory& traj, bool inOut = false) const;

  void addToResult(std::shared_ptr<const TrajectorySeed> const& seed,
                   TempTrajectory& traj,
                   TrajectoryContainer& result,
                   bool inOut = false) const;
  void addToResult(TempTrajectory const& traj, TempTrajectoryContainer& result, bool inOut = false) const;
  void moveToResult(TempTrajectory&& traj, TempTrajectoryContainer& result, bool inOut = false) const;

  StateAndLayers findStateAndLayers(const TrajectorySeed& seed, const TempTrajectory& traj) const;

private:
  void seedMeasurements(const TrajectorySeed& seed, TempTrajectory& result, bool as5D) const;

protected:
  void setData(const MeasurementTrackerEvent* data);

  const Propagator* forwardPropagator(const TrajectorySeed& seed) const {
    return seed.direction() == alongMomentum ? thePropagatorAlong : thePropagatorOpposite;
  }
  const Propagator* backwardPropagator(const TrajectorySeed& seed) const {
    return seed.direction() == alongMomentum ? thePropagatorOpposite : thePropagatorAlong;
  }

protected:
  typedef TrackingComponentsRecord Chi2MeasurementEstimatorRecord;

  const TrajectoryStateUpdator* theUpdator = nullptr;
  const Propagator* thePropagatorAlong = nullptr;
  const Propagator* thePropagatorOpposite = nullptr;
  const Chi2MeasurementEstimatorBase* theEstimator = nullptr;
  const TransientTrackingRecHitBuilder* theTTRHBuilder = nullptr;
  const MeasurementTrackerEvent* theMeasurementTracker = nullptr;
  const NavigationSchool* theNavigationSchool = nullptr;

private:
  bool theSeedAs5DHit;

  std::unique_ptr<TrajectoryFilter> theFilter;      
  std::unique_ptr<TrajectoryFilter> theInOutFilter; 
  // for EventSetup
  const edm::ESGetToken<TrajectoryStateUpdator, TrackingComponentsRecord> theUpdatorToken;
  const edm::ESGetToken<Propagator, TrackingComponentsRecord> thePropagatorAlongToken;
  const edm::ESGetToken<Propagator, TrackingComponentsRecord> thePropagatorOppositeToken;
  const edm::ESGetToken<Chi2MeasurementEstimatorBase, TrackingComponentsRecord> theEstimatorToken;
  const edm::ESGetToken<TransientTrackingRecHitBuilder, TransientRecHitRecord> theRecHitBuilderToken;
};

#endif