This class represents an ideal helix in perigee parameterization including the covariance matrix of the 5 perigee parameters. More...

#include <UncertainHelix.h>

Inheritance diagram for UncertainHelix:

[legend]

Collaboration diagram for UncertainHelix:

[legend]

Public Member Functions
	UncertainHelix ()
	Default constuctor initialising all members to zero.

	UncertainHelix (const ROOT::Math::XYZVector &position, const ROOT::Math::XYZVector &momentum, const short int charge, const double bZ, const TMatrixDSym &cartesianCovariance, const double pValue)
	Constructor initializing class with fit result. More...

	UncertainHelix (const double &d0, const double &phi0, const double &omega, const double &z0, const double &tanLambda, const TMatrixDSym &covariance, const double pValue)
	Constructor initializing class with perigee parameters. More...

TMatrixDSym	getCartesianCovariance (const double bZ_tesla=1.5) const
	Getter for the position and momentum covariance matrix. More...

double	getPValue () const
	Getter for Chi2 Probability of the track fit.

const TMatrixDSym &	getCovariance () const
	Getter for covariance matrix of perigee parameters in matrix form.

void	reverse ()
	Reverses the direction of travel of the helix in place. More...

double	passiveMoveBy (const ROOT::Math::XYZVector &by)
	Moves origin of the coordinate system (passive transformation) by the given vector. More...

double	passiveMoveBy (const double &byX, const double &byY, const double &byZ)
	Moves origin of the coordinate system (passive transformation) by the given vector. More...

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching). More...

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow). More...

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...

template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array. More...

template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object. More...

template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array. More...

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation. More...

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation. More...

template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation. More...

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array. More...

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array. More...

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array. More...

virtual std::string	getName () const
	Return a short name that describes this object, e.g. More...

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format. More...

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Getters for perigee helix parameters
double	getD0 () const
	Getter for d0, which is the signed distance to the perigee in the r-phi plane. More...

double	getPhi0 () const
	Getter for phi0, which is the azimuth angle of the transverse momentum at the perigee. More...

double	getCosPhi0 () const
	Getter for the cosine of the azimuth angle of travel direction at the perigee.

double	getSinPhi0 () const
	Getter for the cosine of the azimuth angle of travel direction at the perigee.

double	getOmega () const
	Getter for omega, which is a signed curvature measure of the track. More...

double	getZ0 () const
	Getter for z0, which is the z coordinate of the perigee.

double	getTanLambda () const
	Getter for tan lambda, which is the z over two dimensional arc length slope of the track.

double	getCotTheta () const
	Getter for cot theta, which is the z over two dimensional arc length slope of the track. More...

Protected Member Functions
void	calcArcLength2DAndDrAtXY (const double &x, const double &y, double &arcLength2D, double &dr) const
	Helper method to calculate the signed two dimensional arc length and the signed distance to the circle of a point in the xy projection. More...

double	calcArcLength2DAtDeltaCylindricalRAndDr (const double &deltaCylindricalR, const double &dr) const
	Helper method to calculate the two dimensional arc length from the perigee to a point at cylindrical radius, which also has the distance dr from the circle in the xy projection. More...

TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Static Protected Member Functions
static double	calcASinXDividedByX (const double &x)
	Implementation of the function asin(x) / x which handles small x values smoothly.

static double	calcATanXDividedByX (const double &x)
	Implementation of the function atan(x) / x which handles small x values smoothly.

static double	calcDerivativeOfATanXDividedByX (const double &x)
	Implementation of the function d / dx (atan(x) / x) which handles small x values smoothly.

Private Member Functions
	ClassDef (UncertainHelix, 2)
	represents an ideal helix in perigee parameterization including covariance matrix

void	setCartesian (const ROOT::Math::XYZVector &position, const ROOT::Math::XYZVector &momentum, const short int charge, const double bZ)
	Cartesian to Perigee conversion. More...

Private Attributes
TMatrixDSym	m_covariance
	5x5 covariance of the perigee parameters.

Double32_t	m_pValue
	Chi2 Probability of the fit.

Double32_t	m_d0
	Memory for the signed distance to the perigee. More...

Double32_t	m_phi0
	Memory for the azimuth angle between the transverse momentum and the x axis, which is in [-pi, pi].

