xAOD::TrackParticle_v1 Class Reference

Class describing a TrackParticle. More...

#include <TrackParticle_v1.h>

Inheritance diagram for xAOD::TrackParticle_v1:

Collaboration diagram for xAOD::TrackParticle_v1:

Public Member Functions
	TrackParticle_v1 ()
	Default constructor.
	~TrackParticle_v1 ()
	Destructor.
	TrackParticle_v1 (const TrackParticle_v1 &o)
	Copy ctor. This involves copying the entire Auxilary store, and is a slow operation which should be used sparingly.
TrackParticle_v1 &	operator= (const TrackParticle_v1 &tp)
	Assignment operator. This can involve creating and copying an Auxilary store, and so should be used sparingly.
bool	summaryValue (uint8_t &value, const SummaryType &information) const
	Accessor for TrackSummary values.
bool	summaryValue (float &value, const SummaryType &information) const
	Accessor for TrackSummary values.
void	setSummaryValue (uint8_t &value, const SummaryType &information)
	Set method for TrackSummary values.
void	setSummaryValue (float &value, const SummaryType &information)
	Set method for TrackSummary values.
void	resetCache ()
	Reset the internal cache of the object.

Private Types
using	covMatrixIndex = TrackingDetails::covMatrixIndex
typedef std::vector< std::pair< covMatrixIndex, covMatrixIndex > >	covMatrixIndexPairVec

Static Private Member Functions
static const covMatrixIndexPairVec &	covMatrixComprIndexPairs ()

Private Attributes
CxxUtils::CachedValue< Trk::Perigee >	m_perigeeParameters
	Cached MeasuredPerigee, built from this object.

Static Private Attributes
static const std::size_t	COVMATRIX_OFFDIAG_VEC_COMPR_SIZE = TrackingDetails::COVMATRIX_OFFDIAG_VEC_COMPR_SIZE

IParticle functions
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for TrackParticle.
virtual double	pt () const override final
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const override final
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const override final
	The azimuthal angle ( \(\phi\)) of the particle (has range \(-\pi\) to \(+\pi\).).
virtual double	m () const override final
	The invariant mass of the particle..
virtual double	e () const override final
	The total energy of the particle.
virtual double	rapidity () const override final
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const override final
	The full 4-momentum of the particle.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector form.
virtual Type::ObjectType	type () const override final
	The type of the object as a simple enumeration.

Defining parameters functions
The 'defining parameters' are key to the concept of a TrackParticle, and give the values for the IParticle interface ( pt(), phi(), eta() etc.). They use the Trk::Perigee coordinate system, and are defined as: \(( d_0, z_0, \phi, \theta, q/p )\). The parameters are expressed with respect to an origin (returned by vx(), vy() and vy() ), currently intended to be the 'beamspot'. This origin is expected to be the same for all track particles in a collection (and this may be be enforced). The \(\phi\) parameter is returned by either the phi() or the phi0() methods, the difference just being whether it is returned as a float or a double (it is stored as a float)
float	charge () const
	Returns the charge.
float	d0 () const
	Returns the \(d_0\) parameter.
float	z0 () const
	Returns the \(z_0\) parameter.
float	phi0 () const
	Returns the \(\phi\) parameter, which has range \(-\pi\) to \(+\pi\).
float	theta () const
	Returns the \(\theta\) parameter, which has range 0 to \(\pi\).
float	qOverP () const
	Returns the \(q/p\) parameter.
float	time () const
	Returns the time.
float	timeResolution () const
	Returns the time resolution.
uint8_t	hasValidTime () const
	Returns whether or not the track has a valid time.
DefiningParameters_t	definingParameters () const
	Returns a SVector of the Perigee track parameters.
const ParametersCovMatrix_t	definingParametersCovMatrix () const
	Returns the 5x5 symmetric matrix containing the defining parameters covariance matrix.
ParametersCovMatrixFilled_t	definingParametersCovMatrixFilled () const
	Returns a 5x5 matrix describing which elements of the covariance matrix are known.
const std::vector< float > &	definingParametersCovMatrixDiagVec () const
	Returns the diagonal elements of the defining parameters covariance matrix.
const std::vector< float > &	definingParametersCovMatrixOffDiagVec () const
	Returns the correlation coefficient associated with the off-diagonal elements of the covariance matrix = cov(X,Y)/sqrt(cov(X,X)*cov(Y,Y)).
std::vector< float >	definingParametersCovMatrixVec () const
	Returns the length 6 vector containing the elements of defining parameters covariance matrix.
bool	definingParametersCovMatrixOffDiagCompr () const
void	setDefiningParameters (float d0, float z0, float phi0, float theta, float qOverP)
	Set the defining parameters.
void	setDefiningParameters (float d0, float z0, float phi0, float theta, float qOverP, float time)
void	setTime (float time)
void	setTimeResolution (float timeResolution)
void	setHasValidTime (uint8_t hasValidTime)
void	setDefiningParametersCovMatrix (const ParametersCovMatrix_t &cov)
	Set the defining parameters covariance matrix.
void	setDefiningParametersCovMatrixDiagVec (const std::vector< float > &vec)
	Set the defining parameters covariance matrix using a length 15 vector.
void	setDefiningParametersCovMatrixOffDiagVec (const std::vector< float > &vec)
	Set the off-diagonal elements of the defining parameters covariance matrix.
void	setDefiningParametersCovMatrixVec (const std::vector< float > &cov)
void	compressDefiningParametersCovMatrixOffDiag ()
	Delete some off-diagonal elements for compression.
float	vx () const
	The x origin for the parameters.
float	vy () const
	The y origin for the parameters.
float	vz () const
	The z origin for the parameters.
void	setParametersOrigin (float x, float y, float z)
	Set the origin for the parameters.
const Trk::Perigee &	perigeeParameters () const
	Returns the Trk::MeasuredPerigee track parameters.

Curvilinear functions
The set of functions which return other track parameters. The remaining track parameters (i.e. not the 'defining parameters') use the 'curvilinear' coordinate system, and are represented by the parameters \((x,y,z,p_x,p_y,p_z)\). The parameters can have an associated local 5x5 error/covariance matrix. They are expressed at various points through the detector, which can be determined by the parameterPosition() method. // Example code to use parameters unsigned int index=0; if (myTP.indexOfParameterAtPosition(index, xAOD::FirstMeasurement)){ CurvilinearParameters_t parameters = myTP.trackParameters(index); }
size_t	numberOfParameters () const
	Returns the number of additional parameters stored in the TrackParticle.
const CurvilinearParameters_t	trackParameters (unsigned int index) const
	Returns the track parameter vector at 'index'.
float	parameterX (unsigned int index) const
	Returns the parameter x position, for 'index'.
float	parameterY (unsigned int index) const
	Returns the parameter y position, for 'index'.
float	parameterZ (unsigned int index) const
	Returns the parameter z position, for 'index'.
float	parameterPX (unsigned int index) const
	Returns the parameter x momentum component, for 'index'.
float	parameterPY (unsigned int index) const
	Returns the parameter y momentum component, for 'index'.
float	parameterPZ (unsigned int index) const
	Returns the parameter z momentum component, for 'index'.
void	setTrackParameters (std::vector< std::vector< float > > &parameters)
	Set the parameters via the passed vector of vectors.
