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
virtual std::pair < TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Surface &) const final
virtual std::pair < TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Plane &) const =0
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 < 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 < 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
	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 45 of file Propagator.h.

Constructor & Destructor Documentation

Propagator::Propagator ( PropagationDirection  dir = alongMomentum )

inlineexplicit

Definition at line 48 of file Propagator.h.

                                                                 :
    theDir(dir) {}

Propagator::~Propagator ( )

virtual

Definition at line 9 of file Propagator.cc.

{}

Member Function Documentation

virtual Propagator* Propagator::clone ( ) const

pure virtual

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

Referenced by BeamHaloPropagator::BeamHaloPropagator(), MuonSimHitProducer::beginRun(), TrajectoryExtrapolatorToLine::extrapolate(), KFTrajectorySmoother::KFTrajectorySmoother(), SetPropagationDirection(), SmartPropagator::SmartPropagator(), PerigeeRefittedTrackState::trajectoryStateOnSurface(), and KinematicRefittedTrackState::trajectoryStateOnSurface().

virtual const MagneticField* Propagator::magneticField ( ) const

pure virtual

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

Referenced by AnalyticalTrajectoryExtrapolatorToLine::extrapolateSingleState(), TransientInitialStateEstimator::innerState(), GsfPropagatorAdapter::magneticField(), and BaseCkfTrajectoryBuilder::seedMeasurements().

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

inlinefinalvirtual

Definition at line 119 of file Propagator.h.

References propagateWithPath().

Referenced by CRackTrajectoryBuilder::AddHit(), SiStripElectronSeedGenerator::altCheckHitsAndTSOS(), CkfDebugger::analyseCompatibleMeasurements(), CkfDebugger::analyseRecHitExistance(), ElectronSeedAnalyzer::analyze(), MuonAlignmentAnalyzer::analyze(), TestTrackHits::analyze(), MuonAlignment::analyze(), CosmicMuonTrajectoryBuilder::build(), SeedFromGenericPairOrTriplet::buildSeed(), SeedFromConsecutiveHitsCreator::buildSeed(), SeedForPhotonConversion1Leg::buildSeed(), SeedForPhotonConversionFromQuadruplets::buildSeed(), SeedForPhotonConversionFromQuadruplets::buildSeedBool(), SiStripElectronSeedGenerator::checkHitsAndTSOS(), ConversionProducer::checkPhi(), MuDetRing::compatible(), ForwardDetLayer::compatible(), BarrelDetLayer::compatible(), MuDetRod::compatible(), MuRingForwardDoubleLayer::compatible(), PixelRod::compatibleDetsV(), TrackEfficiencyMonitor::compatibleLayers(), CkfDebugger::computePulls(), SeedFromNuclearInteraction::construct(), OutInConversionSeedFinder::createSeed(), InOutConversionSeedFinder::createSeed(), MultipleScatteringGeometry::detLayers(), TransverseImpactPointExtrapolator::doExtrapolation(), CSCPairResidualsConstraint::dphidzFromTrack(), PropagateToMuon::extrapolate(), AnalyticalImpactPointExtrapolator::extrapolateFullState(), AnalyticalTrajectoryExtrapolatorToLine::extrapolateFullState(), InOutConversionSeedFinder::fillClusterSeeds(), GsfTrackProducerBase::fillMode(), HLTMuonPointingFilter::filter(), ConversionTrackEcalImpactPoint::find(), SETFilter::findChi2(), TrackEfficiencyMonitor::findNextLayer(), CosmicMuonSmoother::fit(), GsfTrajectoryFitter::fitOne(), ConversionProducer::getTrackImpactPosition(), HDetIdAssociator::getTrajectory(), SeedFromProtoTrack::init(), CosmicMuonTrajectoryBuilder::intermediateState(), GeomDetCompatibilityChecker::isCompatible(), StateOnTrackerBound::operator()(), ConvBremSeedProducer::produce(), TrackingRecHitPropagator::project(), RecHitPropagator::propagate(), NavCylinder::propagate(), NavCone::propagate(), NavPlane::propagate(), CachedTrajectory::propagate(), spr::propagateCalo(), MuonTrajectoryUpdator::propagateState(), cms::MuonTCMETValueMapProducer::propagateTrack(), spr::propagateTrackerEnd(), TCMETAlgo::propagateTrackToCalorimeterFace(), TrackExtrapolator::propagateTrackToVolume(), TkConvValidator::recalculateMomentumAtFittedVertex(), BaseCkfTrajectoryBuilder::seedMeasurements(), SeedGeneratorForCRack::seeds(), SeedGeneratorForCosmics::seeds(), SimpleCosmicBONSeeder::seeds(), CosmicMuonSmoother::smooth(), CosmicMuonUtilities::stepPropagate(), TrackEfficiencyMonitor::trackerAcceptance(), KFTrajectorySmoother::trajectory(), TrajectoryAtInvalidHit::TrajectoryAtInvalidHit(), PerigeeRefittedTrackState::trajectoryStateOnSurface(), KinematicRefittedTrackState::trajectoryStateOnSurface(), and SETFilter::transform().

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

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

