#include <ParticlePropagator.h>

Inheritance diagram for ParticlePropagator:

Public Member Functions
double	fieldMap (double x, double y, double z)

double	fieldMap (const TrackerLayer &layer, double coord, int success)

void	initProperDecayTime ()

const HepPDT::ParticleDataTable *	particleDataTable () const

	ParticlePropagator ()
	Default c'tor. More...

	ParticlePropagator (const RawParticle &myPart, double R, double Z, const MagneticFieldMap aFieldMap, const RandomEngineAndDistribution engine, const HepPDT::ParticleDataTable *table)

	ParticlePropagator (const RawParticle &myPart, const MagneticFieldMap aFieldMap, const RandomEngineAndDistribution engine, const HepPDT::ParticleDataTable *table)

	ParticlePropagator (const XYZTLorentzVector &p, const XYZTLorentzVector &v, float q, const MagneticFieldMap aFieldMap, const HepPDT::ParticleDataTable table)

	ParticlePropagator (const XYZTLorentzVector &p, const XYZVector &v, float q, const MagneticFieldMap aFieldMap, const HepPDT::ParticleDataTable table)

	ParticlePropagator (const FSimTrack &simTrack, const MagneticFieldMap aFieldMap, const RandomEngineAndDistribution engine, const HepPDT::ParticleDataTable *table)

	ParticlePropagator (const ParticlePropagator &myPropPart)

	ParticlePropagator (const BaseParticlePropagator &myPropPart, const MagneticFieldMap aFieldMap, const HepPDT::ParticleDataTable table)

ParticlePropagator	propagated () const

bool	propagateToBoundSurface (const TrackerLayer &)

bool	propagateToClosestApproach (double x0=0., double y0=0., bool first=true)

bool	propagateToNominalVertex (const XYZTLorentzVector &hit2=XYZTLorentzVector(0., 0., 0., 0.))

void	setPropagationConditions (const TrackerLayer &, bool firstLoop=true)

Public Member Functions inherited from BaseParticlePropagator
bool	backPropagate ()

	BaseParticlePropagator ()
	Default c'tor. More...

	BaseParticlePropagator (const RawParticle &myPart, double r, double z, double B)

	BaseParticlePropagator (const RawParticle &myPart, double r, double z, double B, double t)

double	getMagneticField () const
	Get the magnetic field. More...

int	getSuccess () const
	Has propagation been performed and was barrel or endcap reached ? More...

bool	hasDecayed () const
	Has the particle decayed while propagated ? More...

double	helixCentreDistToAxis () const
	The distance between the cylinder and the helix axes. More...

double	helixCentreDistToAxis (double xC, double yC) const

double	helixCentrePhi () const
	The azimuth if the vector joining the cylinder and the helix axes. More...

double	helixCentrePhi (double xC, double yC) const

double	helixCentreX () const
	The x coordinate of the helix axis. More...

double	helixCentreX (double radius, double phi) const

double	helixCentreY () const
	The y coordinate of the helix axis. More...

double	helixCentreY (double radius, double phi) const

double	helixRadius () const
	The helix Radius. More...

double	helixRadius (double pT) const

double	helixStartPhi () const
	The azimuth of the momentum at the vertex. More...

void	increaseRCyl (double delta)
	Just an internal trick. More...

void	init ()
	Initialize internal switches and quantities. More...

bool	inside () const
	Is the vertex inside the cylinder ? (stricly inside : true) More...

bool	inside (double rPos2) const

bool	onBarrel () const
	Is the vertex already on the cylinder barrel ? More...

bool	onBarrel (double rPos2) const

bool	onEndcap () const
	Is the vertex already on the cylinder endcap ? More...

bool	onEndcap (double rPos2) const

bool	onFiducial () const
	Is the vertex on some material ? More...

bool	onSurface () const
	Is the vertex already on the cylinder surface ? More...

bool	onSurface (double rPos2) const

RawParticle const &	particle () const
	The particle being propagated. More...

RawParticle &	particle ()

bool	propagate ()

