Propagator Class Reference

#include <Propagator.h>

Inheritance diagram for Propagator:

Public Member Functions
virtual Propagator *	clone () const =0
virtual const MagneticField *	magneticField () const =0
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 Cylinder &) const =0
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...
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
virtual PropagationDirection	propagationDirection () const final
	Propagator (PropagationDirection dir=alongMomentum)
virtual bool	setMaxDirectionChange (float phiMax)
virtual void	setPropagationDirection (PropagationDirection dir)
virtual	~Propagator ()

Private Attributes
PropagationDirection	theDir

Detailed Description

Basic tool for "propagation" of trajectory states to surfaces. If the starting state has an error matrix the errors will be also propagated. If you want to propagate just the parameters, construct a starting state that does not have errors. In case of propagation failure (e.g. when the trajectory does not cross the destination surface) and invalid state is returned. Always check the returned state with isValid() before using it!

The propagation can be "alongMomentum" or "oppositeToMomentum" (see setPropagationDirection() below). The difference between the two is the sign of energy loss: the trajectory momentum decreases "alongMomentum" and increases "oppositeToMomentum". In both directions extrapolation errors and multiple scattering errors increase. Propagation "oppositeToMomentum" is convenient for fitting a track "backwards", sterting from the last measurement.

The propagator interface promises to take you to "any surface" but you should check the concrete propagator you are using for additional limitations.

derived classes have to implement the PropagateWithPath for Plane and Cylinder

Definition at line 44 of file Propagator.h.

Constructor & Destructor Documentation

Propagator()

Propagator::Propagator ( PropagationDirection  dir = alongMomentum )

inlineexplicit

Definition at line 46 of file Propagator.h.

: theDir(dir) {}

~Propagator()

Propagator::~Propagator ( )

virtual

Definition at line 8 of file Propagator.cc.

{}

Member Function Documentation

clone()

virtual Propagator* Propagator::clone ( ) const

pure virtual

Implemented in PropagatorWithMaterial, GsfPropagatorWithMaterial, Geant4ePropagator, SteppingHelixPropagator, AnalyticalPropagator, SmartPropagator, GsfPropagatorAdapter, BeamHaloPropagator, RKPropagatorInS, StraightLinePropagator, RKPropagatorInR, and RKPropagatorInZ.

Referenced by SiPixelHitEfficiencySource::analyze(), BeamHaloPropagator::BeamHaloPropagator(), MuonSimHitProducer::beginRun(), TrackEfficiencyMonitor::compatibleLayers(), TrajectoryExtrapolatorToLine::extrapolate(), TrackEfficiencyMonitor::findNextLayer(), KFTrajectorySmoother::KFTrajectorySmoother(), SeedingOTEDProducer::run(), SetPropagationDirection(), SmartPropagator::SmartPropagator(), and TrackEfficiencyMonitor::trackerAcceptance().

magneticField()

virtual const MagneticField* Propagator::magneticField ( ) const

pure virtual

Implemented in AnalyticalPropagator, SmartPropagator, PropagatorWithMaterial, GsfPropagatorWithMaterial, SteppingHelixPropagator, Geant4ePropagator, BeamHaloPropagator, GsfPropagatorAdapter, RKPropagatorInS, StraightLinePropagator, RKPropagatorInR, and RKPropagatorInZ.

Referenced by AnalyticalTrajectoryExtrapolatorToLine::extrapolateSingleState(), TrackProducer::getTransient(), TrackProducerWithSCAssociation::getTransient(), TransientInitialStateEstimator::innerState(), GsfPropagatorAdapter::magneticField(), CosmicRegionalSeedGenerator::regions(), and BaseCkfTrajectoryBuilder::seedMeasurements().

propagate() [1/4]

virtual FreeTrajectoryState Propagator::propagate ( const FreeTrajectoryState &  ftsStart, const GlobalPoint &  pDest  ) const

inlinefinalvirtual

Definition at line 109 of file Propagator.h.

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

References propagateWithPath().

propagate() [2/4]