ParametersCovMatrix_t	trackParameterCovarianceMatrix (unsigned int index) const
	Returns the TrackParticleCovMatrix_t (covariance matrix) at 'index', which corresponds to the parameters at the same index.
void	setTrackParameterCovarianceMatrix (unsigned int index, std::vector< float > &cov)
	Set the cov matrix of the parameter at 'index', using a vector of floats.
xAOD::ParameterPosition	parameterPosition (unsigned int index) const
	Return the ParameterPosition of the parameters at 'index'.
bool	indexOfParameterAtPosition (unsigned int &index, ParameterPosition position) const
	Function to determine if this TrackParticle contains track parameters at a certain position, and if so, what the 'index' is.
void	setParameterPosition (unsigned int index, ParameterPosition pos)
	Set the 'position' (i.e. where it is in ATLAS) of the parameter at 'index', using the ParameterPosition enum.
const Trk::CurvilinearParameters	curvilinearParameters (unsigned int index) const
	Returns a curvilinear representation of the parameters at 'index'.
float	radiusOfFirstHit () const
	Returns the radius of the first hit.
void	setRadiusOfFirstHit (float radius)
	Set the radius of the first hit.
uint64_t	identifierOfFirstHit () const
	Returns the offline identifier of the first hit.
void	setIdentifierOfFirstHit (uint64_t id)
	Set the offline identifier of the first hit.
float	beamlineTiltX () const
void	setBeamlineTiltX (float tiltX)
float	beamlineTiltY () const
void	setBeamlineTiltY (float tiltY)
uint32_t	hitPattern () const
void	setHitPattern (uint32_t hitpattern)
uint8_t	numberOfUsedHitsdEdx () const
void	setNumberOfUsedHitsdEdx (uint8_t numhits)
uint8_t	numberOfIBLOverflowsdEdx () const
void	setNumberOfIBLOverflowsdEdx (uint8_t numoverflows)

Fit quality functions
Returns some information about quality of the track fit.
float	chiSquared () const
	Returns the \( \chi^2 \) of the overall track fit.
float	numberDoF () const
	Returns the number of degrees of freedom of the overall track or vertex fit as float.
void	setFitQuality (float chiSquared, float numberDoF)
	Set the 'Fit Quality' information.

TrackInfo functions
Contains information about the 'fitter' of this Trk::Track / TrackParticle. Additionally there is some information about how the e.g. fit was configured. Also the information on the properties of the track fit is stored.
void	setTrackProperties (const TrackProperties properties)
	Methods setting the TrackProperties.
void	setPatternRecognitionInfo (const std::bitset< xAOD::NumberOfTrackRecoInfo > &patternReco)
	Method setting the pattern recognition algorithm, using a bitset.
void	setPatternRecognitionInfo (uint64_t patternReco)
	Method setting the pattern recognition algorithm, using a 64-bit int (which is faster than using a bitset).
void	setTrackFitter (const TrackFitter fitter)
	Method for setting the fitter, using the TrackFitter enum.
void	setParticleHypothesis (const ParticleHypothesis hypo)
	Method for setting the particle type, using the ParticleHypothesis enum.
TrackProperties	trackProperties () const
	Access methods for track properties, which returns 'true' if a logical AND of the parameter 'proprty' and the stored properties returns true.
std::bitset< NumberOfTrackRecoInfo >	patternRecoInfo () const
	Access method for pattern recognition algorithm.
ParticleHypothesis	particleHypothesis () const
	Returns the particle hypothesis used for Track fitting.
TrackFitter	trackFitter () const
	Returns the fitter.

Links
const ElementLink< TrackCollection > &	trackLink () const
	Returns a link (which can be invalid) to the Trk::Track which was used to make this TrackParticle.
void	setTrackLink (const ElementLink< TrackCollection > &track)
	Set the link to the original track.
const Trk::Track *	track () const
	Returns a pointer (which can be NULL) to the Trk::Track which was used to make this TrackParticle.

Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

Detailed Description

Class describing a TrackParticle.

Author

Edward Moyse Edwar.nosp@m.d.Mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch

Markus Elsing Marku.nosp@m.s.El.nosp@m.sing@.nosp@m.cern.nosp@m..ch

Definition at line 44 of file TrackParticle_v1.h.

Member Typedef Documentation

covMatrixIndex

using xAOD::TrackParticle_v1::covMatrixIndex = TrackingDetails::covMatrixIndex

private

Definition at line 349 of file TrackParticle_v1.h.

covMatrixIndexPairVec

typedef std::vector< std::pair<covMatrixIndex,covMatrixIndex> > xAOD::TrackParticle_v1::covMatrixIndexPairVec

private

Definition at line 351 of file TrackParticle_v1.h.

FourMom_t

typedef IParticle::FourMom_t xAOD::TrackParticle_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 73 of file TrackParticle_v1.h.

GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzM4D<double> > xAOD::TrackParticle_v1::GenVecFourMom_t

Base 4 Momentum type for TrackParticle.

Definition at line 79 of file TrackParticle_v1.h.

Constructor & Destructor Documentation

TrackParticle_v1() [1/2]

xAOD::TrackParticle_v1::TrackParticle_v1

(

)

Default constructor.

Definition at line 47 of file TrackParticle_v1.cxx.

  : IParticle() {
    // perigeeParameters cache initialized to be empty (default constructor)
  }

~TrackParticle_v1()

xAOD::TrackParticle_v1::~TrackParticle_v1

(

)

Destructor.

Definition at line 73 of file TrackParticle_v1.cxx.

{}

TrackParticle_v1() [2/2]

xAOD::TrackParticle_v1::TrackParticle_v1

(

const TrackParticle_v1 &

o

)

Copy ctor. This involves copying the entire Auxilary store, and is a slow operation which should be used sparingly.

Definition at line 52 of file TrackParticle_v1.cxx.

  : IParticle( tp ) {
    makePrivateStore( tp );
    // perigeeParameters cache initialized to be empty (default constructor)
    // assume that this copy will create new cache as needed
  }

Member Function Documentation

auxdata() [1/2]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

auxdata() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

beamlineTiltX()

float xAOD::TrackParticle_v1::beamlineTiltX

(

)

const

beamlineTiltY()

float xAOD::TrackParticle_v1::beamlineTiltY

(

)

const

charge()

float xAOD::TrackParticle_v1::charge

(

)

const

Returns the charge.

Definition at line 143 of file TrackParticle_v1.cxx.

                                       {
    return TrackingDetails::charge (qOverP());
  }

chiSquared()

float xAOD::TrackParticle_v1::chiSquared

(

)

const

Returns the \( \chi^2 \) of the overall track fit.

compressDefiningParametersCovMatrixOffDiag()

void xAOD::TrackParticle_v1::compressDefiningParametersCovMatrixOffDiag

(

)

Delete some off-diagonal elements for compression.

Definition at line 388 of file TrackParticle_v1.cxx.

                                                                    {
 
    ParametersCovMatrix_t cov = definingParametersCovMatrix();
    std::vector< float > offDiagVecCompr;
    offDiagVecCompr.resize(COVMATRIX_OFFDIAG_VEC_COMPR_SIZE);
 
    const covMatrixIndexPairVec& vecPairIndex = covMatrixComprIndexPairs();
 
    for(unsigned int k=0; k<COVMATRIX_OFFDIAG_VEC_COMPR_SIZE; ++k){
      std::pair<covMatrixIndex,covMatrixIndex> pairIndex = vecPairIndex[k];
      covMatrixIndex i = pairIndex.first;
      covMatrixIndex j = pairIndex.second;
      float offDiagElement = cov(i,i)>0 && cov(j,j)>0 ? cov(i,j)/sqrt(cov(i,i)*cov(j,j)) : 0;
      offDiagVecCompr[k] = offDiagElement;
    }
 
    accCovMatrixOffDiag( *this ) = offDiagVecCompr;
    return;
 
  }