BaseParticlePropagator	propagated () const

bool	propagateToBeamCylinder (const XYZTLorentzVector &v, double radius=0.)

bool	propagateToClosestApproach (double x0=0., double y0=0, bool first=true)

bool	propagateToEcal (bool first=true)

bool	propagateToEcalEntrance (bool first=true)

bool	propagateToHcalEntrance (bool first=true)

bool	propagateToHcalExit (bool first=true)

bool	propagateToHOLayer (bool first=true)

bool	propagateToNominalVertex (const XYZTLorentzVector &hit2=XYZTLorentzVector(0., 0., 0., 0.))

bool	propagateToPreshowerLayer1 (bool first=true)

bool	propagateToPreshowerLayer2 (bool first=true)

bool	propagateToVFcalEntrance (bool first=true)

void	resetDebug ()

void	setDebug ()
	Set the debug leve;. More...

void	setMagneticField (double b)
	Set the magnetic field. More...

void	setParticle (RawParticle const &iParticle)

void	setPropagationConditions (double r, double z, bool firstLoop=true)
	Set the propagation characteristics (rCyl, zCyl and first loop only) More...

void	setProperDecayTime (double t)
	Set the proper decay time. More...

double	xyImpactParameter (double x0=0., double y0=0.) const
	Transverse impact parameter. More...

double	zImpactParameter (double x0=0, double y0=0.) const
	Longitudinal impact parameter. More...

Private Attributes
const RandomEngineAndDistribution *	random

const MagneticFieldMap *	theFieldMap

const HepPDT::ParticleDataTable *	theTable = 0

Additional Inherited Members
Protected Member Functions inherited from BaseParticlePropagator
double	c_light () const
	The speed of light in mm/ns (!) without clhep (yeaaahhh!) More...

Protected Attributes inherited from BaseParticlePropagator
bool	fiducial
	The particle traverses some real material. More...

int	success
	0:propagation still be done, 1:reached 'barrel', 2:reached 'endcaps' More...

Detailed Description

Definition at line 28 of file ParticlePropagator.h.

Constructor & Destructor Documentation

ParticlePropagator::ParticlePropagator ( )

Default c'tor.

Definition at line 15 of file ParticlePropagator.cc.

Referenced by propagated().

15 :

16 BaseParticlePropagator(), random(nullptr) {;}

BaseParticlePropagator::BaseParticlePropagator

BaseParticlePropagator()

Default c'tor.

Definition: BaseParticlePropagator.cc:5

ParticlePropagator::random

const RandomEngineAndDistribution * random

Definition: ParticlePropagator.h:105

ParticlePropagator::ParticlePropagator	(	const RawParticle &	myPart,
		double	R,
		double	Z,
		const MagneticFieldMap *	aFieldMap,
		const RandomEngineAndDistribution *	engine,
		const HepPDT::ParticleDataTable *	table
	)

Constructor taking as arguments a RawParticle, as well as the radius, half-height and magnetic field defining the cylinder for which propagation is to be performed

Definition at line 18 of file ParticlePropagator.cc.

References fieldMap(), initProperDecayTime(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), X, DOFs::Y, and DOFs::Z.

                                                                              :
   BaseParticlePropagator(myPart,RCyl,ZCyl,0.),
   theFieldMap(aFieldMap),
   random(engine),
   theTable(table)
 {
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
   initProperDecayTime();
 }

ParticlePropagator::ParticlePropagator	(	const RawParticle &	myPart,
		const MagneticFieldMap *	aFieldMap,
		const RandomEngineAndDistribution *	engine,
		const HepPDT::ParticleDataTable *	table
	)

Constructor with only a RawParticle as argument for subsequent propagation to known surfaces (ECAL, HCAL ...)

Definition at line 32 of file ParticlePropagator.cc.

References fieldMap(), initProperDecayTime(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), X, DOFs::Y, and DOFs::Z.

                                                                               :
   BaseParticlePropagator(myPart,0.,0.,0.),
   theFieldMap(aFieldMap),
   random(engine),
   theTable(table)
  
 {
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
   initProperDecayTime();
 }

