BeamHaloPropagator Class Reference

#include <BeamHaloPropagator.h>

Inheritance diagram for BeamHaloPropagator:

Public Member Functions
	BeamHaloPropagator (const Propagator *aEndCapTkProp, const Propagator *aCrossTkProp, const MagneticField *field, PropagationDirection dir=alongMomentum)
	Defines which propagator is used inside endcap and in barrel. More...
	BeamHaloPropagator (const Propagator &aEndCapTkProp, const Propagator &aCrossTkProp, const MagneticField *field, PropagationDirection dir=alongMomentum)
	Defines which propagator is used inside endcap and in barrel. More...
	BeamHaloPropagator (const BeamHaloPropagator &)
	Copy constructor. More...
BeamHaloPropagator *	clone () const override
	Virtual constructor (using copy c'tor) More...
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 TrajectoryStateOnSurface &tsos, const Surface &sur) const final
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Surface &) 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 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< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Plane &) const=0
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const TrajectoryStateOnSurface &tsos, const Plane &sur) const
virtual std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &, const Cylinder &) const=0
void	setPropagationDirection (PropagationDirection dir) override
	~BeamHaloPropagator () 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< 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 final
	Propagator (PropagationDirection dir=alongMomentum)
virtual bool	setMaxDirectionChange (float phiMax)
virtual	~Propagator ()

Private Member Functions
bool	crossingTk (const FreeTrajectoryState &fts, const Plane &plane) const
	true if the plane and the fts z position have different sign More...
void	directionCheck (PropagationDirection dir)
const Propagator *	getCrossTkPropagator () const
	return the propagator used to cross the tracker More...
const Propagator *	getEndCapTkPropagator () const
	return the propagator used in endcaps More...
const MagneticField *	magneticField () const override
	return the magneticField More...
std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &fts, const Plane &plane) const override
std::pair< TrajectoryStateOnSurface, double >	propagateWithPath (const FreeTrajectoryState &fts, const Cylinder &cylinder) const override

Private Attributes
Propagator *	theCrossTkProp
Propagator *	theEndCapTkProp
const MagneticField *	theField

Detailed Description

A propagator which use different algorithm to propagate within an endcap or to cross over to the other endcap

Author

Jean-Roch VLIMANT UCSB

Definition at line 24 of file BeamHaloPropagator.h.

Constructor & Destructor Documentation

BeamHaloPropagator() [1/3]

BeamHaloPropagator::BeamHaloPropagator	(	const Propagator *	aEndCapTkProp,
		const Propagator *	aCrossTkProp,
		const MagneticField *	field,
		PropagationDirection	dir = alongMomentum
	)

Defines which propagator is used inside endcap and in barrel.

Definition at line 50 of file BeamHaloPropagator.cc.

References DeadROC_duringRun::dir, and directionCheck().

Referenced by clone().

    : Propagator(dir), theEndCapTkProp(aEndCapTkProp->clone()), theCrossTkProp(aCrossTkProp->clone()), theField(field) {
  directionCheck(dir);
}

BeamHaloPropagator() [2/3]

BeamHaloPropagator::BeamHaloPropagator	(	const Propagator &	aEndCapTkProp,
		const Propagator &	aCrossTkProp,
		const MagneticField *	field,
		PropagationDirection	dir = alongMomentum
	)

Defines which propagator is used inside endcap and in barrel.

Definition at line 58 of file BeamHaloPropagator.cc.

References DeadROC_duringRun::dir, and directionCheck().

    : Propagator(dir), theEndCapTkProp(aEndCapTkProp.clone()), theCrossTkProp(aCrossTkProp.clone()), theField(field) {
  directionCheck(dir);
}

BeamHaloPropagator() [3/3]

BeamHaloPropagator::BeamHaloPropagator

(

const BeamHaloPropagator &

aProp

)

Copy constructor.

Definition at line 66 of file BeamHaloPropagator.cc.

References Propagator::clone(), getCrossTkPropagator(), getEndCapTkPropagator(), theCrossTkProp, and theEndCapTkProp.

    : Propagator(aProp.propagationDirection()), theEndCapTkProp(nullptr), theCrossTkProp(nullptr) {
  if (aProp.theEndCapTkProp)
    theEndCapTkProp = aProp.getEndCapTkPropagator()->clone();
  if (aProp.theCrossTkProp)
    theCrossTkProp = aProp.getCrossTkPropagator()->clone();
}

~BeamHaloPropagator()

BeamHaloPropagator::~BeamHaloPropagator ( )

override

virtual destructor

Definition at line 75 of file BeamHaloPropagator.cc.

References theCrossTkProp, and theEndCapTkProp.

                                        {
  delete theEndCapTkProp;
  delete theCrossTkProp;
}

Member Function Documentation

clone()

BeamHaloPropagator* BeamHaloPropagator::clone ( void  ) const

inlineoverridevirtual