covMatrixComprIndexPairs()

const TrackParticle_v1::covMatrixIndexPairVec & xAOD::TrackParticle_v1::covMatrixComprIndexPairs ( )

staticprivate

Definition at line 716 of file TrackParticle_v1.cxx.

                                                                                         {
    static const covMatrixIndexPairVec result (TrackingDetails::covMatrixComprIndexPairs.begin(),
                 TrackingDetails::covMatrixComprIndexPairs.end());
    return result;
  }

curvilinearParameters()

const Trk::CurvilinearParameters xAOD::TrackParticle_v1::curvilinearParameters

(

unsigned int

index

)

const

Returns a curvilinear representation of the parameters at 'index'.

Note

This is only available in Athena.

Definition at line 625 of file TrackParticle_v1.cxx.

                                                                                                 {
 
    static const Accessor< std::vector<float>  > acc( "trackParameterCovarianceMatrices" );
    unsigned int offset = index*15;
    // copy the correct values into the temp matrix
    ParametersCovMatrix_t cov;
    auto it = acc(*this).begin()+offset;
    Amg::expand(it,it+15,cov);
    // retrieve the parameters to build the curvilinear frame
    Amg::Vector3D pos(parameterX(index),parameterY(index),parameterZ(index));
    Amg::Vector3D mom(parameterPX(index),parameterPY(index),parameterPZ(index));
    Trk::CurvilinearParameters param(pos,mom,charge(),std::move(cov));
 
    return param;
  }

d0()

float xAOD::TrackParticle_v1::d0

(

)

const

Returns the \(d_0\) parameter.

definingParameters()

DefiningParameters_t xAOD::TrackParticle_v1::definingParameters

(

)

const

Returns a SVector of the Perigee track parameters.

i.e. a vector of \(\left(\begin{array}{c}d_0\\z_0\\\phi_0\\\theta\\q/p\end{array}\right)\)

Definition at line 175 of file TrackParticle_v1.cxx.

                                                                 {
    DefiningParameters_t tmp;
    tmp << d0() , z0() , phi0() , theta() , qOverP();
    return tmp;
  }

definingParametersCovMatrix()

const xAOD::ParametersCovMatrix_t xAOD::TrackParticle_v1::definingParametersCovMatrix

(

)

const

Returns the 5x5 symmetric matrix containing the defining parameters covariance matrix.

Definition at line 260 of file TrackParticle_v1.cxx.

                                                                                      {
 
      std::span<const float> covMatrixDiag;
      if( accCovMatrixDiag.isAvailable( *this ))
        covMatrixDiag = std::span<const float>( accCovMatrixDiag( *this ) );
      std::span<const float> covMatrixOffDiag;
      if( accCovMatrixOffDiag.isAvailable( *this ))
        covMatrixOffDiag = std::span<const float>( accCovMatrixOffDiag( *this ) );
      bool valid = true;
      auto result = TrackingDetails::definingParametersCovMatrix( covMatrixDiag, covMatrixOffDiag, valid );
      if( !valid ) xAODTrackParticlePrivate::covarianceUnsetHook();
      return result;
  }

definingParametersCovMatrixDiagVec()

const std::vector< float > & xAOD::TrackParticle_v1::definingParametersCovMatrixDiagVec

(

)

const

Returns the diagonal elements of the defining parameters covariance matrix.

Definition at line 326 of file TrackParticle_v1.cxx.

                                                                                       {
 
    return accCovMatrixDiag( *this );
  }

definingParametersCovMatrixFilled()

ParametersCovMatrixFilled_t xAOD::TrackParticle_v1::definingParametersCovMatrixFilled

(

)

const

Returns a 5x5 matrix describing which elements of the covariance matrix are known.

Definition at line 274 of file TrackParticle_v1.cxx.

                                                                                        {
 
    // Create the result matrix.
    ParametersCovMatrixFilled_t result;
    result.setZero();
 
    // Check if the diagonal elements are available.
    if( accCovMatrixDiag.isAvailable( *this ) &&
        ( static_cast< int >( accCovMatrixDiag( *this ).size() ) == result.rows() ) ) {
 
      result.setIdentity();
    }
 
    bool offDiagCompr = definingParametersCovMatrixOffDiagCompr();
 
    if(!offDiagCompr){
 
      // Check if the off-diagonal elements are available.
      if( accCovMatrixOffDiag.isAvailable( *this ) &&
      ( static_cast< int >( accCovMatrixOffDiag( *this ).size() ) ==
        ( ( result.rows() * ( result.rows() - 1 ) ) / 2 ) ) ) {
 
    for( int i = 1; i < result.rows(); ++i ) {
      for( int j = 0; j < i; ++j ) {
        result.fillSymmetric( i, j, true );
      }
    }
      }
 
    }
 
    else{
 
      if( accCovMatrixOffDiag.isAvailable( *this ) &&
      ( static_cast< int >( accCovMatrixOffDiag( *this ).size() ) == COVMATRIX_OFFDIAG_VEC_COMPR_SIZE ) ){
 
    const covMatrixIndexPairVec& vecPairIndex = covMatrixComprIndexPairs();
 
    for(const auto& pairIndex : vecPairIndex){
      covMatrixIndex i = pairIndex.first;
      covMatrixIndex j = pairIndex.second;
      result.fillSymmetric( i, j, true );
    }
 
      }
 
    }
 
    // Return the object.
    return result;
  }

definingParametersCovMatrixOffDiagCompr()

bool xAOD::TrackParticle_v1::definingParametersCovMatrixOffDiagCompr

(

)

const

Definition at line 380 of file TrackParticle_v1.cxx.

                                                                       {
 
    std::span<const float> covMatrixOffDiag;
    if( accCovMatrixOffDiag.isAvailable( *this ))
      covMatrixOffDiag = std::span<const float>( accCovMatrixOffDiag( *this ) );
    return TrackingDetails::definingParametersCovMatrixOffDiagCompr(covMatrixOffDiag);
  }

definingParametersCovMatrixOffDiagVec()

const std::vector< float > & xAOD::TrackParticle_v1::definingParametersCovMatrixOffDiagVec

(

)

const

Returns the correlation coefficient associated with the off-diagonal elements of the covariance matrix = cov(X,Y)/sqrt(cov(X,X)*cov(Y,Y)).

Definition at line 331 of file TrackParticle_v1.cxx.

                                                                                          {
 
    return accCovMatrixOffDiag( *this );
  }

definingParametersCovMatrixVec()

std::vector< float > xAOD::TrackParticle_v1::definingParametersCovMatrixVec

(

)

const

Returns the length 6 vector containing the elements of defining parameters covariance matrix.

Definition at line 336 of file TrackParticle_v1.cxx.

                                                                          {
 
    std::vector< float > vec;
    const AmgSymMatrix(5) cov = definingParametersCovMatrix();
    Amg::compress(cov,vec);
    return vec;
 
  }

e()

double xAOD::TrackParticle_v1::e ( ) const

finaloverridevirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 111 of file TrackParticle_v1.cxx.

                                   {
    return genvecP4().E();
  }

eta()

double xAOD::TrackParticle_v1::eta ( ) const

finaloverridevirtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 79 of file TrackParticle_v1.cxx.

                                     {
    return genvecP4().Eta();
  }

genvecP4()

TrackParticle_v1::GenVecFourMom_t xAOD::TrackParticle_v1::genvecP4

(

)

const

The full 4-momentum of the particle : GenVector form.

Definition at line 118 of file TrackParticle_v1.cxx.

                                                                   {
    return TrackingDetails::genvecP4(qOverP(), theta(), phi(), m());
  }

hasValidTime()

uint8_t xAOD::TrackParticle_v1::hasValidTime

(

)

const

Returns whether or not the track has a valid time.

hitPattern()

uint32_t xAOD::TrackParticle_v1::hitPattern

(

)

const

identifierOfFirstHit()

uint64_t xAOD::TrackParticle_v1::identifierOfFirstHit

(

)

const

Returns the offline identifier of the first hit.

indexOfParameterAtPosition()

bool xAOD::TrackParticle_v1::indexOfParameterAtPosition	(	unsigned int &	index,
		ParameterPosition	position ) const

Function to determine if this TrackParticle contains track parameters at a certain position, and if so, what the 'index' is.

Parameters

[in]	index	Filled with the index of the track parameters at 'position' - untouched otherwise.
[out]	position	The location in the detector of the required track parameters.

Returns

Returns 'true' if the TrackParticle parameters at 'position', returns False otherwise.

Definition at line 605 of file TrackParticle_v1.cxx.

  {
    size_t maxParameters = numberOfParameters();
    bool foundParameters=false;
    for (size_t i=0; i<maxParameters; ++i){
      if (parameterPosition(i)==position){
        foundParameters=true;
        index=i;
        break;
      }
    }
    return foundParameters;
  }

isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

isAvailableWritable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                    {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

m()

double xAOD::TrackParticle_v1::m ( ) const

finaloverridevirtual

The invariant mass of the particle..

Implements xAOD::IParticle.

Definition at line 85 of file TrackParticle_v1.cxx.

                                   {
    // Codes using a fitter set a hypothesis, and the
    // particular fitter that was employed..
    // A  mass is never set/stored.
    //
    // In the past we were returning the mass of a charged pion always
    //
    // This created a confusion on why TrackParticles created by
    // specific lepton fitter have a pion mass (the leptons per se have the
    // correct mass). Lets try to remedy this.
    uint8_t hypo = particleHypothesis();
    if (hypo == xAOD::electron) {
       // Since GX2 also set sometimes the hypo to electron
       // lets also check for GSF.
       uint8_t fitter = trackFitter();
       if (fitter == xAOD::GaussianSumFilter) {
         return ParticleConstants::electronMassInMeV;
       }
    }
    if (hypo == xAOD::muon) {
       return ParticleConstants::muonMassInMeV;
    }
    // default charged pion
    return ParticleConstants::chargedPionMassInMeV;
  }

numberDoF()

float xAOD::TrackParticle_v1::numberDoF

(

)

const

Returns the number of degrees of freedom of the overall track or vertex fit as float.

numberOfIBLOverflowsdEdx()

uint8_t xAOD::TrackParticle_v1::numberOfIBLOverflowsdEdx

(

)

const

numberOfParameters()

size_t xAOD::TrackParticle_v1::numberOfParameters

(

)

const

Returns the number of additional parameters stored in the TrackParticle.

number of parameters should be the size of positions we need for them

Definition at line 505 of file TrackParticle_v1.cxx.

                                                   {
    static const Accessor< std::vector<uint8_t>  > acc( "parameterPosition" );
    if(! acc.isAvailable( *this )) return 0;
    return acc(*this).size();
  }

numberOfUsedHitsdEdx()

uint8_t xAOD::TrackParticle_v1::numberOfUsedHitsdEdx

(

)

const

operator=()

TrackParticle_v1 & xAOD::TrackParticle_v1::operator=

(

const TrackParticle_v1 &

tp

)

Assignment operator. This can involve creating and copying an Auxilary store, and so should be used sparingly.

Definition at line 59 of file TrackParticle_v1.cxx.

                                                                        {
    if(this == &tp) return *this;
 
    if( ( ! hasStore() ) && ( ! container() ) ) {
       makePrivateStore();
    }
    this->IParticle::operator=( tp );
#ifndef XAOD_ANALYSIS
    // assume that this copy will create new cache as needed
    m_perigeeParameters.reset();
#endif // not XAOD_ANALYSIS
    return *this;
  }

p4()

TrackParticle_v1::FourMom_t xAOD::TrackParticle_v1::p4 ( ) const

finaloverridevirtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 122 of file TrackParticle_v1.cxx.

                                                       {
    TrackParticle_v1::FourMom_t p4;
    using namespace std;
    float p = 10.e6; // 10 TeV (default value for very high pt muons, with qOverP==0)
    if (fabs(qOverP())>0.) p = 1/fabs(qOverP());
    float thetaT = theta();
    float phiT = phi();
    float sinTheta= sin(thetaT);
    float px = p*sinTheta*cos(phiT);
    float py = p*sinTheta*sin(phiT);
    float pz = p*cos(thetaT);
    float e  =  pow (m(),2) +
      pow( px,2) + pow( py,2) + pow( pz,2);
    p4.SetPxPyPzE( px, py, pz, sqrt(e) );
    return p4;
  }

parameterPosition()

xAOD::ParameterPosition xAOD::TrackParticle_v1::parameterPosition

(

unsigned int

index

)

const

Return the ParameterPosition of the parameters at 'index'.

Definition at line 599 of file TrackParticle_v1.cxx.

  {
    static const Accessor< std::vector<uint8_t>  > acc( "parameterPosition" );
    return static_cast<xAOD::ParameterPosition>(acc(*this).at(index));
  }

parameterPX()

float xAOD::TrackParticle_v1::parameterPX

(

unsigned int

index

)

const

Returns the parameter x momentum component, for 'index'.

Definition at line 564 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterPX" );
    return acc(*this).at(index);
  }

parameterPY()

float xAOD::TrackParticle_v1::parameterPY

(

unsigned int

index

)

const

Returns the parameter y momentum component, for 'index'.

Definition at line 569 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterPY" );
    return acc(*this).at(index);
  }

parameterPZ()

float xAOD::TrackParticle_v1::parameterPZ

(

unsigned int

index

)

const

Returns the parameter z momentum component, for 'index'.

Definition at line 574 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterPZ" );
    return acc(*this).at(index);
  }

parameterX()

float xAOD::TrackParticle_v1::parameterX

(

unsigned int

index

)

const

Returns the parameter x position, for 'index'.

Definition at line 549 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterX" );
    return acc(*this).at(index);
  }

parameterY()

float xAOD::TrackParticle_v1::parameterY

(

unsigned int

index

)

const

Returns the parameter y position, for 'index'.

Definition at line 554 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterY" );
    return acc(*this).at(index);
  }

parameterZ()

float xAOD::TrackParticle_v1::parameterZ

(

unsigned int

index

)

const

Returns the parameter z position, for 'index'.

Definition at line 559 of file TrackParticle_v1.cxx.

                                                              {
    static const Accessor< std::vector<float>  > acc( "parameterZ" );
    return acc(*this).at(index);
  }