ParticlePropagator::ParticlePropagator	(	const XYZTLorentzVector &	p,
		const XYZTLorentzVector &	v,
		float	q,
		const MagneticFieldMap *	aFieldMap,
		const HepPDT::ParticleDataTable *	table
	)

Constructor with two LorentzVector (momentum and vertex (in cm)) and an electric charge propagation to known surfaces (ECAL, HCAL ...)

Definition at line 46 of file ParticlePropagator.cc.

References fieldMap(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), X, DOFs::Y, and DOFs::Z.

                                                                              :
   BaseParticlePropagator(RawParticle(mom,vert,q),0.,0.,0.),
   theFieldMap(aFieldMap),
   random(nullptr),
   theTable(table)
 {
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
 }

ParticlePropagator::ParticlePropagator	(	const XYZTLorentzVector &	p,
		const XYZVector &	v,
		float	q,
		const MagneticFieldMap *	aFieldMap,
		const HepPDT::ParticleDataTable *	table
	)

Constructor with a LorentzVector (momentum), a Hep3Vector (vertex in cm) and an electric charge propagation to known surfaces (ECAL, HCAL ...)

Definition at line 58 of file ParticlePropagator.cc.

References fieldMap(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), X, DOFs::Y, and DOFs::Z.

                                                                              :
   BaseParticlePropagator(
   RawParticle(mom,XYZTLorentzVector(vert.X(),vert.Y(),vert.Z(),0.0), q),0.,0.,0.),
   theFieldMap(aFieldMap),
   random(nullptr),
   theTable(table)
 {
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
 }

ParticlePropagator::ParticlePropagator	(	const FSimTrack &	simTrack,
		const MagneticFieldMap *	aFieldMap,
		const RandomEngineAndDistribution *	engine,
		const HepPDT::ParticleDataTable *	table
	)

Constructor with a FSimTrack from the FSimEvent

Definition at line 71 of file ParticlePropagator.cc.

References FSimTrack::decayTime(), fieldMap(), initProperDecayTime(), FSimTrack::nDaughters(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), BaseParticlePropagator::setProperDecayTime(), X, DOFs::Y, and DOFs::Z.

                                                                              :
   BaseParticlePropagator(makeParticle(table,
                                       simTrack.type(),
                                       simTrack.momentum(),
                                       simTrack.vertex().position()),
              0.,0.,0.),
   theFieldMap(aFieldMap),
   random(engine),
   theTable(table)
 {
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
   if ( simTrack.decayTime() < 0. ) { 
     if ( simTrack.nDaughters() ) 
       // This particle already decayed, don't decay it twice
       this->setProperDecayTime(1E99);
     else
       // This particle hasn't decayed yet. Decay time according to particle lifetime
       initProperDecayTime();
   } else {
     // Decay time pre-defined at generator level 
     this->setProperDecayTime(simTrack.decayTime());
   }
 }

ParticlePropagator::ParticlePropagator ( const ParticlePropagator & myPropPart )

Constructor with a (Base)ParticlePropagator

Definition at line 98 of file ParticlePropagator.cc.

                                                                            :
   BaseParticlePropagator(myPropPart),
   theFieldMap(myPropPart.theFieldMap)
 {  
   //  setMagneticField(fieldMap(x(),y(),z()));
 }

ParticlePropagator::ParticlePropagator	(	const BaseParticlePropagator &	myPropPart,
		const MagneticFieldMap *	aFieldMap,
		const HepPDT::ParticleDataTable *	table
	)

Definition at line 105 of file ParticlePropagator.cc.

References fieldMap(), BaseParticlePropagator::particle(), BaseParticlePropagator::setMagneticField(), X, DOFs::Y, and DOFs::Z.

                                                                              :
   BaseParticlePropagator(myPropPart),
   theFieldMap(aFieldMap),
   theTable(table)
 {  
   setMagneticField(fieldMap(particle().X(),particle().Y(),particle().Z()));
 }

