#include <GsfPropagatorAdapter.h>

Inheritance diagram for GsfPropagatorAdapter:

Public Member Functions
GsfPropagatorAdapter *	clone () const override

	GsfPropagatorAdapter (const Propagator &Propagator)
	Constructor with explicit propagator. More...

const MagneticField *	magneticField () const override

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

template<typename STA , typename SUR >
TrajectoryStateOnSurface	propagate (STA const &state, SUR const &surface) const

std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Cylinder &) const override

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

std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Plane &) const override

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

virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Surface &) 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...

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

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

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

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

virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Surface &sur) const final

const Propagator &	propagator () 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
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

template<typename STA , typename SUR >
TrajectoryStateOnSurface	propagate (STA const &state, SUR const &surface) const

virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Surface &) 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 std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Surface &sur) const final

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::GsfPropagatorAdapter ( const Propagator & Propagator )

Constructor with explicit propagator.

Definition at line 8 of file GsfPropagatorAdapter.cc.

9 : Propagator(aPropagator.propagationDirection()), thePropagator(aPropagator.clone()) {}

Referenced by clone().

◆ ~GsfPropagatorAdapter()

GsfPropagatorAdapter::~GsfPropagatorAdapter ( )

inlineoverride

Definition at line 19 of file GsfPropagatorAdapter.h.

19 {}

Member Function Documentation

◆ clone()