inlinefinalvirtual

Definition at line 123 of file Propagator.h.

References propagateWithPath().

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

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

inlinefinalvirtual

Definition at line 128 of file Propagator.h.

References SiPixelRawToDigiRegional_cfi::beamSpot, and propagateWithPath().

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

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 15 of file Propagator.cc.

Referenced by CSCTimingExtractor::fillTiming(), DTTimingExtractor::fillTiming(), MuonSimHitProducer::produce(), ReferenceTrajectory::propagate(), propagate(), CosmicGenFilterHelix::propagateToCutCylinder(), NavCylinder::propagateWithPath(), NavCone::propagateWithPath(), NavPlane::propagateWithPath(), GsfPropagatorAdapter::propagateWithPath(), PropagatorWithMaterial::propagateWithPath(), BeamHaloPropagator::propagateWithPath(), SmartPropagator::propagateWithPath(), and propagateWithPath().

{
  // try plane first, most probable case (disk "is a" plane too) 
  const Plane* bp = dynamic_cast<const Plane*>(&sur);
  if (bp != 0) return propagateWithPath( state, *bp);
  
  // if not plane try cylinder
  const Cylinder* bc = dynamic_cast<const Cylinder*>(&sur);
  if (bc != 0) return propagateWithPath( state, *bc);

  // unknown surface - can't do it!
  throw PropagationException("The surface is neither Cylinder nor Plane");
}

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

pure virtual

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

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

pure virtual

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

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 31 of file Propagator.cc.

References propagateWithPath().

{
  // try plane first, most probable case (disk "is a" plane too) 
  const Plane* bp = dynamic_cast<const Plane*>(&sur);
  if (bp != 0) return propagateWithPath( state, *bp);
  
  // if not plane try cylinder
  const Cylinder* bc = dynamic_cast<const Cylinder*>(&sur);
  if (bc != 0) return propagateWithPath( state, *bc);

  // unknown surface - can't do it!
  throw PropagationException("The surface is neither Cylinder nor Plane");
}

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

inlinevirtual

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

Definition at line 95 of file Propagator.h.

References propagateWithPath().

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

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

inlinevirtual

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

Definition at line 100 of file Propagator.h.

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

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

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 48 of file Propagator.cc.

References Exception.

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

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 54 of file Propagator.cc.

References Exception.

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

}

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 61 of file Propagator.cc.

References Exception.

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

virtual PropagationDirection Propagator::propagationDirection ( void  ) const

inlinevirtual

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 155 of file Propagator.h.

References theDir.

Referenced by GroupedCkfTrajectoryBuilder::advanceOneLayer(), LayerCrossingSide::barrelSide(), BeamHaloPropagator::clone(), OutInConversionSeedFinder::completeSeed(), Geant4ePropagator::configurePropagation(), GsfPropagatorWithMaterial::convoluteWithMaterial(), BeamHaloPropagator::directionCheck(), LayerCrossingSide::endcapSide(), HLTMuonPointingFilter::filter(), PixelForwardLayer::groupedCompatibleDetsV(), PixelForwardLayerPhase1::groupedCompatibleDetsV(), TECLayer::groupedCompatibleDetsV(), TIDRing::groupedCompatibleDetsV(), CompositeTECWedge::groupedCompatibleDetsV(), Phase2OTECRingedLayer::groupedCompatibleDetsV(), TBLayer::groupedCompatibleDetsV(), TIBRing::groupedCompatibleDetsV(), Phase2OTECRing::groupedCompatibleDetsV(), TOBRod::groupedCompatibleDetsV(), PixelBlade::groupedCompatibleDetsV(), Phase1PixelBlade::groupedCompatibleDetsV(), Phase2OTBarrelRod::groupedCompatibleDetsV(), CompositeTECPetal::groupedCompatibleDetsV(), StraightLinePropagator::jacobian(), PropagatorWithMaterial::materialAtSource(), GsfPropagatorWithMaterial::materialAtSource(), SteppingHelixPropagator::propagate(), Geant4ePropagator::propagateGeneric(), StraightLinePropagator::propagateParametersOnCylinder(), RKPropagatorInS::propagateParametersOnCylinder(), RKPropagatorInS::propagateParametersOnPlane(), RKPropagatorInS::propagateWithPath(), GsfPropagatorWithMaterial::propagateWithPath(), PropagatorWithMaterial::propagateWithPath(), TIDLayer::ringIndicesByCrossingProximity(), Phase2OTECRingedLayer::ringIndicesByCrossingProximity(), SteppingHelixPropagator::setIState(), OutInConversionSeedFinder::startSeed(), and KFTrajectorySmoother::trajectory().

                                                                        {
    return theDir;
  }

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

Definition at line 169 of file Propagator.h.

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

{ return false;}

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

Definition at line 144 of file Propagator.h.

References dir, and theDir.

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

                                                                 {
    theDir = dir;
  }

Member Data Documentation

PropagationDirection Propagator::theDir

private

Definition at line 177 of file Propagator.h.

Referenced by propagationDirection(), and setPropagationDirection().