Double32_t	m_omega
	Memory for the curvature of the signed curvature.

Double32_t	m_z0
	Memory for the z coordinate of the perigee.

Double32_t	m_tanLambda
	Memory for the slope of the track in the z coordinate over the two dimensional arc length (dz/ds)

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Getters for cartesian parameters of the perigee
double	getPerigeeX () const
	Calculates the x coordinate of the perigee point.

double	getPerigeeY () const
	Calculates the y coordinate of the perigee point.

double	getPerigeeZ () const
	Calculates the z coordinate of the perigee point.

ROOT::Math::XYZVector	getPerigee () const
	Getter for the perigee position.

double	getMomentumX (const double bZ) const
	Calculates the x momentum of the particle at the perigee point. More...

double	getMomentumY (const double bZ) const
	Calculates the y momentum of the particle at the perigee point. More...

double	getMomentumZ (const double bZ) const
	Calculates the z momentum of the particle at the perigee point. More...

ROOT::Math::XYZVector	getMomentum (const double bZ) const
	Getter for vector of momentum at the perigee position. More...

ROOT::Math::XYZVector	getDirection () const
	Getter for unit vector of momentum at the perigee position. More...

double	getTransverseMomentum (const double bZ) const
	Getter for the absolute value of the transverse momentum at the perigee. More...

double	getKappa (const double bZ) const
	Getter for kappa, which is charge / transverse momentum or equivalently omega * alpha.

short	getChargeSign () const
	Return track charge sign (1, 0 or -1).

static double	getAlpha (const double bZ)
	Calculates the alpha value for a given magnetic field in Tesla.

Simple extrapolations of the ideal helix
double	getArcLength2DAtCylindricalR (const double &cylindricalR) const
	Calculates the transverse travel distance at the point the helix first reaches the given cylindrical radius. More...

double	getArcLength2DAtXY (const double &x, const double &y) const
	Calculates the two dimensional arc length at which the circle in the xy projection is closest to the point. More...

double	getArcLength2DAtNormalPlane (const double &x, const double &y, const double &nX, const double &nY) const
	Calculates the arc length to reach a plane parallel to the z axes. More...

ROOT::Math::XYZVector	getPositionAtArcLength2D (const double &arcLength2D) const
	Calculates the position on the helix at the given two dimensional arc length. More...

ROOT::Math::XYZVector	getTangentialAtArcLength2D (const double &arcLength2D) const
	Calculates the tangential vector to the helix curve at the given two dimensional arc length. More...

ROOT::Math::XYZVector	getUnitTangentialAtArcLength2D (const double &arcLength2D) const
	Calculates the unit tangential vector to the helix curve at the given two dimensional arc length. More...

ROOT::Math::XYZVector	getMomentumAtArcLength2D (const double &arcLength2D, const double &bz) const
	Calculates the momentum vector at the given two dimensional arc length. More...

TMatrixD	calcPassiveMoveByJacobian (const ROOT::Math::XYZVector &by, const double expandBelowChi=M_PI/8) const
	Calculate the 5x5 jacobian matrix for the transport of the helix parameters, when moving the origin of the coordinate system to a new location. More...

void	calcPassiveMoveByJacobian (const double &byX, const double &byY, TMatrixD &jacobian, const double expandBelowChi=M_PI/8) const
	Calculate the jacobian matrix for the transport of the helix parameters, when moving the origin of the coordinate system to a new location. More...

double	calcArcLength2DFromSecantLength (const double &secantLength2D) const
	Helper function to calculate the two dimensional arc length from the length of a secant. More...

double	calcSecantLengthToArcLength2DFactor (const double &secantLength2D) const
	Helper function to calculate the factor between the dimensional secant length and the two dimensional arc length as seen in xy projection of the helix.

static double	reversePhi (const double &phi)
	Reverses an azimuthal angle to the opposite direction. More...

Detailed Description

This class represents an ideal helix in perigee parameterization including the covariance matrix of the 5 perigee parameters.

The used perigee parameters are:

- the signed distance from the origin to the perigee. The sign is positive (negative), if the angle from the xy perigee position vector to the transverse momentum vector is +pi/2 (-pi/2). has the same sign as getPerigee().Cross(getMomentum()).Z().
$\phi_0$ - the angle in the xy projection between the transverse momentum and the x axis, which is in [-pi, pi]
$\omega$ - the signed curvature of the track where the sign is given by the charge of the particle
- z coordinate of the perigee
$\tan \lambda$ - the slope of the track in the sz plane (dz/ds)

in that exact order.

It may also store a p-value obtained from the fit of the helix.

Definition at line 36 of file UncertainHelix.h.

Constructor & Destructor Documentation

◆ UncertainHelix() [1/2]

UncertainHelix	(	const ROOT::Math::XYZVector &	position,
		const ROOT::Math::XYZVector &	momentum,
		const short int	charge,
		const double	bZ,
		const TMatrixDSym &	cartesianCovariance,
		const double	pValue
	)

Constructor initializing class with fit result.

The given position, momentum and their covariance matrix are extrapolated to the perigee assuming a homogeneous magnetic field in the z direction.

Parameters

position	Position of the track at the perigee.
momentum	Momentum of the track at the perigee.
charge	Charge of the particle.
bZ	Magnetic field to be used for the calculation of the curvature;
cartesianCovariance	6x6 Covariance matrix for position and momentum of the track at the perigee.
pValue	p-value of the fit. It is assumed, that the B-field is parallel to the z-Axis.

Definition at line 24 of file UncertainHelix.cc.

                                                     :
   Helix(ROOT::Math::XYZVector(0.0, 0.0, position.Z()), momentum, charge, bZ),
   m_covariance(cartesianCovariance), // Initialize the covariance matrix to the 6x6 covariance and reduce it afterwards
   m_pValue(pValue)
 {
   // Maybe push these out of this function:
   // Indices of the cartesian coordinates
   const int iX = 0;
   const int iY = 1;
   const int iZ = 2;
   const int iPx = 3;
   const int iPy = 4;
   const int iPz = 5;
  
   // We initialised the m_covariance to the cartesian covariance and
   // reduce it now to the real 5x5 matrix that should be there.
  
   // 1. Rotate to a system where phi0 = 0
   TMatrixD jacobianRot(6, 6);
   jacobianRot.Zero();
  
   const double px = momentum.X();
   const double py = momentum.Y();
   const double pt = hypot(px, py);
   const double cosPhi0 = px / pt;
   const double sinPhi0 = py / pt;
  
   // Passive rotation matrix by phi0:
   jacobianRot(iX, iX) = cosPhi0;
   jacobianRot(iX, iY) = sinPhi0;
   jacobianRot(iY, iX) = -sinPhi0;
   jacobianRot(iY, iY) = cosPhi0;
   jacobianRot(iZ, iZ) = 1.0;
  
   jacobianRot(iPx, iPx) = cosPhi0;
   jacobianRot(iPx, iPy) = sinPhi0;
   jacobianRot(iPy, iPx) = -sinPhi0;
   jacobianRot(iPy, iPy) = cosPhi0;
   jacobianRot(iPz, iPz) = 1.0;
  
   m_covariance.Similarity(jacobianRot);
  
   // 2. Translate to perigee parameters on the position
   const double pz = momentum.Z();
   const double invPt = 1 / pt;
   const double invPtSquared = invPt * invPt;
   const double alpha = getAlpha(bZ);
  
   TMatrixD jacobianToHelixParameters(5, 6);
   jacobianToHelixParameters.Zero();
  
   jacobianToHelixParameters(iD0, iY) = -1;
   jacobianToHelixParameters(iPhi0, iX) = charge * invPt / alpha;
   jacobianToHelixParameters(iPhi0, iPy) = invPt;
   jacobianToHelixParameters(iOmega, iPx) = -charge * invPtSquared / alpha;
   jacobianToHelixParameters(iTanLambda, iPx) = - pz * invPtSquared;
   jacobianToHelixParameters(iTanLambda, iPz) = invPt;
   jacobianToHelixParameters(iZ0, iX) = - pz * invPt;
   jacobianToHelixParameters(iZ0, iZ) = 1;
   m_covariance.Similarity(jacobianToHelixParameters);
  
   // The covariance m_covariance is now the correct 5x5 covariance matrix.
   assert(m_covariance.GetNrows() == 5);
  
   // 3. Extrapolate to the origin.
   /* const double arcLength2D = */ passiveMoveBy(-position.X(), -position.Y(), 0.0);
 }

