Propagator.h

Go to the documentation of this file.

#ifndef CommonDet_Propagator_H
#define CommonDet_Propagator_H

#include "DataFormats/TrajectorySeed/interface/PropagationDirection.h"
#include "TrackingTools/TrajectoryState/interface/FreeTrajectoryState.h"
#include <utility>

#include "FWCore/Utilities/interface/GCC11Compatibility.h"

class FreeTrajectoryState;
class TrajectoryStateOnSurface;
class Plane;
class Cylinder;
class Surface;
class MagneticField;

namespace reco{class BeamSpot;}

class Propagator {
public:

  Propagator (PropagationDirection dir = alongMomentum) :
    theDir(dir) {}
  virtual ~Propagator();

  virtual TrajectoryStateOnSurface 
  propagate (const FreeTrajectoryState&, const Surface&) const;

  virtual TrajectoryStateOnSurface 
  propagate (const FreeTrajectoryState&, const Plane&) const = 0;

  virtual TrajectoryStateOnSurface 
  propagate (const FreeTrajectoryState&, const Cylinder&) const = 0;

  virtual TrajectoryStateOnSurface 
  propagate (const TrajectoryStateOnSurface&, const Surface&) const;

  virtual TrajectoryStateOnSurface 
  propagate (const TrajectoryStateOnSurface&, const Plane&) const;

  virtual TrajectoryStateOnSurface 
  propagate (const TrajectoryStateOnSurface&, const Cylinder&) const;
  
  virtual FreeTrajectoryState 
  propagate(const FreeTrajectoryState&, 
        const reco::BeamSpot&) const;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const FreeTrajectoryState&, const Surface&) const;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const FreeTrajectoryState&, const Plane&) const = 0;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const FreeTrajectoryState&, const Cylinder&) const=0;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const TrajectoryStateOnSurface&, const Surface&) const;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const TrajectoryStateOnSurface&, const Plane&) const;

  virtual std::pair< TrajectoryStateOnSurface, double> 
  propagateWithPath (const TrajectoryStateOnSurface&, const Cylinder&) const;

  virtual std::pair<FreeTrajectoryState, double> 
    propagateWithPath(const FreeTrajectoryState&, 
                      const GlobalPoint&, const GlobalPoint&) const;

  virtual void setPropagationDirection(PropagationDirection dir) const {
    theDir = dir;
  }

  virtual PropagationDirection propagationDirection() const GCC11_FINAL {
    return theDir;
  }

  virtual bool setMaxDirectionChange( float phiMax) { return false;}

  virtual Propagator * clone() const = 0;

  virtual const MagneticField* magneticField() const = 0;

private:

  mutable PropagationDirection theDir;
};

class SetPropagationDirection {
private:
  Propagator const & prop;
  PropagationDirection oldDir;
public:
  SetPropagationDirection(Propagator const & iprop, PropagationDirection dir) : 
    prop(iprop),
    oldDir(iprop.propagationDirection()) {
    prop.setPropagationDirection(dir);
  }
  ~SetPropagationDirection() {
    prop.setPropagationDirection(oldDir);
  }
};


#endif // CommonDet_Propagator_H