GsfPropagatorAdapter* GsfPropagatorAdapter::clone ( void ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 52 of file GsfPropagatorAdapter.h.

52 { return new GsfPropagatorAdapter(*thePropagator); }

References GsfPropagatorAdapter(), and thePropagator.

◆ magneticField()

const MagneticField* GsfPropagatorAdapter::magneticField ( ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 54 of file GsfPropagatorAdapter.h.

54 { return thePropagator->magneticField(); }

References Propagator::magneticField(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::magneticField().

◆ propagate() [1/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 109 of file Propagator.h.

                                                                                                                    {
     return propagateWithPath(ftsStart, pDest).first;
   }

◆ propagate() [2/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 112 of file Propagator.h.

                                                                                {
     return propagateWithPath(ftsStart, pDest1, pDest2).first;
   }

◆ propagate() [3/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 117 of file Propagator.h.

                                                                                   {
     return propagateWithPath(ftsStart, beamSpot).first;
   }

◆ propagate() [4/4]

template<typename STA , typename SUR >

TrajectoryStateOnSurface Propagator::propagate	(	typename STA	,
		typename SUR
	)

inline

Definition at line 50 of file Propagator.h.

                                                                                  {
     return propagateWithPath(state, surface).first;
   }

◆ propagateWithPath() [1/13]

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.

                                                                                                                     {
   static std::atomic<int> nWarn{0};
   if (nWarn++ < 5)
     edm::LogInfo("GsfPropagatorAdapter") << "GsfPropagator used from FTS = single state mode!";
   return thePropagator->propagateWithPath(fts, cylinder);
 }

References Propagator::propagateWithPath(), and thePropagator.

◆ propagateWithPath() [2/13]

virtual std::pair<TrajectoryStateOnSurface, double> Propagator::propagateWithPath

◆ propagateWithPath() [3/13]

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.

                                                                                                               {
   static std::atomic<int> nWarn{0};
   if (nWarn++ < 5)
     edm::LogInfo("GsfPropagatorAdapter") << "GsfPropagator used from FTS = single state mode!";
   return thePropagator->propagateWithPath(fts, plane);
 }

References Propagator::propagateWithPath(), and thePropagator.

◆ propagateWithPath() [4/13]

virtual std::pair<TrajectoryStateOnSurface, double> Propagator::propagateWithPath

◆ propagateWithPath() [5/13]

std::pair< TrajectoryStateOnSurface, double > Propagator::propagateWithPath

final

The methods propagateWithPath() are identical to the corresponding methods propagate() in what concerns the resulting TrajectoryStateOnSurface, but they provide in addition the exact path length along the trajectory. Only use the generic method if the surface type (plane or cylinder) is not known at the calling point.

Definition at line 10 of file Propagator.cc.

                                                                                                     {
   // try plane first, most probable case (disk "is a" plane too)
   const Plane* bp = dynamic_cast<const Plane*>(&sur);
   if (bp != nullptr)
     return propagateWithPath(state, *bp);
  
   // if not plane try cylinder
   const Cylinder* bc = dynamic_cast<const Cylinder*>(&sur);
   if (bc != nullptr)
     return propagateWithPath(state, *bc);
  
   // unknown surface - can't do it!
   throw PropagationException("The surface is neither Cylinder nor Plane");
 }

◆ propagateWithPath() [6/13]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath

implemented by Stepping Helix Propagate to PCA to point given a starting point

Definition at line 42 of file Propagator.cc.

                                                                                                {
   throw cms::Exception("Propagator::propagate(FTS,GlobalPoint) not implemented");
   return std::pair<FreeTrajectoryState, double>();
 }

◆ propagateWithPath() [7/13]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath

Propagate to PCA to a line (given by 2 points) given a starting point.

Definition at line 47 of file Propagator.cc.

                                                                                                {
   throw cms::Exception("Propagator::propagate(FTS,GlobalPoint,GlobalPoint) not implemented");
   return std::pair<FreeTrajectoryState, double>();
 }

◆ propagateWithPath() [8/13]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath

Propagate to PCA to a line (given by beamSpot position and slope) given a starting point.

Definition at line 53 of file Propagator.cc.

                                                                                                          {
   throw cms::Exception("Propagator::propagate(FTS,beamSpot) not implemented");
   return std::pair<FreeTrajectoryState, double>();
 }

◆ propagateWithPath() [9/13]

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.

                                                                           {
   MultiStatePropagation<Cylinder> multiPropagator(*thePropagator);
   return multiPropagator.propagateWithPath(tsos, cylinder);
 }

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

◆ propagateWithPath() [10/13]

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.

                                                                     {
   MultiStatePropagation<Plane> multiPropagator(*thePropagator);
   return multiPropagator.propagateWithPath(tsos, plane);
 }

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

Referenced by GsfPropagatorWithMaterial::propagateWithPath().

◆ propagateWithPath() [11/13]

virtual std::pair<TrajectoryStateOnSurface, double> Propagator::propagateWithPath

inline

Definition at line 91 of file Propagator.h.

                                                                                                    {
     return propagateWithPath(*tsos.freeState(), sur);
   }

◆ propagateWithPath() [12/13]

virtual std::pair<TrajectoryStateOnSurface, double> Propagator::propagateWithPath

inline

Definition at line 86 of file Propagator.h.

                                                                                                 {
     return propagateWithPath(*tsos.freeState(), sur);
   }

◆ propagateWithPath() [13/13]

std::pair< TrajectoryStateOnSurface, double > Propagator::propagateWithPath

final

The following three methods are equivalent to the corresponding methods above, but if the starting state is a TrajectoryStateOnSurface, it's better to use it as such rather than use just the FreeTrajectoryState part. It may help some concrete propagators. Only use the generic method if the surface type (plane or cylinder) is not known at the calling point.

Definition at line 26 of file Propagator.cc.

                                                                                                     {
   // try plane first, most probable case (disk "is a" plane too)
   const Plane* bp = dynamic_cast<const Plane*>(&sur);
   if (bp != nullptr)
     return propagateWithPath(state, *bp);
  
   // if not plane try cylinder
   const Cylinder* bc = dynamic_cast<const Cylinder*>(&sur);
   if (bc != nullptr)
     return propagateWithPath(state, *bc);
  
   // unknown surface - can't do it!
   throw PropagationException("The surface is neither Cylinder nor Plane");
 }

◆ propagator()

const Propagator& GsfPropagatorAdapter::propagator ( ) const

inline

access to single state propagator

Definition at line 50 of file GsfPropagatorAdapter.h.

50 { return *thePropagator; }

References thePropagator.

◆ setMaxDirectionChange()

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.

45 { return thePropagator->setMaxDirectionChange(phiMax); }

References AlignmentTrackSelector_cfi::phiMax, Propagator::setMaxDirectionChange(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::setMaxDirectionChange().

◆ setPropagationDirection()

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.

                                                                            {
   thePropagator->setPropagationDirection(dir);
   Propagator::setPropagationDirection(dir);
 }

References DeadROC_duringRun::dir, Propagator::setPropagationDirection(), and thePropagator.

Referenced by GsfPropagatorWithMaterial::setPropagationDirection().

Member Data Documentation

◆ thePropagator

DeepCopyPointerByClone<Propagator> GsfPropagatorAdapter::thePropagator

private

Definition at line 58 of file GsfPropagatorAdapter.h.

Referenced by clone(), magneticField(), propagateWithPath(), propagator(), setMaxDirectionChange(), and setPropagationDirection().

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GsfPropagatorAdapter()

◆ ~GsfPropagatorAdapter()

Member Function Documentation

◆ clone()

◆ magneticField()

◆ propagate() [1/4]

◆ propagate() [2/4]

◆ propagate() [3/4]

◆ propagate() [4/4]

◆ propagateWithPath() [1/13]

◆ propagateWithPath() [2/13]

◆ propagateWithPath() [3/13]

◆ propagateWithPath() [4/13]

◆ propagateWithPath() [5/13]

◆ propagateWithPath() [6/13]

◆ propagateWithPath() [7/13]

◆ propagateWithPath() [8/13]

◆ propagateWithPath() [9/13]

◆ propagateWithPath() [10/13]

◆ propagateWithPath() [11/13]

◆ propagateWithPath() [12/13]

◆ propagateWithPath() [13/13]

◆ propagator()

◆ setMaxDirectionChange()

◆ setPropagationDirection()

Member Data Documentation

◆ thePropagator