◆ UncertainHelix() [2/2]

UncertainHelix	(	const double &	d0,
		const double &	phi0,
		const double &	omega,
		const double &	z0,
		const double &	tanLambda,
		const TMatrixDSym &	covariance,
		const double	pValue
	)

Constructor initializing class with perigee parameters.

Parameters

d0	The signed distance from the origin to the perigee. The sign is positive (negative), if the angle from the xy perigee position vector to the transverse momentum vector is +pi/2 (-pi/2). d0 has the same sign as `getPosition().Cross(getMomentum()).Z()`.
phi0	The angle between the transverse momentum and the x axis and in [-pi, pi]
omega	The signed curvature of the track where the sign is given by the charge of the particle
z0	The z coordinate of the perigee.
tanLambda	The slope of the track in the sz plane (dz/ds)
covariance	5x5 Covariance matrix for the five helix parameters. Indices correspond to the order d0, phi0, omega, z0, tanLambda.
pValue	p-value of the Helix fit

Definition at line 98 of file UncertainHelix.cc.

Member Function Documentation

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

◆ calcArcLength2DAndDrAtXY()

void calcArcLength2DAndDrAtXY	(	const double &	x,
		const double &	y,
		double &	arcLength2D,
		double &	dr
	)		const

protectedinherited

Helper method to calculate the signed two dimensional arc length and the signed distance to the circle of a point in the xy projection.

This function is an implementation detail that prevents some code duplication.

Parameters

	x	X coordinate of the point to which to extrapolate
	y	Y coordinate of the point to which to extrapolate
[out]	arcLength2D	The two dimensional arc length from the perigee at which the closest approach is reached
[out]	dr	Signed distance of the point to circle in the xy projection.

Definition at line 545 of file Helix.cc.

◆ calcArcLength2DAtDeltaCylindricalRAndDr()

double calcArcLength2DAtDeltaCylindricalRAndDr	(	const double &	deltaCylindricalR,
		const double &	dr
	)		const

protectedinherited

Helper method to calculate the two dimensional arc length from the perigee to a point at cylindrical radius, which also has the distance dr from the circle in the xy projection.

This function is an implementation detail that prevents some code duplication.

Parameters

deltaCylindricalR	The absolute distance of the point in question to the perigee in the xy projection
dr	Signed distance of the point to circle in the xy projection.

Returns: The absolute two dimensional arc length from the perigee to the point.

Definition at line 581 of file Helix.cc.

◆ calcArcLength2DFromSecantLength()

double calcArcLength2DFromSecantLength ( const double & secantLength2D ) const

inherited

Helper function to calculate the two dimensional arc length from the length of a secant.

Translates the direct length between two point on the circle in the xy projection to the two dimensional arc length on the circle Behaves smoothly in the limit of vanishing curvature.

Definition at line 426 of file Helix.cc.

◆ calcPassiveMoveByJacobian() [1/2]

void calcPassiveMoveByJacobian	(	const double &	byX,
		const double &	byY,
		TMatrixD &	jacobian,
		const double	expandBelowChi = `M_PI / 8`
	)		const

inherited

Calculate the jacobian matrix for the transport of the helix parameters, when moving the origin of the coordinate system to a new location.

Does not update the helix parameters in any way.

The jacobian matrix is written into the output parameter 'jacobian'. If output parameter is a 5x5 matrix only the derivatives of the 5 helix parameters are written If output parameter is a 6x6 matrix the derivatives of the 5 helix parameters and derivates of the two dimensional arc length are written. The derivatives of the arcLength2D are in the 6th row of the matrix.

Parameters

	byX	X displacement by which the origin of the coordinate system should be moved.
	byY	Y displacement by which the origin of the coordinate system should be moved.
[out]	jacobian	The jacobian matrix containing the derivatives of the five helix parameters after the move relative the orignal parameters.
	expandBelowChi	Control parameter below, which absolute value of chi an expansion of divergent terms shall be used. This parameter exists for testing the consistency of the expansion with the closed form. In other applications the parameter should remain at its default value.

Definition at line 309 of file Helix.cc.

◆ calcPassiveMoveByJacobian() [2/2]