Member Function Documentation

double ParticlePropagator::fieldMap	(	double	x,
		double	y,
		double	z
	)

The fieldMap given by the detector geormetry

Definition at line 148 of file ParticlePropagator.cc.

References RawParticle::charge(), MagneticFieldMap::inTeslaZ(), BaseParticlePropagator::particle(), and theFieldMap.

Referenced by ParticlePropagator(), propagateToBoundSurface(), propagateToClosestApproach(), and propagateToNominalVertex().

                                                            {
   // Arguments now passed in cm.
   //  return MagneticFieldMap::instance()->inTesla(GlobalPoint(xx/10.,yy/10.,zz/10.)).z();
   // Return a dummy value for neutral particles!
   return particle().charge() == 0.0 || theFieldMap == nullptr ? 
     4. : theFieldMap->inTeslaZ(GlobalPoint(xx,yy,zz));
 }

double ParticlePropagator::fieldMap	(	const TrackerLayer &	layer,
		double	coord,
		int	success
	)

Definition at line 157 of file ParticlePropagator.cc.

References RawParticle::charge(), MagneticFieldMap::inTeslaZ(), BaseParticlePropagator::particle(), and theFieldMap.

                                                                                  {
   // Arguments now passed in cm.
   //  return MagneticFieldMap::instance()->inTesla(GlobalPoint(xx/10.,yy/10.,zz/10.)).z();
   // Return a dummy value for neutral particles!
   return particle().charge() == 0.0 || theFieldMap == nullptr ? 
     4. : theFieldMap->inTeslaZ(layer,coord,success);
 }

void ParticlePropagator::initProperDecayTime ( )

Initialize the proper decay time of the particle

Definition at line 117 of file ParticlePropagator.cc.

References funct::abs(), pdg::cTau(), RandomEngineAndDistribution::flatShoot(), cmsBatch::log, BaseParticlePropagator::particle(), sysUtil::pid, RawParticle::pid(), BaseParticlePropagator::properDecayTime, random, BaseParticlePropagator::setProperDecayTime(), and theTable.

Referenced by ParticlePropagator().

                                         {
 
   // And this is the proper time at which the particle will decay
   double properDecayTime = 
     (particle().pid()==0||particle().pid()==22||abs(particle().pid())==11||abs(particle().pid())==2112||abs(particle().pid())==2212||
      !random) ?
     1E99 : -pdg::cTau(particle().pid(), theTable) * std::log(random->flatShoot());
 
   this->setProperDecayTime(properDecayTime);
 
 }

const HepPDT::ParticleDataTable* ParticlePropagator::particleDataTable ( ) const

inline

Definition at line 101 of file ParticlePropagator.h.

References theTable.

Referenced by PairProductionSimulator::compute(), BremsstrahlungSimulator::compute(), NuclearInteractionSimulator::compute(), MuonBremsstrahlungSimulator::compute(), PythiaDecays::particleDaughters(), and NuclearInteractionFTFSimulator::saveDaughter().

101 { return theTable; }

ParticlePropagator::theTable

const HepPDT::ParticleDataTable * theTable

Definition: ParticlePropagator.h:106

ParticlePropagator ParticlePropagator::propagated ( ) const

Return a new instance, corresponding to the particle propagated to the surface of the cylinder

Definition at line 143 of file ParticlePropagator.cc.

References ParticlePropagator(), BaseParticlePropagator::propagated(), theFieldMap, and theTable.

                                      {
   return ParticlePropagator(BaseParticlePropagator::propagated(),theFieldMap,theTable);
 }

bool ParticlePropagator::propagateToBoundSurface ( const TrackerLayer & layer )

Definition at line 166 of file ParticlePropagator.cc.

References TrackerLayer::disk(), TrackerLayer::diskInnerRadius(), BaseParticlePropagator::fiducial, fieldMap(), BaseParticlePropagator::hasDecayed(), BaseParticlePropagator::particle(), BaseParticlePropagator::propagate(), alignCSCRings::r, BaseParticlePropagator::setMagneticField(), BaseParticlePropagator::success, and z.