virtual FreeTrajectoryState Propagator::propagate ( const FreeTrajectoryState &  ftsStart, const GlobalPoint &  pDest1, const GlobalPoint &  pDest2  ) const

inlinefinalvirtual

Definition at line 112 of file Propagator.h.

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

References propagateWithPath().

propagate() [3/4]

virtual FreeTrajectoryState Propagator::propagate ( const FreeTrajectoryState &  ftsStart, const reco::BeamSpot &  beamSpot  ) const

inlinefinalvirtual

Definition at line 117 of file Propagator.h.

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

References pwdgSkimBPark_cfi::beamSpot, and propagateWithPath().

propagate() [4/4]

template<typename STA , typename SUR >

TrajectoryStateOnSurface Propagator::propagate ( STA const &  state, SUR const &  surface  ) const

inline

Definition at line 50 of file Propagator.h.

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

References propagateWithPath().

Referenced by CRackTrajectoryBuilder::AddHit(), CkfDebugger::analyseCompatibleMeasurements(), CkfDebugger::analyseRecHitExistance(), MuonAlignmentAnalyzer::analyze(), TestHits::analyze(), TestSmoothHits::analyze(), TestTrackHits::analyze(), CosmicMuonTrajectoryBuilder::build(), MTDSectorForwardDoubleLayer::compatible(), MuDetRing::compatible(), MTDDetRing::compatible(), BarrelDetLayer::compatible(), ForwardDetLayer::compatible(), MuDetRod::compatible(), MTDDetTray::compatible(), MTDDetSector::compatible(), MuRingForwardDoubleLayer::compatible(), MTDRingForwardDoubleLayer::compatible(), PixelRod::compatibleDetsV(), TrackEfficiencyMonitor::compatibleLayers(), CkfDebugger::computePulls(), SeedFromNuclearInteraction::construct(), OutInConversionSeedFinder::createSeed(), InOutConversionSeedFinder::createSeed(), L1MuonRecoTreeProducer::cylExtrapTrkSam(), ResidualRefitting::cylExtrapTrkSam(), CSCPairResidualsConstraint::dphidzFromTrack(), PropagateToMuon::extrapolate(), AnalyticalImpactPointExtrapolator::extrapolateFullState(), AnalyticalTrajectoryExtrapolatorToLine::extrapolateFullState(), InOutConversionSeedFinder::fillClusterSeeds(), GsfTrackProducerBase::fillMode(), SETFilter::findChi2(), TrackEfficiencyMonitor::findNextLayer(), CosmicMuonSmoother::fit(), GsfTrajectoryFitter::fitOne(), HDetIdAssociator::getTrajectory(), GlobalTrajectoryBuilderBase::getTransientRecHits(), CosmicMuonTrajectoryBuilder::intermediateState(), GeomDetCompatibilityChecker::isCompatible(), ticl::SeedingRegionByTracks::makeRegions(), TSGForRoadSearch::makeSeeds_0(), TSGForRoadSearch::makeSeeds_4(), MatcherUsingTracksAlgorithm::matchWithPropagation(), MuonResidualsFromTrack::MuonResidualsFromTrack(), StateOnTrackerBound::operator()(), cms::CkfTrackCandidateMakerBase::produceBase(), CachedTrajectory::propagate(), SeedingOTEDProducer::propagateAndUpdate(), TrackExtrapolator::propagateTrackToVolume(), KFBasedPixelFitter::run(), BaseCkfTrajectoryBuilder::seedMeasurements(), CosmicMuonSmoother::smooth(), CosmicMuonUtilities::stepPropagate(), L1MuonRecoTreeProducer::surfExtrapTrkSam(), TrackEfficiencyMonitor::testSTATracks(), TrackEfficiencyMonitor::testTrackerTracks(), TrackEfficiencyMonitor::trackerAcceptance(), InOutConversionTrackFinder::tracks(), OutInConversionTrackFinder::tracks(), KFTrajectorySmoother::trajectory(), SETFilter::transform(), TrackTransformer::transform(), and ResidualRefitting::trkExtrap().