TMatrixD calcPassiveMoveByJacobian	(	const ROOT::Math::XYZVector &	by,
		const double	expandBelowChi = `M_PI / 8`
	)		const

inherited

Calculate the 5x5 jacobian matrix for the transport of the helix parameters, when moving the origin of the coordinate system to a new location.

Does not update the helix parameters in any way.

Parameters

by	Vector by which the origin of the coordinate system should be moved.
expandBelowChi	Control parameter below, which absolute value of chi an expansion of divergent terms shall be used. This parameter exists for testing the consistency of the expansion with the closed form. In other applications the parameter should remain at its default value.

Returns: The jacobian matrix containing the derivatives of the five helix parameters after the move relative the orignal parameters.

Definition at line 301 of file Helix.cc.

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

◆ getArcLength2DAtCylindricalR()

double getArcLength2DAtCylindricalR ( const double & cylindricalR ) const

inherited

Calculates the transverse travel distance at the point the helix first reaches the given cylindrical radius.

Gives the two dimensional arc length in the forward direction that is traversed until a certain cylindrical radius is reached. Returns NAN, if the cylindrical radius can not be reached, either because it is to far outside or inside of the perigee.

Forward the result to getPositionAtArcLength2D() or getMomentumAtArcLength2D() in order to extrapolate to the cylinder detector boundaries.

The result always has a positive sign. Hence it refers to the forward direction. Adding a minus sign yields the point at the same cylindrical radius but in the backward direction.

Parameters

cylindricalR The cylinder radius to extrapolate to.

Returns: The two dimensional arc length traversed to reach the cylindrical radius. NAN if it can not be reached.

Definition at line 128 of file Helix.cc.

◆ getArcLength2DAtNormalPlane()

double getArcLength2DAtNormalPlane	(	const double &	x,
		const double &	y,
		const double &	nX,
		const double &	nY
	)		const

inherited

Calculates the arc length to reach a plane parallel to the z axes.

If there is no intersection with the plane NAN is returned

Parameters

x	X coordinate of the support point of the plane
y	Y coordinate of the support point of the plane
nX	X coordinate of the normal vector of the plane
nY	Y coordinate of the normal vector of the plane

Returns: Shortest two dimensional arc length to the plane

Definition at line 149 of file Helix.cc.

◆ getArcLength2DAtXY()

double getArcLength2DAtXY	(	const double &	x,
		const double &	y
	)		const

inherited

Calculates the two dimensional arc length at which the circle in the xy projection is closest to the point.

This calculates the dimensional arc length to the closest approach in xy projection. Hence, it only optimizes the distance in x and y. This is sufficent to extrapolate to an axial wire. For stereo wires this is not optimal, since the distance in the z direction also plays a role.

Parameters

x	X coordinate of the point to which to extrapolate
y	Y coordinate of the point to which to extrapolate

Returns: The two dimensional arc length from the perigee at which the closest approach is reached

Definition at line 141 of file Helix.cc.

◆ getCartesianCovariance()

TMatrixDSym getCartesianCovariance ( const double bZ_tesla = 1.5 ) const

Getter for the position and momentum covariance matrix.

Note: Because the position and momentum covariance matrix is regenerated from a 5x5 perigee parameter covariance matrix there is necessarily a missing rank in the resulting matrix. The rank has to be filled by a convention essentially expressing, which points around the perigee are considered to be at s = 0. For backwards compatability with the original Belle experiment we apply the convention used there. See the Belle II note for more details.

Parameters

bZ_tesla Magnetic field to be used for the calculation from the curvature;

Rotate to the right phi0

Definition at line 113 of file UncertainHelix.cc.

◆ getCotTheta()

double getCotTheta ( ) const

inlineinherited

Getter for cot theta, which is the z over two dimensional arc length slope of the track.

Synomym to tan lambda.

Definition at line 396 of file Helix.h.

◆ getD0()

double getD0 ( ) const

inlineinherited

Getter for d0, which is the signed distance to the perigee in the r-phi plane.

The signed distance from the origin to the perigee. The sign is positive (negative), if the angle from the xy perigee position vector to the transverse momentum vector is +pi/2 (-pi/2). d0 has the same sign as getPerigee().Cross(getMomentum()).Z().

Definition at line 372 of file Helix.h.

◆ getDirection()