Referenced by TrajectoryManager::propagateToLayer().

                                                                      {
 
 
   fiducial = true;
   BoundDisk const* disk = layer.disk();
   //  bool disk = layer.forward();
   //  double innerradius=-999;
   double innerradius = disk ? layer.diskInnerRadius() : -999. ;
 
   //  if( disk ) {
     //    const Surface& surface = layer.surface();
     //    const BoundDisk & myDisk = dynamic_cast<const BoundDisk&>(surface);
     //    innerradius=myDisk.innerRadius();   
   //    innerradius=myDisk->innerRadius();    
   //  }
 
   bool done = propagate();
 
   // Set the magnetic field at the new location (if succesfully propagated)
   if ( done && !hasDecayed() ) { 
     if ( success == 2 ) 
       setMagneticField(fieldMap(layer,particle().r(),success));
     else if ( success == 1 )
       setMagneticField(fieldMap(layer,particle().z(),success));
   } 
        
   // There is some real material here
   fiducial = !(!disk &&  success!=1) &&
     !( disk && (success!=2  || particle().r()<innerradius));
 
   return done;
 }

bool ParticlePropagator::propagateToClosestApproach	(	double	x0 = `0.`,
		double	y0 = `0.`,
		bool	first = `true`
	)

Update the particle after propagation to the closest approach from Z axis, to the preshower layer 1 & 2, to the ECAL entrance, to the HCAL entrance, the HCAL 2nd and 3rd layer (not coded yet), the VFCAL entrance, or any BoundSurface(disk or cylinder)

Definition at line 131 of file ParticlePropagator.cc.

References fieldMap(), BaseParticlePropagator::propagateToClosestApproach(), and BaseParticlePropagator::setMagneticField().

                                                                                {
   setMagneticField(fieldMap(0.,0.,0.));
   return BaseParticlePropagator::propagateToClosestApproach(x0,y0,first);
 }

bool ParticlePropagator::propagateToNominalVertex ( const XYZTLorentzVector & hit2 = XYZTLorentzVector(0.,0.,0.,0.) )

Definition at line 137 of file ParticlePropagator.cc.

References fieldMap(), BaseParticlePropagator::propagateToNominalVertex(), and BaseParticlePropagator::setMagneticField().

                                                                        {
   setMagneticField(fieldMap(0.,0.,0.));
   return BaseParticlePropagator::propagateToNominalVertex(v);
 }

void ParticlePropagator::setPropagationConditions	(	const TrackerLayer &	layer,
		bool	firstLoop = `true`
	)

Definition at line 200 of file ParticlePropagator.cc.

References TrackerLayer::cylinder(), TrackerLayer::disk(), TrackerLayer::diskOuterRadius(), BaseParticlePropagator::firstLoop, TrackerLayer::forward(), and BaseParticlePropagator::setPropagationConditions().

Referenced by ConvBremSeedProducer::produce(), and TrajectoryManager::propagateToLayer().

                                          { 
   // Set the magentic field
   // setMagneticField(fieldMap(x(),y(),z()));
 
   // Set R and Z according to the Tracker Layer characteristics.
   //  const Surface& surface = layer.surface();
 
   if( layer.forward() ) {
 
     //    const BoundDisk & myDisk = dynamic_cast<const BoundDisk&>(surface);
     // ParticlePropagator works in mm, whereas the detector geometry is in cm
     BaseParticlePropagator::setPropagationConditions(
                                   layer.diskOuterRadius(),
                   fabs(layer.disk()->position().z()),
                   firstLoop);       
 
   // ... or if it is a cylinder barrel 
   } else {
 
     //    const BoundCylinder & myCylinder = dynamic_cast<const BoundCylinder &>(surface);
     // ParticlePropagator works now in cm
     BaseParticlePropagator::setPropagationConditions(
                      layer.cylinder()->bounds().width()/2.,
                      layer.cylinder()->bounds().length()/2.,
                      firstLoop);
   }
 
 }