propagateWithPath() [1/9]

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

pure virtual

Implemented in SteppingHelixPropagator, StraightLinePropagator, SmartPropagator, BeamHaloPropagator, PropagatorWithMaterial, AnalyticalPropagator, Geant4ePropagator, GsfPropagatorWithMaterial, GsfPropagatorAdapter, RKPropagatorInS, RKPropagatorInR, and RKPropagatorInZ.

propagateWithPath() [2/9]

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

pure virtual

Implemented in SteppingHelixPropagator, StraightLinePropagator, SmartPropagator, BeamHaloPropagator, PropagatorWithMaterial, AnalyticalPropagator, Geant4ePropagator, GsfPropagatorWithMaterial, GsfPropagatorAdapter, RKPropagatorInS, RKPropagatorInR, and RKPropagatorInZ.

propagateWithPath() [3/9]

std::pair< TrajectoryStateOnSurface, double > Propagator::propagateWithPath ( const FreeTrajectoryState &  state, const Surface &  sur  ) const

finalvirtual

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");
}

Referenced by MkFitOutputConverter::backwardFit(), TrackExtenderWithMTDT< TrackCollection >::buildTrack(), CSCTimingExtractor::fillTiming(), DTTimingExtractor::fillTiming(), propagate(), ReferenceTrajectory::propagate(), GsfPropagatorAdapter::propagateWithPath(), PropagatorWithMaterial::propagateWithPath(), BeamHaloPropagator::propagateWithPath(), SmartPropagator::propagateWithPath(), and propagateWithPath().

propagateWithPath() [4/9]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath ( const FreeTrajectoryState &  ftsStart, const GlobalPoint &  pDest  ) const

virtual

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

Reimplemented in SteppingHelixPropagator.

Definition at line 42 of file Propagator.cc.

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

References Exception.

propagateWithPath() [5/9]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath ( const FreeTrajectoryState &  ftsStart, const GlobalPoint &  pDest1, const GlobalPoint &  pDest2  ) const

virtual

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

Reimplemented in SteppingHelixPropagator.

Definition at line 47 of file Propagator.cc.

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

References Exception.

propagateWithPath() [6/9]

std::pair< FreeTrajectoryState, double > Propagator::propagateWithPath ( const FreeTrajectoryState &  ftsStart, const reco::BeamSpot &  beamSpot  ) const

virtual

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

Reimplemented in SteppingHelixPropagator.

Definition at line 53 of file Propagator.cc.

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

References Exception.

propagateWithPath() [7/9]

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

inlinevirtual

Reimplemented in SmartPropagator, PropagatorWithMaterial, Geant4ePropagator, GsfPropagatorWithMaterial, and GsfPropagatorAdapter.

Definition at line 91 of file Propagator.h.

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

References TrajectoryStateOnSurface::freeState(), and propagateWithPath().

propagateWithPath() [8/9]

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

inlinevirtual

Reimplemented in SmartPropagator, PropagatorWithMaterial, Geant4ePropagator, GsfPropagatorWithMaterial, and GsfPropagatorAdapter.

Definition at line 86 of file Propagator.h.

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

References TrajectoryStateOnSurface::freeState(), and propagateWithPath().

propagateWithPath() [9/9]

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

finalvirtual

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");
}

References propagateWithPath().

propagationDirection()

virtual PropagationDirection Propagator::propagationDirection ( void  ) const

inlinefinalvirtual

Returns the current value of the propagation direction. If you need to know the actual direction used for a given propagation in case "propagationDirection() == anyDirection", you should use propagateWithPath. A positive sign of path lengt means "alongMomentum", an egeative sign means "oppositeToMomentum".

Definition at line 139 of file Propagator.h.

{ return theDir; }

References theDir.