ROOT::Math::XYZVector getDirection ( ) const

inherited

Getter for unit vector of momentum at the perigee position.

This is mainly useful cases where curvature is zero (pT is infinite)

Definition at line 94 of file Helix.cc.

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also: Particle::getInfoHTML() for a more complex example.; HTML for some utility functions.; Use getInfo() to get a raw text version of this output.

Reimplemented in TRGSummary, TrackFitResult, Track, SoftwareTriggerResult, PIDLikelihood, MCParticle, Cluster, and Particle.

Definition at line 362 of file RelationsObject.h.

◆ getMomentum()

ROOT::Math::XYZVector getMomentum ( const double bZ ) const

inherited

Getter for vector of momentum at the perigee position.

As we calculate recalculate the momentum from a geometric helix, we need an estimate of the magnetic field along the z-axis to give back the momentum.

Parameters

bZ	Magnetic field at the perigee.

Definition at line 89 of file Helix.cc.

◆ getMomentumAtArcLength2D()

ROOT::Math::XYZVector getMomentumAtArcLength2D	(	const double &	arcLength2D,
		const double &	bz
	)		const

inherited

Calculates the momentum vector at the given two dimensional arc length.

Parameters

arcLength2D	Two dimensional arc length to be traversed.
bz	Magnetic field strength in the z direction.

Definition at line 270 of file Helix.cc.

◆ getMomentumX()

double getMomentumX ( const double bZ ) const

inherited

Calculates the x momentum of the particle at the perigee point.

Parameters

bZ	Z component of the magnetic field in Tesla

Definition at line 74 of file Helix.cc.

◆ getMomentumY()

double getMomentumY ( const double bZ ) const

inherited

Calculates the y momentum of the particle at the perigee point.

Parameters

bZ	Z component of the magnetic field in Tesla

Definition at line 79 of file Helix.cc.

◆ getMomentumZ()

double getMomentumZ ( const double bZ ) const

inherited

Calculates the z momentum of the particle at the perigee point.

Parameters

bZ	Z component of the magnetic field in Tesla

Definition at line 84 of file Helix.cc.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ getOmega()

double getOmega ( ) const

inlineinherited

Getter for omega, which is a signed curvature measure of the track.

The sign is equivalent to the charge of the particle.

Definition at line 387 of file Helix.h.

◆ getPhi0()

double getPhi0 ( ) const

inlineinherited

Getter for phi0, which is the azimuth angle of the transverse momentum at the perigee.

getMomentum().Phi() == getPhi0() holds.

Definition at line 378 of file Helix.h.

◆ getPositionAtArcLength2D()

ROOT::Math::XYZVector getPositionAtArcLength2D ( const double & arcLength2D ) const

inherited

Calculates the position on the helix at the given two dimensional arc length.

Parameters

arcLength2D Two dimensional arc length to be traversed.

Definition at line 201 of file Helix.cc.

◆ getRelated()

T* getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

◆ getRelatedFrom()

FROM* getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

◆ getRelatedFromWithWeight()

std::pair<FROM*, float> getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

◆ getRelatedTo()

TO* getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

◆ getRelatedToWithWeight()

std::pair<TO*, float> getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

◆ getRelatedWithWeight()

std::pair<T*, float> getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

◆ getRelationsFrom()

RelationVector<FROM> getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

◆ getRelationsTo()

RelationVector<TO> getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

◆ getRelationsWith()

RelationVector<T> getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

◆ getTangentialAtArcLength2D()

ROOT::Math::XYZVector getTangentialAtArcLength2D ( const double & arcLength2D ) const

inherited

Calculates the tangential vector to the helix curve at the given two dimensional arc length.

The tangential vector is the derivative of the position with respect to the two dimensional arc length It is normalised such that the cylindrical radius of the result is 1

getTangentialAtArcLength2D(arcLength2D).Perp() == 1 holds.

Parameters

arcLength2D Two dimensional arc length to be traversed.

Returns: Tangential vector normalised to unit transverse component / cylindrical radius.

Definition at line 245 of file Helix.cc.

◆ getTransverseMomentum()

double getTransverseMomentum ( const double bZ ) const

inherited

Getter for the absolute value of the transverse momentum at the perigee.

Parameters

bZ	Magnetic field at the perigee