particleHypothesis()

xAOD::ParticleHypothesis xAOD::TrackParticle_v1::particleHypothesis

(

)

const

Returns the particle hypothesis used for Track fitting.

Definition at line 680 of file TrackParticle_v1.cxx.

                                                                    {
    static const Accessor<uint8_t> acc("particleHypothesis");
    if (!acc.isAvailable(*this)) {
      return xAOD::pion;
    }
    return static_cast<xAOD::ParticleHypothesis>(acc(*this));
  }

patternRecoInfo()

std::bitset< xAOD::NumberOfTrackRecoInfo > xAOD::TrackParticle_v1::patternRecoInfo

(

)

const

Access method for pattern recognition algorithm.

Definition at line 658 of file TrackParticle_v1.cxx.

            {
    static const Accessor< uint64_t > acc( "patternRecoInfo" );
    std::bitset<xAOD::NumberOfTrackRecoInfo> tmp(acc(*this));
    return tmp;
  }

perigeeParameters()

const Trk::Perigee & xAOD::TrackParticle_v1::perigeeParameters

(

)

const

Returns the Trk::MeasuredPerigee track parameters.

These are defined as: \(\left(\begin{array}{c}d_0\\z_0\\\phi_0\\\theta\\q/p\\\end{array}\right)\)

Note

This is only available in Athena.

Definition at line 437 of file TrackParticle_v1.cxx.

                                                              {
 
    // Require the cache to be valid and check if the cached pointer has been set
    if(m_perigeeParameters.isValid()){
      return *(m_perigeeParameters.ptr());
    }
    static const Accessor< float > acc1( "d0" );
    static const Accessor< float > acc2( "z0" );
    static const Accessor< float > acc3( "phi" );
    static const Accessor< float > acc4( "theta" );
    static const Accessor< float > acc5( "qOverP" );
    static const Accessor< std::vector<float> > acc6( "definingParametersCovMatrix" );
    ParametersCovMatrix_t cov = ParametersCovMatrix_t(definingParametersCovMatrix());
    static const Accessor< float > acc7( "beamlineTiltX" );
    static const Accessor< float > acc8( "beamlineTiltY" );
 
    if(!acc7.isAvailable( *this ) || !acc8.isAvailable( *this )){
      Trk::Perigee tmpPerigeeParameters(
        acc1(*this),
        acc2(*this),
        acc3(*this),
        acc4(*this),
        acc5(*this),
        Trk::PerigeeSurface(Amg::Vector3D(vx(), vy(), vz())),
        std::move(cov));
      m_perigeeParameters.set(tmpPerigeeParameters);
      return *(m_perigeeParameters.ptr());
    }
 
    Amg::Translation3D amgtranslation(vx(),vy(),vz());
    Amg::Transform3D pAmgTransf = amgtranslation * Amg::RotationMatrix3D::Identity();
    pAmgTransf *= Amg::AngleAxis3D(acc8(*this), Amg::Vector3D(0.,1.,0.));
    pAmgTransf *= Amg::AngleAxis3D(acc7(*this), Amg::Vector3D(1.,0.,0.));
    Trk::Perigee tmpPerigeeParameters(acc1(*this),
                                      acc2(*this),
                                      acc3(*this),
                                      acc4(*this),
                                      acc5(*this),
                                      pAmgTransf,
                                      std::move(cov));
 
    m_perigeeParameters.set(tmpPerigeeParameters);
    return *(m_perigeeParameters.ptr());
  }

phi()

virtual double xAOD::TrackParticle_v1::phi ( ) const

finaloverridevirtual

The azimuthal angle ( \(\phi\)) of the particle (has range \(-\pi\) to \(+\pi\).).

Implements xAOD::IParticle.

phi0()

float xAOD::TrackParticle_v1::phi0

(

)

const

Returns the \(\phi\) parameter, which has range \(-\pi\) to \(+\pi\).

Definition at line 150 of file TrackParticle_v1.cxx.

                                     {
 
     static  const Accessor< float > acc( "phi" );
     return acc( *this );
  }

pt()

double xAOD::TrackParticle_v1::pt ( ) const

finaloverridevirtual

The transverse momentum ( \(p_T\)) of the particle.

Implements xAOD::IParticle.

Definition at line 75 of file TrackParticle_v1.cxx.

                                    {
    return genvecP4().Pt();
  }

qOverP()

float xAOD::TrackParticle_v1::qOverP

(

)

const

Returns the \(q/p\) parameter.

radiusOfFirstHit()

float xAOD::TrackParticle_v1::radiusOfFirstHit

(

)

const

Returns the radius of the first hit.

rapidity()

double xAOD::TrackParticle_v1::rapidity ( ) const

finaloverridevirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 114 of file TrackParticle_v1.cxx.

                                          {
    return genvecP4().Rapidity();
  }

resetCache()

void xAOD::TrackParticle_v1::resetCache

(

)

Reset the internal cache of the object.

Definition at line 772 of file TrackParticle_v1.cxx.

                                    {
#ifndef XAOD_ANALYSIS
     m_perigeeParameters.reset();
#endif // not XAOD_ANALYSIS
   }

setBeamlineTiltX()

void xAOD::TrackParticle_v1::setBeamlineTiltX

(

float

tiltX

)

setBeamlineTiltY()

void xAOD::TrackParticle_v1::setBeamlineTiltY

(

float

tiltY

)

setDefiningParameters() [1/2]

void xAOD::TrackParticle_v1::setDefiningParameters	(	float	d0,
		float	z0,
		float	phi0,
		float	theta,
		float	qOverP )

Set the defining parameters.

Definition at line 181 of file TrackParticle_v1.cxx.

                                                                                                        {
#ifndef XAOD_ANALYSIS
    // reset perigee cache if existing
    if(m_perigeeParameters.isValid()) {
      m_perigeeParameters.reset();
    }
#endif // not XAOD_ANALYSIS
    static const Accessor< float > acc1( "d0" );
    acc1( *this ) = d0;
 
    static const Accessor< float > acc2( "z0" );
    acc2( *this ) = z0;
 
    static const Accessor< float > acc3( "phi" );
    acc3( *this ) = phi0;
 
    static const Accessor< float > acc4( "theta" );
    acc4( *this ) = theta;
 
    static const Accessor< float > acc5( "qOverP" );
    acc5( *this ) = qOverP;
 
    return;
  }

setDefiningParameters() [2/2]

void xAOD::TrackParticle_v1::setDefiningParameters	(	float	d0,
		float	z0,
		float	phi0,
		float	theta,
		float	qOverP,
		float	time )

Definition at line 206 of file TrackParticle_v1.cxx.

                                                                                                                    {
    setDefiningParameters(d0, z0, phi0, theta, qOverP);
    setTime(time);
    return;
  }

setDefiningParametersCovMatrix()

void xAOD::TrackParticle_v1::setDefiningParametersCovMatrix

(

const ParametersCovMatrix_t &

cov

)

Set the defining parameters covariance matrix.

