#include <PropagatorWithMaterial.h>

Inheritance diagram for PropagatorWithMaterial:

Public Types
enum	MaterialLocation { atSource, atDestination, fromDirection }

Public Member Functions
PropagatorWithMaterial *	clone () const override

const Propagator &	geometricalPropagator () const
	Access to the geometrical propagator. More...

const MagneticField *	magneticField () const override

const MaterialEffectsUpdator &	materialEffectsUpdator () const
	Access to the MaterialEffectsUpdator. More...

	PropagatorWithMaterial (PropagationDirection dir, const float mass, const MagneticField *mf=0, const float maxDPhi=1.6, bool useRungeKutta=false, float ptMin=-1., bool useOldGeoPropLogic=true)

void	setMaterialLocation (const MaterialLocation location)

bool	setMaxDirectionChange (float phiMax) override
	Limit on change in azimuthal angle. More...

void	setPropagationDirection (PropagationDirection dir) override
	Propagation direction. More...

	~PropagatorWithMaterial () 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 Types
typedef std::pair< TrajectoryStateOnSurface, double >	TsosWP

Private Member Functions
bool	materialAtSource () const
	Inclusion of material at the source? More...

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

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

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

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

Private Attributes
const MagneticField *	field

defaultRKPropagator::Product	rkProduct

DeepCopyPointerByClone< Propagator >	theGeometricalPropagator

MaterialLocation	theMaterialLocation

DeepCopyPointerByClone< MaterialEffectsUpdator >	theMEUpdator

bool	useRungeKutta_

Detailed Description

Propagation including material effects.

Propagates using a specific for the geometrical part and a MaterialEffectsUpdator to include multiple scattering and energy loss. By default material effects are included at the source in the case of forward propagation and at the destination for backward propagation. Material effects at the source can only be included when propagating from a TrajectoryStateOnSurface. Ported from ORCA.

Author: todorov, cerati

Definition at line 25 of file PropagatorWithMaterial.h.

Member Typedef Documentation

typedef std::pair<TrajectoryStateOnSurface,double> PropagatorWithMaterial::TsosWP

private

Definition at line 113 of file PropagatorWithMaterial.h.

Member Enumeration Documentation

enum PropagatorWithMaterial::MaterialLocation

Enumerator
atSource
atDestination
fromDirection

Definition at line 71 of file PropagatorWithMaterial.h.

71 {atSource, atDestination, fromDirection};

PropagatorWithMaterial::atSource

Definition: PropagatorWithMaterial.h:71

PropagatorWithMaterial::fromDirection

Definition: PropagatorWithMaterial.h:71

PropagatorWithMaterial::atDestination

Definition: PropagatorWithMaterial.h:71

Constructor & Destructor Documentation

PropagatorWithMaterial::PropagatorWithMaterial	(	PropagationDirection	dir,
		const float	mass,
		const MagneticField *	mf = `0`,
		const float	maxDPhi = `1.6`,
		bool	useRungeKutta = `false`,
		float	ptMin = `-1.`,
		bool	useOldGeoPropLogic = `true`
	)

Constructor with PropagationDirection and mass hypothesis. Uses AnalyticalPropagator and CombinedMaterialEffectsUpdator with explicit mass hypothesis.MaxDPhi is a cut on the max change in phi during state propagation. For propagation of very low pt tracks (e.g. loopers), this cut can be loosened. If ptMin > 0, then multiple scattering calculations will take into account the uncertainty in the reconstructed track momentum, (by default neglected), but assuming that the track Pt will never fall below ptMin.

Definition at line 13 of file PropagatorWithMaterial.cc.

Referenced by clone().

                                                                                       :
   Propagator(dir),
   rkProduct(mf,dir),
   theGeometricalPropagator(useRungeKutta ?
                rkProduct.propagator.clone() :
                new AnalyticalPropagator(mf,dir,maxDPhi,useOldAnalPropLogic)
                ),
   theMEUpdator(new CombinedMaterialEffectsUpdator(mass, ptMin)),
   theMaterialLocation(atDestination), field(mf),useRungeKutta_(useRungeKutta) {
 
 
 }