Referenced by LayerCrossingSide::barrelSide(), BeamHaloPropagator::clone(), Geant4ePropagator::configurePropagation(), GsfPropagatorWithMaterial::convoluteWithMaterial(), SeedingOTEDProducer::createSeed(), BeamHaloPropagator::directionCheck(), LayerCrossingSide::endcapSide(), PixelForwardLayer::groupedCompatibleDetsV(), PixelForwardLayerPhase1::groupedCompatibleDetsV(), TECLayer::groupedCompatibleDetsV(), TBLayer::groupedCompatibleDetsV(), TIBRing::groupedCompatibleDetsV(), TIDRing::groupedCompatibleDetsV(), CompositeTECWedge::groupedCompatibleDetsV(), Phase2EndcapLayer::groupedCompatibleDetsV(), Phase2EndcapRing::groupedCompatibleDetsV(), TOBRod::groupedCompatibleDetsV(), PixelBlade::groupedCompatibleDetsV(), Phase1PixelBlade::groupedCompatibleDetsV(), Phase2OTBarrelRod::groupedCompatibleDetsV(), CompositeTECPetal::groupedCompatibleDetsV(), GeomDetCompatibilityChecker::isCompatible(), StraightLinePropagator::jacobian(), PropagatorWithMaterial::materialAtSource(), GsfPropagatorWithMaterial::materialAtSource(), SteppingHelixPropagator::propagate(), Geant4ePropagator::propagateGeneric(), StraightLinePropagator::propagateParametersOnCylinder(), RKPropagatorInS::propagateParametersOnCylinder(), RKPropagatorInS::propagateParametersOnPlane(), RKPropagatorInS::propagateWithPath(), GsfPropagatorWithMaterial::propagateWithPath(), PropagatorWithMaterial::propagateWithPath(), TIDLayer::ringIndicesByCrossingProximity(), Phase2EndcapLayer::ringIndicesByCrossingProximity(), SeedingOTEDProducer::run(), SteppingHelixPropagator::setIState(), OutInConversionSeedFinder::startSeed(), and KFTrajectorySmoother::trajectory().

setMaxDirectionChange()

virtual bool Propagator::setMaxDirectionChange ( float  phiMax )

inlinevirtual

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 in PropagatorWithMaterial, GsfPropagatorWithMaterial, AnalyticalPropagator, and GsfPropagatorAdapter.

Definition at line 151 of file Propagator.h.

{ return false; }

Referenced by GsfPropagatorAdapter::setMaxDirectionChange(), and PropagatorWithMaterial::setMaxDirectionChange().

setPropagationDirection()

virtual void Propagator::setPropagationDirection ( PropagationDirection  dir )

inlinevirtual

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 in PropagatorWithMaterial, SmartPropagator, GsfPropagatorWithMaterial, BeamHaloPropagator, and GsfPropagatorAdapter.

Definition at line 130 of file Propagator.h.

{ theDir = dir; }

References DeadROC_duringRun::dir, and theDir.

Referenced by AnalyticalImpactPointExtrapolator::AnalyticalImpactPointExtrapolator(), AnalyticalTrajectoryExtrapolatorToLine::AnalyticalTrajectoryExtrapolatorToLine(), SiPixelHitEfficiencySource::analyze(), TrackEfficiencyMonitor::compatibleLayers(), BeamHaloPropagator::directionCheck(), TrackEfficiencyMonitor::findNextLayer(), SimpleNavigableLayer::propagator(), SeedingOTEDProducer::run(), GsfPropagatorAdapter::setPropagationDirection(), BeamHaloPropagator::setPropagationDirection(), GsfPropagatorWithMaterial::setPropagationDirection(), SmartPropagator::setPropagationDirection(), PropagatorWithMaterial::setPropagationDirection(), TrackEfficiencyMonitor::trackerAcceptance(), TransverseImpactPointExtrapolator::TransverseImpactPointExtrapolator(), and TSCBLBuilderWithPropagator::TSCBLBuilderWithPropagator().

Member Data Documentation

theDir

PropagationDirection Propagator::theDir

private

Definition at line 158 of file Propagator.h.

Referenced by propagationDirection(), and setPropagationDirection().