Definition at line 227 of file TrackParticle_v1.cxx.

                                                                                           {
 
#ifndef XAOD_ANALYSIS
    // reset perigee cache if existing
    if(m_perigeeParameters.isValid()) {
      m_perigeeParameters.reset();
    }
#endif // not XAOD_ANALYSIS
 
    // Extract the diagonal elements from the matrix.
    std::vector< float > diagVec;
    diagVec.reserve( cov.rows() );
    for( int i = 0; i < cov.rows(); ++i ) {
      diagVec.push_back( cov( i, i ) );
    }
    // Set the variable.
    setDefiningParametersCovMatrixDiagVec( diagVec );
 
    // Extract the off-diagonal elements from the matrix.
    std::vector< float > offDiagVec;
    offDiagVec.reserve( ( ( cov.rows() - 1 ) * cov.rows() ) / 2 );
    for( int i = 1; i < cov.rows(); ++i ) {
      for( int j = 0; j < i; ++j ) {
        float offDiagCoeff = (cov( i, i )>0 && cov( j, j )>0) ? cov( i, j )/sqrt(cov( i, i )*cov( j, j )) : 0;
        offDiagVec.push_back( offDiagCoeff );
      }
    }
    // Set the variable.
    setDefiningParametersCovMatrixOffDiagVec( offDiagVec );
 
    return;
  }

setDefiningParametersCovMatrixDiagVec()

void xAOD::TrackParticle_v1::setDefiningParametersCovMatrixDiagVec

(

const std::vector< float > &

vec

)

Set the defining parameters covariance matrix using a length 15 vector.

Set the diagonal elements of the defining parameters covariance matrix

Definition at line 345 of file TrackParticle_v1.cxx.

                                                                                              {
 
    if (vec.size() != ParametersCovMatrix_t::RowsAtCompileTime) {
      throw std::runtime_error(
        "Setting track definingParametersCovMatrixDiag with vector of size " +
        std::to_string(vec.size()) + " instead of expected " +
        std::to_string(ParametersCovMatrix_t::RowsAtCompileTime) +
        " is not supported");
    }
 
    accCovMatrixDiag( *this ) = vec;
    return;
  }

setDefiningParametersCovMatrixOffDiagVec()

void xAOD::TrackParticle_v1::setDefiningParametersCovMatrixOffDiagVec

(

const std::vector< float > &

vec

)

Set the off-diagonal elements of the defining parameters covariance matrix.

Definition at line 359 of file TrackParticle_v1.cxx.

                                                                                                 {
 
    bool offDiagCompr = definingParametersCovMatrixOffDiagCompr();
 
    unsigned int uncompr_size = ( ( ( ParametersCovMatrix_t::RowsAtCompileTime - 1 ) *
                    ParametersCovMatrix_t::RowsAtCompileTime ) / 2 );
    unsigned int size = offDiagCompr ? COVMATRIX_OFFDIAG_VEC_COMPR_SIZE : uncompr_size;
 
    if( !(vec.size() == size || vec.size() == uncompr_size) ){ //If off-diagonal elements are already compressed, can either set with uncompressed or compressed vector
      throw std::runtime_error(
          "Setting track definingParametersCovMatrixOffDiag with vector of "
          "size " +
          std::to_string(vec.size()) + " instead of expected " +
          std::to_string(size) + " or " + std::to_string(uncompr_size) +
          " is not supported");
    }
 
    accCovMatrixOffDiag( *this ) = vec;
    return;
  }

setDefiningParametersCovMatrixVec()

void xAOD::TrackParticle_v1::setDefiningParametersCovMatrixVec

(

const std::vector< float > &

cov

)

Definition at line 412 of file TrackParticle_v1.cxx.

                                                                                     {
 
    xAOD::ParametersCovMatrix_t covMatrix;
    if( !cov.empty() ) Amg::expand( cov.begin(), cov.end(),covMatrix );
    else covMatrix.setIdentity();
    setDefiningParametersCovMatrix( covMatrix );
 
  }

setFitQuality()

void xAOD::TrackParticle_v1::setFitQuality	(	float	chiSquared,
		float	numberDoF )

Set the 'Fit Quality' information.

Definition at line 486 of file TrackParticle_v1.cxx.

                                                                       {
    static const Accessor< float > acc1( "chiSquared" );
    acc1( *this ) = chiSquared;
    static const Accessor< float > acc2( "numberDoF" );
    acc2( *this ) = numberDoF;
  }

setHasValidTime()

void xAOD::TrackParticle_v1::setHasValidTime

(

uint8_t

hasValidTime

)

setHitPattern()

void xAOD::TrackParticle_v1::setHitPattern

(

uint32_t

hitpattern

)

setIdentifierOfFirstHit()

void xAOD::TrackParticle_v1::setIdentifierOfFirstHit

(

uint64_t

id

)

Set the offline identifier of the first hit.

setNumberOfIBLOverflowsdEdx()

void xAOD::TrackParticle_v1::setNumberOfIBLOverflowsdEdx

(

uint8_t

numoverflows

)

setNumberOfUsedHitsdEdx()

void xAOD::TrackParticle_v1::setNumberOfUsedHitsdEdx

(

uint8_t

numhits

)

setParameterPosition()

void xAOD::TrackParticle_v1::setParameterPosition	(	unsigned int	index,
		xAOD::ParameterPosition	pos )

Set the 'position' (i.e. where it is in ATLAS) of the parameter at 'index', using the ParameterPosition enum.

Definition at line 619 of file TrackParticle_v1.cxx.

                                                                                           {
    static const Accessor< std::vector<uint8_t>  > acc( "parameterPosition" );
    acc( *this ).at(index) = static_cast<uint8_t>(pos);
  }

setParametersOrigin()

void xAOD::TrackParticle_v1::setParametersOrigin	(	float	x,
		float	y,
		float	z )

Set the origin for the parameters.

Definition at line 425 of file TrackParticle_v1.cxx.

                                                                     {
    static const Accessor< float > acc1( "vx" );
    acc1( *this ) = x;
 
    static const Accessor< float > acc2( "vy" );
    acc2( *this ) = y;
 
    static const Accessor< float > acc3( "vz" );
    acc3( *this ) = z;
  }

setParticleHypothesis()

void xAOD::TrackParticle_v1::setParticleHypothesis

(

const ParticleHypothesis

hypo

)

Method for setting the particle type, using the ParticleHypothesis enum.

Definition at line 675 of file TrackParticle_v1.cxx.

                                                                           {
    static const Accessor<uint8_t> acc("particleHypothesis");
    acc(*this) = static_cast<uint8_t>(value);
  }

setPatternRecognitionInfo() [1/2]

void xAOD::TrackParticle_v1::setPatternRecognitionInfo

(

const std::bitset< xAOD::NumberOfTrackRecoInfo > &

patternReco

)

Method setting the pattern recognition algorithm, using a bitset.

The bitset should be created using the TrackPatternRecoInfo enum as follows:

const std::bitset<xAOD::NumberOfTrackRecoInfo> patternReco;
patternReco.set(xAOD::Fatras);

Definition at line 670 of file TrackParticle_v1.cxx.

                                                                                                           {
    static const Accessor< uint64_t > acc( "patternRecoInfo" );
    acc( *this ) = patternReco.to_ullong();
  }

setPatternRecognitionInfo() [2/2]

void xAOD::TrackParticle_v1::setPatternRecognitionInfo

(

uint64_t

patternReco

)

Method setting the pattern recognition algorithm, using a 64-bit int (which is faster than using a bitset).

The bit set should be created using the TrackPatternRecoInfo enum as follows:

uint64_t patternReco;
patternReco |= (1<<static_cast<uint64_t>(xAOD::Fatras))