Definition at line 99 of file Helix.cc.

◆ getUnitTangentialAtArcLength2D()

ROOT::Math::XYZVector getUnitTangentialAtArcLength2D ( const double & arcLength2D ) const

inherited

Calculates the unit tangential vector to the helix curve at the given two dimensional arc length.

Parameters

arcLength2D Two dimensional arc length to be traversed.

Definition at line 261 of file Helix.cc.

◆ passiveMoveBy() [1/2]

double passiveMoveBy	(	const double &	byX,
		const double &	byY,
		const double &	byZ
	)

Moves origin of the coordinate system (passive transformation) by the given vector.

Updates the helix inplace.

Parameters

byX	X displacement by which the origin of the coordinate system should be moved.
byY	Y displacement by which the origin of the coordinate system should be moved.
byZ	Z displacement by which the origin of the coordinate system should be moved.

Returns: The double value is the two dimensional arc length, which has the be traversed from the old perigee to the new.

Definition at line 198 of file UncertainHelix.cc.

◆ passiveMoveBy() [2/2]

double passiveMoveBy ( const ROOT::Math::XYZVector & by )

inline

Moves origin of the coordinate system (passive transformation) by the given vector.

Updates the helix inplace.

Parameters

by	Vector by which the origin of the coordinate system should be moved.

Returns: The double value is the two dimensional arc length, which has the be traversed from the old perigee to the new.

Definition at line 117 of file UncertainHelix.h.

118 { return passiveMoveBy(by.X(), by.Y(), by.Z()); }

◆ reverse()

void reverse ( )

Reverses the direction of travel of the helix in place.

The same points that are located on the helix stay are the same after the transformation, but have the opposite two dimensional arc length associated to them. The momentum at each point is reversed. The charge sign is changed to its opposite by this transformation.

Definition at line 182 of file UncertainHelix.cc.

◆ reversePhi()

double reversePhi ( const double & phi )

staticinherited

Reverses an azimuthal angle to the opposite direction.

Parameters

phi	A angle in [-pi, pi]

Returns: The angle for the opposite direction in [-pi, pi]

Definition at line 421 of file Helix.cc.

◆ setCartesian()

void setCartesian	(	const ROOT::Math::XYZVector &	position,
		const ROOT::Math::XYZVector &	momentum,
		const short int	charge,
		const double	bZ
	)

privateinherited

Cartesian to Perigee conversion.

Definition at line 588 of file Helix.cc.

Member Data Documentation

◆ m_d0

Double32_t m_d0

privateinherited

Memory for the signed distance to the perigee.

The sign is the same as of the z component of getPerigee().Cross(getMomentum()).

Definition at line 414 of file Helix.h.

The documentation for this class was generated from the following files:

framework/dataobjects/include/UncertainHelix.h
framework/dataobjects/src/UncertainHelix.cc

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Getters for cartesian parameters of the perigee

Simple extrapolations of the ideal helix

Detailed Description

Constructor & Destructor Documentation

◆ UncertainHelix() [1/2]

◆ UncertainHelix() [2/2]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ calcArcLength2DAndDrAtXY()

◆ calcArcLength2DAtDeltaCylindricalRAndDr()

◆ calcArcLength2DFromSecantLength()

◆ calcPassiveMoveByJacobian() [1/2]

◆ calcPassiveMoveByJacobian() [2/2]

◆ copyRelations()

◆ getArcLength2DAtCylindricalR()

◆ getArcLength2DAtNormalPlane()

◆ getArcLength2DAtXY()

◆ getCartesianCovariance()

◆ getCotTheta()

◆ getD0()

◆ getDirection()

◆ getInfo()

◆ getInfoHTML()

◆ getMomentum()

◆ getMomentumAtArcLength2D()

◆ getMomentumX()

◆ getMomentumY()

◆ getMomentumZ()

◆ getName()

◆ getOmega()

◆ getPhi0()

◆ getPositionAtArcLength2D()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTangentialAtArcLength2D()

◆ getTransverseMomentum()

◆ getUnitTangentialAtArcLength2D()

◆ passiveMoveBy() [1/2]

◆ passiveMoveBy() [2/2]

◆ reverse()

◆ reversePhi()

◆ setCartesian()

Member Data Documentation

◆ m_d0