PropagatorWithMaterial Class Reference

#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...
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< 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 FreeTrajectoryState &, const Cylinder &) const=0
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Surface &sur) const final
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Plane &sur) 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< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Cylinder &sur) const
virtual std::pair< FreeTrajectoryState, double >	propagateWithPath (const FreeTrajectoryState &ftsStart, const GlobalPoint &pDest) const
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Surface &) const final
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Plane &) const=0
	PropagatorWithMaterial (PropagationDirection dir, const float mass, const MagneticField *mf=nullptr, 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

TsosWP

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

private

Definition at line 100 of file PropagatorWithMaterial.h.

Member Enumeration Documentation

MaterialLocation

enum PropagatorWithMaterial::MaterialLocation

Enumerator
atSource
atDestination
fromDirection

Definition at line 69 of file PropagatorWithMaterial.h.

{ atSource, atDestination, fromDirection };

Constructor & Destructor Documentation

PropagatorWithMaterial()

PropagatorWithMaterial::PropagatorWithMaterial	(	PropagationDirection	dir,
		const float	mass,
		const MagneticField *	mf = nullptr,
		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 12 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::~PropagatorWithMaterial ( )

override

Definition at line 10 of file PropagatorWithMaterial.cc.

{}

Member Function Documentation

clone()

PropagatorWithMaterial* PropagatorWithMaterial::clone ( void  ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 86 of file PropagatorWithMaterial.h.

References PropagatorWithMaterial().

{ return new PropagatorWithMaterial(*this); }

geometricalPropagator()

const Propagator& PropagatorWithMaterial::geometricalPropagator ( ) const

inline

Access to the geometrical propagator.

Definition at line 80 of file PropagatorWithMaterial.h.

References theGeometricalPropagator.

{ return *theGeometricalPropagator; }

magneticField()

const MagneticField* PropagatorWithMaterial::magneticField ( ) const

inlineoverridevirtual

Implements Propagator.

Definition at line 84 of file PropagatorWithMaterial.h.

References field.

Referenced by CRackTrajectoryBuilder::innerState().

{ return field; }

materialAtSource()

bool PropagatorWithMaterial::materialAtSource ( ) const

private

Inclusion of material at the source?

Definition at line 115 of file PropagatorWithMaterial.cc.

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

Referenced by 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);
}

materialEffectsUpdator()

const MaterialEffectsUpdator& PropagatorWithMaterial::materialEffectsUpdator ( ) const

inline

Access to the MaterialEffectsUpdator.

Definition at line 82 of file PropagatorWithMaterial.h.

References theMEUpdator.

{ return *theMEUpdator; }

propagate() [1/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 117 of file Propagator.h.

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

propagate() [2/4]

template<typename STA , typename SUR >

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

inline

Definition at line 50 of file Propagator.h.

Referenced by CosmicTrajectoryBuilder::AddHit(), ConversionProducer::checkPhi(), ConversionTrackEcalImpactPoint::find(), ConversionProducer::getTrackImpactPosition(), ConvBremSeedProducer::produce(), TkConvValidator::recalculateMomentumAtFittedVertex(), CRackTrajectoryBuilder::run(), SeedGeneratorForCRack::seeds(), SeedGeneratorForCosmics::seeds(), and CRackTrajectoryBuilder::SortHits().

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

propagate() [3/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 109 of file Propagator.h.

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

propagate() [4/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 112 of file Propagator.h.

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

propagateWithPath() [1/13]

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

inline

Definition at line 91 of file Propagator.h.

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

propagateWithPath() [2/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() [3/13]

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

propagateWithPath() [4/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");
}

propagateWithPath() [5/13]

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

inline

Definition at line 86 of file Propagator.h.

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

propagateWithPath() [6/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() [7/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() [8/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() [9/13]

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

propagateWithPath() [10/13]

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

overrideprivatevirtual

Reimplemented from Propagator.

Definition at line 52 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;
}

propagateWithPath() [11/13]

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

overrideprivatevirtual

Implements Propagator.

Definition at line 28 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;
}

propagateWithPath() [12/13]

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

overrideprivatevirtual

Reimplemented from Propagator.

Definition at line 81 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;
}

propagateWithPath() [13/13]

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

overrideprivatevirtual

Implements Propagator.

Definition at line 40 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;
}

setMaterialLocation()

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 78 of file PropagatorWithMaterial.h.

References EcalCondDBWriter_cfi::location, and theMaterialLocation.

{ theMaterialLocation = location; }

setMaxDirectionChange()

bool PropagatorWithMaterial::setMaxDirectionChange ( float  phiMax )

inlineoverridevirtual

Limit on change in azimuthal angle.

Reimplemented from Propagator.

Definition at line 65 of file PropagatorWithMaterial.h.

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

{ return theGeometricalPropagator->setMaxDirectionChange(phiMax); }

setPropagationDirection()

void PropagatorWithMaterial::setPropagationDirection ( PropagationDirection  dir )

overridevirtual

Propagation direction.

Reimplemented from Propagator.

Definition at line 110 of file PropagatorWithMaterial.cc.

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

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

Member Data Documentation

field

const MagneticField* PropagatorWithMaterial::field

private

Definition at line 103 of file PropagatorWithMaterial.h.

Referenced by magneticField().

rkProduct

defaultRKPropagator::Product PropagatorWithMaterial::rkProduct

private

Definition at line 95 of file PropagatorWithMaterial.h.

theGeometricalPropagator

DeepCopyPointerByClone<Propagator> PropagatorWithMaterial::theGeometricalPropagator

private

Definition at line 96 of file PropagatorWithMaterial.h.

Referenced by geometricalPropagator(), propagateWithPath(), setMaxDirectionChange(), and setPropagationDirection().

theMaterialLocation

MaterialLocation PropagatorWithMaterial::theMaterialLocation

private

Definition at line 102 of file PropagatorWithMaterial.h.

Referenced by materialAtSource(), and setMaterialLocation().

theMEUpdator

DeepCopyPointerByClone<MaterialEffectsUpdator> PropagatorWithMaterial::theMEUpdator

private

Definition at line 99 of file PropagatorWithMaterial.h.

Referenced by materialEffectsUpdator(), and propagateWithPath().

useRungeKutta_

bool PropagatorWithMaterial::useRungeKutta_

private

Definition at line 104 of file PropagatorWithMaterial.h.