PropagatorWithMaterial::~PropagatorWithMaterial ( )

override

Definition at line 10 of file PropagatorWithMaterial.cc.

10 {}

Member Function Documentation

PropagatorWithMaterial* PropagatorWithMaterial::clone ( void ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 95 of file PropagatorWithMaterial.h.

References dso_internal, materialAtSource(), and PropagatorWithMaterial().

     {
       return new PropagatorWithMaterial(*this);
     }

const Propagator& PropagatorWithMaterial::geometricalPropagator ( ) const

inline

Access to the geometrical propagator.

Definition at line 84 of file PropagatorWithMaterial.h.

References theGeometricalPropagator.

                                                   {
     return *theGeometricalPropagator;
   }

const MagneticField* PropagatorWithMaterial::magneticField ( ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 92 of file PropagatorWithMaterial.h.

References field.

92 {return field;}

PropagatorWithMaterial::field

const MagneticField * field

Definition: PropagatorWithMaterial.h:116

bool PropagatorWithMaterial::materialAtSource ( ) const

private

Inclusion of material at the source?

Definition at line 118 of file PropagatorWithMaterial.cc.

References alongMomentum, anyDirection, atDestination, atSource, Exception, fromDirection, Propagator::propagationDirection(), theMaterialLocation, and UNLIKELY.

Referenced by clone(), and propagateWithPath().

                                                {
   if UNLIKELY( (propagationDirection()==anyDirection) &&  (theMaterialLocation!=atDestination) )
            throw cms::Exception("TrackingTools/MaterialEffects",
                     "PropagatorWithMaterial: propagation direction = anyDirection is incompatible with adding of material at source");
 
   return theMaterialLocation==atSource || (theMaterialLocation==fromDirection&&
                        propagationDirection()==alongMomentum);
 }

const MaterialEffectsUpdator& PropagatorWithMaterial::materialEffectsUpdator ( ) const

inline

Access to the MaterialEffectsUpdator.

Definition at line 88 of file PropagatorWithMaterial.h.

References theMEUpdator.

                                                                {
     return *theMEUpdator;
   }

pair< TrajectoryStateOnSurface, double > PropagatorWithMaterial::propagateWithPath	(	const TrajectoryStateOnSurface &	tsos,
		const Plane &	plane
	)		const

overrideprivatevirtual

Reimplemented from Propagator.

Definition at line 59 of file PropagatorWithMaterial.cc.

References materialAtSource(), Propagator::propagateWithPath(), Propagator::propagationDirection(), theGeometricalPropagator, theMEUpdator, UNLIKELY, and MaterialEffectsUpdator::updateStateInPlace().

                                                  {
   //
   // add material at starting surface, if requested
   //
   TsosWP newTsosWP(tsos,0.);
   if ( materialAtSource() ) {
     bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,propagationDirection());
     if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   }
   if UNLIKELY( !newTsosWP.first.isValid() )  return newTsosWP;
   //
   // geometrical propagation
   //
   newTsosWP = theGeometricalPropagator->propagateWithPath(newTsosWP.first,plane);
   if UNLIKELY( !newTsosWP.first.isValid() || materialAtSource() )  return newTsosWP;
   //
   // add material at destination surface, if requested
   //
   bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,
                                                    PropagationDirectionFromPath()(newTsosWP.second,
                                                                                   propagationDirection()));
   if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   return newTsosWP;
 }

pair< TrajectoryStateOnSurface, double > PropagatorWithMaterial::propagateWithPath	(	const FreeTrajectoryState &	fts,
		const Plane &	plane
	)		const

overrideprivatevirtual

Implements Propagator.

Definition at line 32 of file PropagatorWithMaterial.cc.