Definition at line 665 of file TrackParticle_v1.cxx.

                                                                        {
    static const Accessor< uint64_t > acc( "patternRecoInfo" );
    acc( *this ) = patternReco;
  }

setRadiusOfFirstHit()

void xAOD::TrackParticle_v1::setRadiusOfFirstHit

(

float

radius

)

Set the radius of the first hit.

setSummaryValue() [1/2]

void xAOD::TrackParticle_v1::setSummaryValue	(	float &	value,
		const SummaryType &	information )

Set method for TrackSummary values.

Definition at line 710 of file TrackParticle_v1.cxx.

                                                                                    {
    const xAOD::TrackParticle_v1::Accessor< float >* acc = trackSummaryAccessorV1<float>( information );
  // Set the value:
    ( *acc )( *this ) = value;
  }

setSummaryValue() [2/2]

void xAOD::TrackParticle_v1::setSummaryValue	(	uint8_t &	value,
		const SummaryType &	information )

Set method for TrackSummary values.

Definition at line 704 of file TrackParticle_v1.cxx.

                                                                                      {
    const xAOD::TrackParticle_v1::Accessor< uint8_t >* acc = trackSummaryAccessorV1<uint8_t>( information );
  // Set the value:
    ( *acc )( *this ) = value;
  }

setTime()

void xAOD::TrackParticle_v1::setTime

(

float

time

)

Definition at line 212 of file TrackParticle_v1.cxx.

                                           {
    static const SG::AuxElement::Accessor< float > acc("time");
    acc( *this ) = time;
  }

setTimeResolution()

void xAOD::TrackParticle_v1::setTimeResolution

(

float

timeResolution

)

Definition at line 217 of file TrackParticle_v1.cxx.

                                                        {
    static const SG::AuxElement::Accessor< float > acc("timeResolution");
    acc( *this ) = timeRes;
  }

setTrackFitter()

void xAOD::TrackParticle_v1::setTrackFitter

(

const TrackFitter

fitter

)

Method for setting the fitter, using the TrackFitter enum.

Definition at line 645 of file TrackParticle_v1.cxx.

                                                             {
    static const Accessor<uint8_t> acc("trackFitter");
    acc(*this) = static_cast<uint8_t>(value);
  }

setTrackLink()

void xAOD::TrackParticle_v1::setTrackLink

(

const ElementLink< TrackCollection > &

track

)

Set the link to the original track.

Note

This is only available in Athena.

Definition at line 745 of file TrackParticle_v1.cxx.

                                                            {
 
      // The accessor:
      static const Accessor< ElementLink< TrackCollection > > acc( "trackLink" );
 
      // Do the deed:
      acc( *this ) = el;
      return;
   }

setTrackParameterCovarianceMatrix()

void xAOD::TrackParticle_v1::setTrackParameterCovarianceMatrix	(	unsigned int	index,
		std::vector< float > &	cov )

Set the cov matrix of the parameter at 'index', using a vector of floats.

The vector \(\mathrm{v}(a1,a2,a3 ... a_{15})\) represents the lower diagonal, i.e. it gives a matrix of \(\left(\begin{array}{ccccc} a_1 & a_2 & a_4 & a_7 & a_{11} \\ a_2 & a_3 & a_5 & a_8 & a_{12} \\ a_4 & a_5 & a_6 & a_9 & a_{13} \\ a_7 & a_8 & a_9 & a_{10} & a_{14} \\ a_{11} & a_{12} & a_{13} & a_{14} & a_{15} \end{array}\right)\)

Definition at line 590 of file TrackParticle_v1.cxx.

                                                                                                   {
    assert(cov.size()==15);
    unsigned int offset = index*15;
    static const Accessor< std::vector < float > > acc( "trackParameterCovarianceMatrices" );
    std::vector<float>& v = acc(*this);
    v.resize(offset+15);
    std::copy(cov.begin(),cov.end(),v.begin()+offset );
  }

setTrackParameters()

void xAOD::TrackParticle_v1::setTrackParameters

(

std::vector< std::vector< float > > &

parameters

)

Set the parameters via the passed vector of vectors.

The vector<float> should be of size 6: x,y,z,px,py,pz (charge is stored elsewhere)

Definition at line 519 of file TrackParticle_v1.cxx.

                                                                                   {
    static const Accessor< std::vector < float > > acc1( "parameterX" );
    static const Accessor< std::vector < float > > acc2( "parameterY" );
    static const Accessor< std::vector < float > > acc3( "parameterZ" );
    static const Accessor< std::vector < float > > acc4( "parameterPX" );
    static const Accessor< std::vector < float > > acc5( "parameterPY" );
    static const Accessor< std::vector < float > > acc6( "parameterPZ" );
    static const Accessor< std::vector<uint8_t>  > acc7( "parameterPosition" );
 
    acc1(*this).resize(parameters.size());
    acc2(*this).resize(parameters.size());
    acc3(*this).resize(parameters.size());
    acc4(*this).resize(parameters.size());
    acc5(*this).resize(parameters.size());
    acc6(*this).resize(parameters.size());
    acc7(*this).resize(parameters.size());
 
    unsigned int index=0;
    std::vector<std::vector<float> >::const_iterator it=parameters.begin(), itEnd=parameters.end();
    for (;it!=itEnd;++it,++index){
      assert((*it).size()==6);
      acc1(*this).at(index)=(*it).at(0);
      acc2(*this).at(index)=(*it).at(1);
      acc3(*this).at(index)=(*it).at(2);
      acc4(*this).at(index)=(*it).at(3);
      acc5(*this).at(index)=(*it).at(4);
      acc6(*this).at(index)=(*it).at(5);
    }
  }

setTrackProperties()

void xAOD::TrackParticle_v1::setTrackProperties

(

const TrackProperties

properties

)

Methods setting the TrackProperties.

summaryValue() [1/2]

bool xAOD::TrackParticle_v1::summaryValue	(	float &	value,
		const SummaryType &	information ) const

Accessor for TrackSummary values.

If 'information' is stored in this TrackParticle and is of the correct templated type T, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'. See below for an example of how this is intended to be used.

int numberOfBLayerHits=0;
if( myParticle.summaryValue(numberOfBLayerHits,xAOD::numberOfBLayerHits) ){
  ATH_MSG_INFO("Successfully retrieved the integer value, numberOfBLayerHits");
}
float numberOfCscPhiHits=0.0; //Wrong! This is actually an int too.
if( !myParticle.summaryValue(numberOfCscPhiHits,xAOD::numberOfCscPhiHits) ){
  ATH_MSG_INFO("Types must match!");
}

Parameters

[in]	information	The information being requested. This is not guaranteed to be stored in all TrackParticles.
[out]	value	Only filled if this TrackParticle contains 'information', and the types match.

Returns

Returns 'true' if the TrackParticle contains 'information', and its concrete type matches 'value' (templated type T).

Definition at line 696 of file TrackParticle_v1.cxx.

                                                                                         {
    const xAOD::TrackParticle_v1::Accessor< float >* acc = trackSummaryAccessorV1<float>( information );
    if( ( ! acc ) || ( ! acc->isAvailable( *this ) ) ) return false;
  // Retrieve the value:
    value = ( *acc )( *this );
    return true;
  }

summaryValue() [2/2]

bool xAOD::TrackParticle_v1::summaryValue	(	uint8_t &	value,
		const SummaryType &	information ) const

Accessor for TrackSummary values.