Virtual constructor (using copy c'tor)

Implements Propagator.

Definition at line 46 of file BeamHaloPropagator.h.

References BeamHaloPropagator(), getCrossTkPropagator(), getEndCapTkPropagator(), magneticField(), and Propagator::propagationDirection().

                                             {
    return new BeamHaloPropagator(
        getEndCapTkPropagator(), getCrossTkPropagator(), magneticField(), propagationDirection());
  }

crossingTk()

bool BeamHaloPropagator::crossingTk ( const FreeTrajectoryState &  fts, const Plane &  plane  ) const

private

true if the plane and the fts z position have different sign

Definition at line 80 of file BeamHaloPropagator.cc.

References LogDebug, GloballyPositioned< T >::position(), FreeTrajectoryState::position(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by propagateWithPath().

                                                                                            {
  LogDebug("BeamHaloPropagator") << "going from: " << fts.position() << " to: " << plane.position() << "\n"
                                 << "and hence "
                                 << ((fts.position().z() * plane.position().z() < 0) ? "crossing" : "not crossing");
  return (fts.position().z() * plane.position().z() < 0);
}

directionCheck()

void BeamHaloPropagator::directionCheck ( PropagationDirection  dir )

private

Definition at line 31 of file BeamHaloPropagator.cc.

References anyDirection, DeadROC_duringRun::dir, getCrossTkPropagator(), getEndCapTkPropagator(), Propagator::propagationDirection(), Propagator::setPropagationDirection(), theCrossTkProp, and theEndCapTkProp.

Referenced by BeamHaloPropagator().

                                                                {
  //consistency check for direction
  if (getEndCapTkPropagator()->propagationDirection() != dir &&
      getEndCapTkPropagator()->propagationDirection() != anyDirection) {
    edm::LogError("BeamHaloPropagator") << "composite propagator set with inconsistent direction components\n"
                                        << "EndCap propagator is: " << getEndCapTkPropagator()->propagationDirection()
                                        << "\n to be set on: " << dir;
    theEndCapTkProp->setPropagationDirection(dir);
  }

  if (getCrossTkPropagator()->propagationDirection() != dir &&
      getCrossTkPropagator()->propagationDirection() != anyDirection) {
    edm::LogError("BeamHaloPropagator") << "composite propagator set with inconsistent direction components\n"
                                        << "Cross propagator is: " << getCrossTkPropagator()->propagationDirection()
                                        << "\n to be set on: " << dir;
    theCrossTkProp->setPropagationDirection(dir);
  }
}

getCrossTkPropagator()

const Propagator * BeamHaloPropagator::getCrossTkPropagator ( ) const

private

return the propagator used to cross the tracker

Definition at line 106 of file BeamHaloPropagator.cc.

References LogDebug, and theCrossTkProp.

Referenced by BeamHaloPropagator(), clone(), directionCheck(), and propagateWithPath().

                                                                 {
  LogDebug("BeamHaloPropagator") << "using the Crossing propagator";
  return theCrossTkProp;
}

getEndCapTkPropagator()

const Propagator * BeamHaloPropagator::getEndCapTkPropagator ( ) const

private

return the propagator used in endcaps

Definition at line 101 of file BeamHaloPropagator.cc.

References LogDebug, and theEndCapTkProp.

Referenced by BeamHaloPropagator(), clone(), directionCheck(), and propagateWithPath().

                                                                  {
  LogDebug("BeamHaloPropagator") << "using the EndCap propagator";
  return theEndCapTkProp;
}

magneticField()

const MagneticField* BeamHaloPropagator::magneticField ( ) const

inlineoverrideprivatevirtual

return the magneticField

Implements Propagator.

Definition at line 75 of file BeamHaloPropagator.h.

References theField.

Referenced by clone().

{ return theField; }

propagate() [1/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;
  }

propagate() [2/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 109 of file Propagator.h.

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

propagate() [3/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 112 of file Propagator.h.

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

propagate() [4/4]

virtual FreeTrajectoryState Propagator::propagate

inlinefinal

Definition at line 117 of file Propagator.h.

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

propagateWithPath() [1/11]

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() [2/11]

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

propagateWithPath() [3/11]

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

inline

Definition at line 86 of file Propagator.h.

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

propagateWithPath() [4/11]

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() [5/11]

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() [6/11]

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() [7/11]

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() [8/11]

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

inline

Definition at line 91 of file Propagator.h.

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

propagateWithPath() [9/11]

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

propagateWithPath() [10/11]

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

overrideprivatevirtual

Implements Propagator.

Definition at line 87 of file BeamHaloPropagator.cc.

References crossingTk(), getCrossTkPropagator(), getEndCapTkPropagator(), and Propagator::propagateWithPath().

                                                                                                            {
  if (crossingTk(fts, plane)) {
    return getCrossTkPropagator()->propagateWithPath(fts, plane);
  } else {
    return getEndCapTkPropagator()->propagateWithPath(fts, plane);
  }
}

propagateWithPath() [11/11]

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

overrideprivatevirtual

Implements Propagator.

Definition at line 96 of file BeamHaloPropagator.cc.

References getCrossTkPropagator(), and Propagator::propagateWithPath().

                                                                                                                  {
  return getCrossTkPropagator()->propagateWithPath(fts, cylinder);
}

setPropagationDirection()

void BeamHaloPropagator::setPropagationDirection ( PropagationDirection  dir )

inlineoverridevirtual

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 51 of file BeamHaloPropagator.h.

References DeadROC_duringRun::dir, Propagator::setPropagationDirection(), theCrossTkProp, and theEndCapTkProp.

                                                                  {
    Propagator::setPropagationDirection(dir);
    theEndCapTkProp->setPropagationDirection(dir);
    theCrossTkProp->setPropagationDirection(dir);
  }

Member Data Documentation

theCrossTkProp

Propagator* BeamHaloPropagator::theCrossTkProp

private

Definition at line 81 of file BeamHaloPropagator.h.

Referenced by BeamHaloPropagator(), directionCheck(), getCrossTkPropagator(), setPropagationDirection(), and ~BeamHaloPropagator().

theEndCapTkProp

Propagator* BeamHaloPropagator::theEndCapTkProp

private

Definition at line 80 of file BeamHaloPropagator.h.

Referenced by BeamHaloPropagator(), directionCheck(), getEndCapTkPropagator(), setPropagationDirection(), and ~BeamHaloPropagator().

theField

const MagneticField* BeamHaloPropagator::theField

private

Definition at line 82 of file BeamHaloPropagator.h.

Referenced by magneticField().