CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Attributes
GsfPropagatorAdapter Class Referencefinal

#include <GsfPropagatorAdapter.h>

Inheritance diagram for GsfPropagatorAdapter:
Propagator

Public Member Functions

GsfPropagatorAdapterclone () const override
 
 GsfPropagatorAdapter (const Propagator &Propagator)
 Constructor with explicit propagator. More...
 
const MagneticFieldmagneticField () const override
 
std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const TrajectoryStateOnSurface &, const Plane &) const override
 
std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const TrajectoryStateOnSurface &, const Cylinder &) const override
 
std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const FreeTrajectoryState &, const Plane &) const override
 
std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const FreeTrajectoryState &, const Cylinder &) const override
 
const Propagatorpropagator () const
 access to single state propagator More...
 
bool setMaxDirectionChange (float phiMax) override
 
void setPropagationDirection (PropagationDirection dir) override
 
 ~GsfPropagatorAdapter () override
 
- Public Member Functions inherited from Propagator
template<typename STA , typename SUR >
TrajectoryStateOnSurface propagate (STA const &state, SUR const &surface) const
 
virtual FreeTrajectoryState propagate (const FreeTrajectoryState &ftsStart, const GlobalPoint &pDest) const final
 
virtual FreeTrajectoryState propagate (const FreeTrajectoryState &ftsStart, const GlobalPoint &pDest1, const GlobalPoint &pDest2) const final
 
virtual FreeTrajectoryState propagate (const FreeTrajectoryState &ftsStart, const reco::BeamSpot &beamSpot) const final
 
virtual std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const FreeTrajectoryState &, const Surface &) const final
 
virtual std::pair
< TrajectoryStateOnSurface,
double > 
propagateWithPath (const TrajectoryStateOnSurface &tsos, const Surface &sur) const final
 
virtual std::pair
< FreeTrajectoryState, double > 
propagateWithPath (const FreeTrajectoryState &ftsStart, const GlobalPoint &pDest) const
 
virtual std::pair
< FreeTrajectoryState, double > 
propagateWithPath (const FreeTrajectoryState &ftsStart, const GlobalPoint &pDest1, const GlobalPoint &pDest2) const
 Propagate to PCA to a line (given by 2 points) given a starting point. More...
 
virtual std::pair
< FreeTrajectoryState, double > 
propagateWithPath (const FreeTrajectoryState &ftsStart, const reco::BeamSpot &beamSpot) const
 Propagate to PCA to a line (given by beamSpot position and slope) given a starting point. More...
 
virtual PropagationDirection propagationDirection () const final
 
 Propagator (PropagationDirection dir=alongMomentum)
 
virtual ~Propagator ()
 

Private Attributes

DeepCopyPointerByClone
< Propagator
thePropagator
 

Detailed Description

Propagation of multiple trajectory state by propagation of components, using an specified single-state propagator.

Definition at line 14 of file GsfPropagatorAdapter.h.

Constructor & Destructor Documentation

GsfPropagatorAdapter::GsfPropagatorAdapter ( const Propagator Propagator)

Constructor with explicit propagator.

Definition at line 8 of file GsfPropagatorAdapter.cc.

Referenced by clone().

9  : Propagator(aPropagator.propagationDirection()), thePropagator(aPropagator.clone()) {}
Propagator(PropagationDirection dir=alongMomentum)
Definition: Propagator.h:46
DeepCopyPointerByClone< Propagator > thePropagator
GsfPropagatorAdapter::~GsfPropagatorAdapter ( )
inlineoverride

Definition at line 19 of file GsfPropagatorAdapter.h.

19 {}

Member Function Documentation

GsfPropagatorAdapter* GsfPropagatorAdapter::clone ( void  ) const
inlineoverridevirtual

Implements Propagator.

Definition at line 52 of file GsfPropagatorAdapter.h.

References GsfPropagatorAdapter(), and thePropagator.

52 { return new GsfPropagatorAdapter(*thePropagator); }
GsfPropagatorAdapter(const Propagator &Propagator)
Constructor with explicit propagator.
DeepCopyPointerByClone< Propagator > thePropagator
const MagneticField* GsfPropagatorAdapter::magneticField ( ) const
inlineoverridevirtual

Implements Propagator.

Definition at line 54 of file GsfPropagatorAdapter.h.