If 'information' is stored in this TrackParticle and is of the correct templated type T, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'. See below for an example of how this is intended to be used.

int numberOfBLayerHits=0;
if( myParticle.summaryValue(numberOfBLayerHits,xAOD::numberOfBLayerHits) ){
  ATH_MSG_INFO("Successfully retrieved the integer value, numberOfBLayerHits");
}
float numberOfCscPhiHits=0.0; //Wrong! This is actually an int too.
if( !myParticle.summaryValue(numberOfCscPhiHits,xAOD::numberOfCscPhiHits) ){
  ATH_MSG_INFO("Types must match!");
}

Parameters

[in]	information	The information being requested. This is not guaranteed to be stored in all TrackParticles.
[out]	value	Only filled if this TrackParticle contains 'information', and the types match.

Returns

Returns 'true' if the TrackParticle contains 'information', and its concrete type matches 'value' (templated type T).

Definition at line 688 of file TrackParticle_v1.cxx.

                                                                                           {
    const xAOD::TrackParticle_v1::Accessor< uint8_t >* acc = trackSummaryAccessorV1<uint8_t>( information );
    if( ( ! acc ) || ( ! acc->isAvailable( *this ) ) ) return false;
  // Retrieve the value:
    value = ( *acc )( *this );
    return true;
  }

theta()

float xAOD::TrackParticle_v1::theta

(

)

const

Returns the \(\theta\) parameter, which has range 0 to \(\pi\).

time()

float xAOD::TrackParticle_v1::time

(

)

const

Returns the time.

Definition at line 161 of file TrackParticle_v1.cxx.

                                     {
    static const SG::AuxElement::Accessor< uint8_t > acc("hasValidTime");
    if( !acc.isAvailable( *this) || !static_cast<bool>(hasValidTime()) ) throw std::runtime_error( "Unavailable TrackParticle time requested" );
    static const SG::AuxElement::Accessor< float > accTime("time");
    return accTime( *this );
  }

timeResolution()

float xAOD::TrackParticle_v1::timeResolution

(

)

const

Returns the time resolution.

Definition at line 168 of file TrackParticle_v1.cxx.

                                               {
    static const SG::AuxElement::Accessor< uint8_t > acc("hasValidTime");
    if( !acc.isAvailable( *this) || !static_cast<bool>(hasValidTime()) ) throw std::runtime_error( "Unavailable TrackParticle timeResolution requested" );
    static const SG::AuxElement::Accessor< float > accTimeRes("timeResolution");
    return accTimeRes( *this );
  }

track()

const Trk::Track * xAOD::TrackParticle_v1::track

(

)

const

Returns a pointer (which can be NULL) to the Trk::Track which was used to make this TrackParticle.

Note

This is only available in Athena.

Definition at line 756 of file TrackParticle_v1.cxx.

                                                {
 
      // The accessor:
      static const ConstAccessor< ElementLink< TrackCollection > > acc( "trackLink" );
 
      if( ! acc.isAvailable( *this ) ) {
         return nullptr;
      }
      if( ! acc( *this ).isValid() ) {
         return nullptr;
      }
 
      return *( acc( *this ) );
   }

trackFitter()

xAOD::TrackFitter xAOD::TrackParticle_v1::trackFitter

(

)

const

Returns the fitter.

Definition at line 650 of file TrackParticle_v1.cxx.

                                                      {
    static const Accessor<uint8_t> acc("trackFitter");
    if (!acc.isAvailable(*this)) {
      return xAOD::NumberOfTrackFitters;
    }
    return static_cast<xAOD::TrackFitter>(acc(*this));
  }

trackLink()

const ElementLink< TrackCollection > & xAOD::TrackParticle_v1::trackLink

(

)

const

Returns a link (which can be invalid) to the Trk::Track which was used to make this TrackParticle.

The function will return an invalid ElementLink in case nothing was set for it yet.

Note

This is only available in Athena.

This is to avoid users having to always check both for the decoration being available, and the link being valid.

Returns

An element link to the parent Trk::Track of this track particle

Definition at line 730 of file TrackParticle_v1.cxx.

                                                                           {
 
      // The accessor:
      static const ConstAccessor< ElementLink< TrackCollection > > acc( "trackLink" );
 
      // Check if one of them is available:
      if( acc.isAvailable( *this ) ) {
         return acc( *this );
      }
 
      // If no Trk::Track link was not set (yet), return a dummy object:
      static const ElementLink< TrackCollection > dummy;
      return dummy;
   }

trackParameterCovarianceMatrix()

xAOD::ParametersCovMatrix_t xAOD::TrackParticle_v1::trackParameterCovarianceMatrix

(

unsigned int

index

)

const

Returns the TrackParticleCovMatrix_t (covariance matrix) at 'index', which corresponds to the parameters at the same index.

Definition at line 579 of file TrackParticle_v1.cxx.

  {
    static const Accessor< std::vector<float>  > acc( "trackParameterCovarianceMatrices" );
    unsigned int offset = index*15;
    // copy the correct values into the temp matrix
    xAOD::ParametersCovMatrix_t tmp;
    std::vector<float>::const_iterator it = acc(*this).begin()+offset;
    Amg::expand(it,it+15,tmp);
    return tmp;
  }

trackParameters()

const CurvilinearParameters_t xAOD::TrackParticle_v1::trackParameters

(

unsigned int

index

)

const

Returns the track parameter vector at 'index'.

Definition at line 512 of file TrackParticle_v1.cxx.

                                                                                         {
    CurvilinearParameters_t tmp;
    tmp << parameterX(index),parameterY(index),parameterZ(index),
      parameterPX(index),parameterPY(index),parameterPZ(index);
    return tmp;
  }

trackProperties()

TrackProperties xAOD::TrackParticle_v1::trackProperties

(

)

const

Access methods for track properties, which returns 'true' if a logical AND of the parameter 'proprty' and the stored properties returns true.

i.e. you do:

TrackProperties testProperty;
testProperty.set(SOMEPROPERTY);
if (trackParticle.trackProperties(testProperty)) doSomething();

Todo

• fix the above (or make something nicer)

type()

Type::ObjectType xAOD::TrackParticle_v1::type ( ) const

finaloverridevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 139 of file TrackParticle_v1.cxx.

                                              {
     return Type::TrackParticle;
  }

vx()

float xAOD::TrackParticle_v1::vx

(

)

const

The x origin for the parameters.

vy()

float xAOD::TrackParticle_v1::vy

(

)

const

The y origin for the parameters.

vz()

float xAOD::TrackParticle_v1::vz

(

)

const

The z origin for the parameters.

z0()

float xAOD::TrackParticle_v1::z0

(

)

const

Returns the \(z_0\) parameter.

Member Data Documentation

COVMATRIX_OFFDIAG_VEC_COMPR_SIZE

const std::size_t xAOD::TrackParticle_v1::COVMATRIX_OFFDIAG_VEC_COMPR_SIZE = TrackingDetails::COVMATRIX_OFFDIAG_VEC_COMPR_SIZE

staticprivate

Definition at line 350 of file TrackParticle_v1.h.

m_perigeeParameters

CxxUtils::CachedValue<Trk::Perigee> xAOD::TrackParticle_v1::m_perigeeParameters

private

Cached MeasuredPerigee, built from this object.

Note

This is only available in Athena.

Definition at line 369 of file TrackParticle_v1.h.

---

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

• TrackParticle_v1.h
• TrackParticle_v1.cxx