References materialAtSource(), Propagator::propagateWithPath(), Propagator::propagationDirection(), theGeometricalPropagator, theMEUpdator, UNLIKELY, and MaterialEffectsUpdator::updateStateInPlace().

                                                  {
   TsosWP newTsosWP = theGeometricalPropagator->propagateWithPath(fts,plane);
   if ( (newTsosWP.first).isValid() && !materialAtSource() ) {
       bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,
                                                        PropagationDirectionFromPath()(newTsosWP.second,
                                                                                       propagationDirection()));
       if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   }
   return newTsosWP;
 }

pair< TrajectoryStateOnSurface, double > PropagatorWithMaterial::propagateWithPath	(	const TrajectoryStateOnSurface &	tsos,
		const Cylinder &	cylinder
	)		const

overrideprivatevirtual

Reimplemented from Propagator.

Definition at line 86 of file PropagatorWithMaterial.cc.

References materialAtSource(), Propagator::propagateWithPath(), Propagator::propagationDirection(), theGeometricalPropagator, theMEUpdator, UNLIKELY, and MaterialEffectsUpdator::updateStateInPlace().

                                                        {
   //
   // add material at starting surface, if requested
   //
   TsosWP newTsosWP(tsos,0.);
   if ( materialAtSource() ) {
     bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,propagationDirection());
     if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   }
   if UNLIKELY( !newTsosWP.first.isValid() )  return newTsosWP;
   //
   // geometrical propagation
   //
   newTsosWP = theGeometricalPropagator->propagateWithPath(newTsosWP.first,cylinder);
   if UNLIKELY( !(newTsosWP.first).isValid() || materialAtSource() )  return newTsosWP;
   //
   // add material at destination surface, if requested
   //
   bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,
                                                    PropagationDirectionFromPath()(newTsosWP.second,
                                                                                   propagationDirection()));
   if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   return newTsosWP;
 }

pair< TrajectoryStateOnSurface, double > PropagatorWithMaterial::propagateWithPath	(	const FreeTrajectoryState &	fts,
		const Cylinder &	cylinder
	)		const

overrideprivatevirtual

Implements Propagator.

Definition at line 45 of file PropagatorWithMaterial.cc.

References materialAtSource(), Propagator::propagateWithPath(), Propagator::propagationDirection(), theGeometricalPropagator, theMEUpdator, UNLIKELY, and MaterialEffectsUpdator::updateStateInPlace().

                                                        {
   TsosWP newTsosWP = theGeometricalPropagator->propagateWithPath(fts,cylinder);
   if ( (newTsosWP.first).isValid() && !materialAtSource() ) {
       bool updateOk = theMEUpdator->updateStateInPlace(newTsosWP.first,
                                                        PropagationDirectionFromPath()(newTsosWP.second,
                                                                                       propagationDirection()));
       if UNLIKELY(!updateOk) newTsosWP.first = TrajectoryStateOnSurface();
   }
   return newTsosWP;
 }

void PropagatorWithMaterial::setMaterialLocation ( const MaterialLocation location )

inline

Choice of location for including material effects: fromDirection is equivalent to atSource for propagation alongMomentum and to atDestination for propagation oppositeToMomentum. Inclusion of material effects at the source (either explicitely or implicitely) is not possible if propagating with anyDirection and will effectively disable material effects when propagating from a FreeTrajectoryState.

Definition at line 80 of file PropagatorWithMaterial.h.

References theMaterialLocation.

                                                              {
     theMaterialLocation = location;
   }

bool PropagatorWithMaterial::setMaxDirectionChange ( float phiMax )

inlineoverridevirtual

Limit on change in azimuthal angle.

Reimplemented from Propagator.

Definition at line 65 of file PropagatorWithMaterial.h.

References Propagator::setMaxDirectionChange(), setPropagationDirection(), and theGeometricalPropagator.

                                                      {
     return theGeometricalPropagator->setMaxDirectionChange(phiMax);
   }

void PropagatorWithMaterial::setPropagationDirection ( PropagationDirection dir )

overridevirtual

Propagation direction.

Reimplemented from Propagator.

Definition at line 112 of file PropagatorWithMaterial.cc.

References Propagator::setPropagationDirection(), and theGeometricalPropagator.

Referenced by setMaxDirectionChange().

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