References Propagator::magneticField(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::magneticField().

54 { return thePropagator->magneticField(); }
DeepCopyPointerByClone< Propagator > thePropagator
virtual const MagneticField * magneticField() const =0
std::pair< TrajectoryStateOnSurface, double > GsfPropagatorAdapter::propagateWithPath ( const TrajectoryStateOnSurface tsos,
const Plane plane 
) const
overridevirtual

Reimplemented from Propagator.

Definition at line 11 of file GsfPropagatorAdapter.cc.

References MultiStatePropagation< T >::propagateWithPath(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::propagateWithPath().

12  {
14  return multiPropagator.propagateWithPath(tsos, plane);
15 }
DeepCopyPointerByClone< Propagator > thePropagator
std::pair< TrajectoryStateOnSurface, double > GsfPropagatorAdapter::propagateWithPath ( const TrajectoryStateOnSurface tsos,
const Cylinder cylinder 
) const
overridevirtual

Propagation to cylinder with path length calculation.

Reimplemented from Propagator.

Definition at line 17 of file GsfPropagatorAdapter.cc.

References MultiStatePropagation< T >::propagateWithPath(), and thePropagator.

18  {
20  return multiPropagator.propagateWithPath(tsos, cylinder);
21 }
DeepCopyPointerByClone< Propagator > thePropagator
std::pair< TrajectoryStateOnSurface, double > GsfPropagatorAdapter::propagateWithPath ( const FreeTrajectoryState fts,
const Plane plane 
) const
overridevirtual

Propagation to plane with path length calculation. Use from FTS implies single state (better use PropagatorWithMaterial)!

use counter in MessageLogger?

Implements Propagator.

Definition at line 23 of file GsfPropagatorAdapter.cc.

References Propagator::propagateWithPath(), and thePropagator.

24  {
26  static std::atomic<int> nWarn{0};
27  if (nWarn++ < 5)
28  edm::LogInfo("GsfPropagatorAdapter") << "GsfPropagator used from FTS = single state mode!";
29  return thePropagator->propagateWithPath(fts, plane);
30 }
virtual std::pair< TrajectoryStateOnSurface, double > propagateWithPath(const FreeTrajectoryState &, const Surface &) const final
Definition: Propagator.cc:10
DeepCopyPointerByClone< Propagator > thePropagator
Log< level::Info, false > LogInfo
std::pair< TrajectoryStateOnSurface, double > GsfPropagatorAdapter::propagateWithPath ( const FreeTrajectoryState fts,
const Cylinder cylinder 
) const
overridevirtual

Propagation to cylinder with path length calculation. Use from FTS implies single state (better use PropagatorWithMaterial)!

use counter in MessageLogger?

Implements Propagator.

Definition at line 32 of file GsfPropagatorAdapter.cc.

References Propagator::propagateWithPath(), and thePropagator.

33  {
35  static std::atomic<int> nWarn{0};
36  if (nWarn++ < 5)
37  edm::LogInfo("GsfPropagatorAdapter") << "GsfPropagator used from FTS = single state mode!";
38  return thePropagator->propagateWithPath(fts, cylinder);
39 }
virtual std::pair< TrajectoryStateOnSurface, double > propagateWithPath(const FreeTrajectoryState &, const Surface &) const final
Definition: Propagator.cc:10
DeepCopyPointerByClone< Propagator > thePropagator
Log< level::Info, false > LogInfo
const Propagator& GsfPropagatorAdapter::propagator ( ) const
inline

access to single state propagator

Definition at line 50 of file GsfPropagatorAdapter.h.

References thePropagator.

50 { return *thePropagator; }
DeepCopyPointerByClone< Propagator > thePropagator
bool GsfPropagatorAdapter::setMaxDirectionChange ( float  phiMax)
inlineoverridevirtual

Set the maximal change of direction (integrated along the path) for any single propagation. If reaching of the destination surface requires change of direction that exceeds this value the Propagator returns an invalid state. For example, a track may reach a forward plane after many spirals, which may be undesirable for a track reconstructor. Setting this value to pi will force the propagation to fail. The default value is "no limit". The method returnd true if the concrete propagator respects the limit, false otherwise.

Reimplemented from Propagator.

Definition at line 45 of file GsfPropagatorAdapter.h.

References Propagator::setMaxDirectionChange(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::setMaxDirectionChange().

virtual bool setMaxDirectionChange(float phiMax)
Definition: Propagator.h:151
DeepCopyPointerByClone< Propagator > thePropagator
void GsfPropagatorAdapter::setPropagationDirection ( PropagationDirection  dir)
overridevirtual

The propagation direction can now be set for every propagator. There is no more distinction between unidirectional and bidirectional at class level. The value "anyDiriction" for PropagationDirection provides the functionality of the ex-BidirectionalPropagator. The values "alongMomentum" and "oppositeToMomentum" provide the functionality of the ex-UnidirectionalPropagator.

Reimplemented from Propagator.

Definition at line 41 of file GsfPropagatorAdapter.cc.

References Propagator::setPropagationDirection(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::setPropagationDirection().

41  {
44 }
virtual void setPropagationDirection(PropagationDirection dir)
Definition: Propagator.h:130
DeepCopyPointerByClone< Propagator > thePropagator

Member Data Documentation

DeepCopyPointerByClone<Propagator> GsfPropagatorAdapter::thePropagator
private