Class describing a TrackParticle. More...

#include <TrackParticle_v1.h>

Inheritance diagram for xAOD::TrackParticle_v1:

Collaboration diagram for xAOD::TrackParticle_v1:

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

Public Member Functions
	TrackParticle_v1 ()
	Default constructor. More...

	~TrackParticle_v1 ()
	Destructor. More...

	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. More...

TrackParticle_v1 &	operator= (const TrackParticle_v1 &tp)
	Assignment operator. This can involve creating and copying an Auxilary store, and so should be used sparingly. More...

bool	summaryValue (uint8_t &value, const SummaryType &information) const
	Accessor for TrackSummary values. More...

bool	summaryValue (float &value, const SummaryType &information) const
	Accessor for TrackSummary values. More...

void	setSummaryValue (uint8_t &value, const SummaryType &information)
	Set method for TrackSummary values. More...

void	setSummaryValue (float &value, const SummaryType &information)
	Set method for TrackSummary values. More...

void	resetCache ()
	Reset the internal cache of the object. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...

void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment. More...

const SG::AuxVectorData *	container () const
	Return the container holding this element. More...

SG::AuxVectorData *	container ()
	Return the container holding this element. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...

void	makePrivateStore ()
	Create a new (empty) private store for this object. More...

template<class U1 >
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

void	releasePrivateStore ()
	Release and free any private store associated with this object. More...

void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...

void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...

void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`. More...

void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`. More...

bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...

bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...

const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...

SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...

void	clearCache ()
	Clear the cached aux data pointers. More...

const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...

const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object. More...

bool	hasStore () const
	Return true if this object has an associated store. More...

bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...

bool	clearDecorations () const
	Clear all decorations. More...

bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...

size_t	index () const
	Return the index of this element within its container. More...

size_t	index () const
	Return the index of this element within its container. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...

bool	havePrivateData () const
	True if this element currently has private data. More...

bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	covMatrixIndex { d0_index =0, z0_index =1, phi_index =2, th_index =3, qp_index =4 }

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

enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...

void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data. More...

AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	clearAux ()
	Clear all aux data associated with this element. More...

void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object. More...

void	setNoPrivateData ()
	Record that this element does not have private data. More...

void	setHavePrivateData ()
	Record that this element currently has private data. More...

void	setHadPrivateData ()
	Record that this element used to have private data. More...

Static Private Member Functions
static const covMatrixIndexPairVec &	covMatrixComprIndexPairs ()

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

const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...

size_t	m_index
	The index of this element within its container. More...

PrivateStoreState	m_privateStoreState

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

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. More...

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. More...

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. More...

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. More...

IParticle functions
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type. More...

typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for TrackParticle. More...

virtual double	pt () const override final
	The transverse momentum ( \(p_T\)) of the particle. More...

virtual double	eta () const override final
	The pseudorapidity ( \(\eta\)) of the particle. More...

virtual double	phi () const override final
	The azimuthal angle ( \(\phi\)) of the particle (has range \(-\pi\) to \(+\pi\).) More...

virtual double	m () const override final
	The invariant mass of the particle.. More...

virtual double	e () const override final
	The total energy of the particle. More...

virtual double	rapidity () const override final
	The true rapidity (y) of the particle. More...

virtual FourMom_t	p4 () const override final
	The full 4-momentum of the particle. More...

GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector form. More...

virtual Type::ObjectType	type () const override final
	The type of the object as a simple enumeration. More...

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. More...

float	d0 () const
	Returns the \(d_0\) parameter. More...

float	z0 () const
	Returns the \(z_0\) parameter. More...

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

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

float	qOverP () const
	Returns the \(q/p\) parameter. More...

float	time () const
	Returns the time. More...

float	timeResolution () const
	Returns the time resolution. More...

uint8_t	hasValidTime () const
	Returns whether or not the track has a valid time. More...

DefiningParameters_t	definingParameters () const
	Returns a SVector of the Perigee track parameters. More...

const ParametersCovMatrix_t	definingParametersCovMatrix () const
	Returns the 5x5 symmetric matrix containing the defining parameters covariance matrix. More...

ParametersCovMatrixFilled_t	definingParametersCovMatrixFilled () const
	Returns a 5x5 matrix describing which elements of the covariance matrix are known. More...

const std::vector< float > &	definingParametersCovMatrixDiagVec () const
	Returns the diagonal elements of the defining parameters covariance matrix. More...

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)) More...

std::vector< float >	definingParametersCovMatrixVec () const
	Returns the length 6 vector containing the elements of defining parameters covariance matrix. More...

bool	definingParametersCovMatrixOffDiagCompr () const

void	setDefiningParameters (float d0, float z0, float phi0, float theta, float qOverP)
	Set the defining parameters. More...

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. More...

void	setDefiningParametersCovMatrixDiagVec (const std::vector< float > &vec)
	Set the defining parameters covariance matrix using a length 15 vector. More...

void	setDefiningParametersCovMatrixOffDiagVec (const std::vector< float > &vec)
	Set the off-diagonal elements of the defining parameters covariance matrix. More...

void	setDefiningParametersCovMatrixVec (const std::vector< float > &cov)

void	compressDefiningParametersCovMatrixOffDiag ()
	Delete some off-diagonal elements for compression. More...

float	vx () const
	The x origin for the parameters. More...

float	vy () const
	The y origin for the parameters. More...

float	vz () const
	The z origin for the parameters. More...

void	setParametersOrigin (float x, float y, float z)
	Set the origin for the parameters. More...

const Trk::Perigee &	perigeeParameters () const
	Returns the Trk::MeasuredPerigee track parameters. More...

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. More...

const CurvilinearParameters_t	trackParameters (unsigned int index) const
	Returns the track parameter vector at 'index'. More...

float	parameterX (unsigned int index) const
	Returns the parameter x position, for 'index'. More...

float	parameterY (unsigned int index) const
	Returns the parameter y position, for 'index'. More...

float	parameterZ (unsigned int index) const
	Returns the parameter z position, for 'index'. More...

float	parameterPX (unsigned int index) const
	Returns the parameter x momentum component, for 'index'. More...

float	parameterPY (unsigned int index) const
	Returns the parameter y momentum component, for 'index'. More...

float	parameterPZ (unsigned int index) const
	Returns the parameter z momentum component, for 'index'. More...

void	setTrackParameters (std::vector< std::vector< float > > &parameters)
	Set the parameters via the passed vector of vectors. More...

ParametersCovMatrix_t	trackParameterCovarianceMatrix (unsigned int index) const
	Returns the TrackParticleCovMatrix_t (covariance matrix) at 'index', which corresponds to the parameters at the same index. More...

void	setTrackParameterCovarianceMatrix (unsigned int index, std::vector< float > &cov)
	Set the cov matrix of the parameter at 'index', using a vector of floats. More...

xAOD::ParameterPosition	parameterPosition (unsigned int index) const
	Return the ParameterPosition of the parameters at 'index'. More...

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. More...

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. More...

const Trk::CurvilinearParameters	curvilinearParameters (unsigned int index) const
	Returns a curvilinear representation of the parameters at 'index'. More...

float	radiusOfFirstHit () const
	Returns the radius of the first hit. More...

void	setRadiusOfFirstHit (float radius)
	Set the radius of the first hit. More...

uint64_t	identifierOfFirstHit () const
	Returns the offline identifier of the first hit. More...

void	setIdentifierOfFirstHit (uint64_t id)
	Set the offline identifier of the first hit. More...

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. More...

float	numberDoF () const
	Returns the number of degrees of freedom of the overall track or vertex fit as float. More...

void	setFitQuality (float chiSquared, float numberDoF)
	Set the 'Fit Quality' information. More...

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. More...

void	setPatternRecognitionInfo (const std::bitset< xAOD::NumberOfTrackRecoInfo > &patternReco)
	Method setting the pattern recognition algorithm, using a bitset. More...

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

void	setTrackFitter (const TrackFitter fitter)
	Method for setting the fitter, using the TrackFitter enum. More...

void	setParticleHypothesis (const ParticleHypothesis hypo)
	Method for setting the particle type, using the ParticleHypothesis enum. More...

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. More...

std::bitset< NumberOfTrackRecoInfo >	patternRecoInfo () const
	Access method for pattern recognition algorithm. More...

ParticleHypothesis	particleHypothesis () const
	Returns the particle hypothesis used for Track fitting. More...

TrackFitter	trackFitter () const
	Returns the fitter. More...

Links
const ElementLink< TrackCollection > &	trackLink () const
	Returns a link (which can be invalid) to the Trk::Track which was used to make this TrackParticle. More...

void	setTrackLink (const ElementLink< TrackCollection > &track)
	Set the link to the original track. More...

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

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 43 of file TrackParticle_v1.h.

Member Typedef Documentation

◆ Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 572 of file AuxElement.h.

◆ ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 569 of file AuxElement.h.

◆ covMatrixIndexPairVec

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

private

Definition at line 350 of file TrackParticle_v1.h.

◆ Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 575 of file AuxElement.h.

◆ FourMom_t

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

Definition of the 4-momentum type.

Definition at line 72 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 78 of file TrackParticle_v1.h.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ covMatrixIndex

enum xAOD::TrackParticle_v1::covMatrixIndex

private

Enumerator
d0_index
z0_index
phi_index
th_index
qp_index

Definition at line 348 of file TrackParticle_v1.h.

348 {d0_index=0, z0_index=1, phi_index=2, th_index=3, qp_index=4};

◆ PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

   {
     NO_PRIVATE = 0,
     HAVE_PRIVATE = 1,
     HAD_PRIVATE = 2,
   };

Constructor & Destructor Documentation

◆ TrackParticle_v1() [1/2]

xAOD::TrackParticle_v1::TrackParticle_v1 ( )

Default constructor.

Definition at line 45 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 71 of file TrackParticle_v1.cxx.

71 {}

◆ 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 50 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

◆ assign()

void SG::AuxElement::assign	(	const AuxElement &	other,
		bool	warnUnlocked = `false`
	)

inherited

Assignment.

Parameters

other	The object from which we're assigning.
warnUnlocked	If true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

◆ auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

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

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdata() [3/4]

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

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 );
       }

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ 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 150 of file TrackParticle_v1.cxx.

                                        {
     // static Accessor< float > acc( "charge" );
     return (qOverP() > 0) ? 1 : ((qOverP() < 0) ? -1 : 0);
   }

◆ chiSquared()

float xAOD::TrackParticle_v1::chiSquared ( ) const

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

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 580 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     r.clear (auxid, *container(), index(), 1);
   }
 }

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 339 of file AuxElement.cxx.

 {
   if (container())
     container()->clearCache();
 }

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 428 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->clearDecorations();
   return false;
 }

◆ compressDefiningParametersCovMatrixOffDiag()

void xAOD::TrackParticle_v1::compressDefiningParametersCovMatrixOffDiag ( )

Delete some off-diagonal elements for compression.

Definition at line 436 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;
  
   }

◆ container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux	(	const ConstAuxElement &	other,
		bool	warnUnlocked = `false`
	)

privateinherited

Copy aux data from another object.

Parameters

other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 607 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("copyAux");
  
   const SG::AuxVectorData* ocont = other.container();
  
   if (!ocont || !ocont->hasStore()) {
     this->clearAux();
     return;
   }
  
   size_t oindex = other.index();
   SG::auxid_set_t other_ids = ocont->getAuxIDs();
 #ifndef XAOD_STANDALONE
   SG::auxid_set_t other_decors = ocont->getDecorIDs();
 #endif
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
 #ifndef XAOD_STANDALONE
     if (other_decors.test (auxid)) {
       // Don't copy decorations --- another thread may be modifying them.
       other_ids.reset (auxid);
       // Warn if we skip a decoration (except for mcEventWeights,
       // for which this is expected).
       if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
         std::ostringstream ss;
         ss << "skipped unlocked decoration " << r.getName(auxid)
            << " (" << auxid << ")";
         ATHCONTAINERS_WARNING("copyAux", ss.str());
       }
     }
     else
 #endif
     if (!r.isLinked (auxid)) {
       r.copy (auxid, cont, index(), *ocont, oindex, 1);
     }
   }
  
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     if (!other_ids.test (auxid)) {
       r.clear (auxid, cont, index(), 1);
     }
   }
 }

◆ covMatrixComprIndexPairs()

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

staticprivate

Definition at line 764 of file TrackParticle_v1.cxx.

                                                                                          {
     static const covMatrixIndexPairVec result {
       {d0_index,phi_index}, {z0_index,th_index}, {d0_index,qp_index},
       {z0_index,qp_index}, {phi_index,qp_index}, {th_index,qp_index} };
     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 673 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 171 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 246 of file TrackParticle_v1.cxx.

                                                                                       {
  
         // Set up the result matrix.
     xAOD::ParametersCovMatrix_t cov;
     cov.setZero();
  
     // Set the diagonal elements of the matrix.
     if( accCovMatrixDiag.isAvailable( *this ) &&
         ( static_cast< int >( accCovMatrixDiag( *this ).size() ) == cov.rows() ) ) {
  
         // Access the "raw" variable.
         const std::vector< float >& diagVec = accCovMatrixDiag( *this );
         // Set the diagonal elements using the raw variable.
         for( int i = 0; i < cov.rows(); ++i ) {
           cov( i, i ) = diagVec[ i ];
         }
     } else {
       xAODTrackParticlePrivate::covarianceUnsetHook();
       // If the variable is not available/set, set the matrix to identity.
       cov.setIdentity();
     }
  
     bool offDiagCompr = definingParametersCovMatrixOffDiagCompr();
  
     // Set the off-diagonal elements of the matrix.
     if(!offDiagCompr){
  
       if( accCovMatrixOffDiag.isAvailable( *this ) &&
       ( static_cast< int >( accCovMatrixOffDiag( *this ).size() ) ==
         ( ( ( cov.rows() - 1 ) * cov.rows() ) / 2 ) ) ) {
  
     // Access the "raw" variable.
     const std::vector< float >& offDiagVec = accCovMatrixOffDiag( *this );
     // Set the off-diagonal elements using the raw variable.
     std::size_t vecIndex = 0;
     for( int i = 1; i < cov.rows(); ++i ) {
       for( int j = 0; j < i; ++j, ++vecIndex ) {
         float offDiagCoeff = cov(i,i)>0 && cov(j,j)>0 ? offDiagVec[vecIndex]*sqrt(cov(i,i)*cov(j,j)) : 0;
         cov.fillSymmetric( i, j, offDiagCoeff );
       }
     }
       }
  
       else xAODTrackParticlePrivate::covarianceUnsetHook();
  
     }
  
     else{ //Compressed case
  
       if( accCovMatrixOffDiag.isAvailable( *this ) &&
       ( static_cast< int >( accCovMatrixOffDiag( *this ).size() ) == COVMATRIX_OFFDIAG_VEC_COMPR_SIZE ) ) {
     // Access the "raw" variable.
     const std::vector< float >& offDiagVec = accCovMatrixOffDiag( *this );
     // Set the off-diagonal elements using the raw variable.
  
     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 offDiagCoeff = cov(i,i)>0 && cov(j,j)>0 ? offDiagVec[k]*sqrt(cov(i,i)*cov(j,j)) : 0;
       cov.fillSymmetric( i, j, offDiagCoeff );
     }
  
       }
  
       else xAODTrackParticlePrivate::covarianceUnsetHook();
  
     }
  
  
     // Return the filled matrix.
     return cov;
  
   }

◆ definingParametersCovMatrixDiagVec()

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

Returns the diagonal elements of the defining parameters covariance matrix.

Definition at line 375 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 323 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 429 of file TrackParticle_v1.cxx.

                                                                        {
  
     bool flag = false;
     if(accCovMatrixOffDiag.isAvailable( *this )) flag = (static_cast< int >(accCovMatrixOffDiag( *this ).size())==COVMATRIX_OFFDIAG_VEC_COMPR_SIZE);
     return flag;
   }

◆ 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 380 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 385 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 109 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 77 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 116 of file TrackParticle_v1.cxx.

                                                                    {
     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);
     return GenVecFourMom_t(px, py, pz, m());
   }

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 355 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getAuxIDs();
   if (container())
     return container()->getAuxIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getAuxIDs();
 #endif
 }

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 304 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
     return m_container->getConstStore();
   }
   return 0;
 }

◆ getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const

inherited

Return a set of identifiers for decorations for this object.

   If this object has a private or standalone store, then information
   from that will be returned.  Otherwise, if this element
   is part of a container, then information for the container
   will be returned.  Otherwise, return an empty set.

Definition at line 378 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getDecorIDs();
   if (container())
     return container()->getDecorIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getDecorIDs();
 #endif
 }

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 319 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
 #ifdef ATHCONTAINERS_R21_COMPAT
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
 #else
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
 #endif
     return container_nc->getStore();
   }
   return 0;
 }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 411 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasNonConstStore();
   return false;
 }

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 398 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasStore();
   return false;
 }

◆ hasValidTime()

uint8_t xAOD::TrackParticle_v1::hasValidTime ( ) const

Returns whether or not the track has a valid time.

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ hitPattern()

uint32_t xAOD::TrackParticle_v1::hitPattern ( ) const

◆ identifierOfFirstHit()

uint64_t xAOD::TrackParticle_v1::identifierOfFirstHit ( ) const

Returns the offline identifier of the first hit.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ 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 653 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() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)

inherited

Check if an aux variable is available for writing.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritable() [2/2]

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);
       }

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ m()

double xAOD::TrackParticle_v1::m ( ) const

finaloverridevirtual

The invariant mass of the particle..

Implements xAOD::IParticle.

Definition at line 83 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 0.510998;
        }
     }
     if (hypo == xAOD::muon) {
        return 105.658367;
     }
     // default charged pion
     return 139.570;
   }

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 192 of file AuxElement.cxx.

 {
   if (m_container) {
     throw SG::ExcBadPrivateStore ("store already exists");
   }
  
   m_container = new SG::AuxElementPrivateData;
   IAuxElement::setIndex (0);
   IAuxElement::setHavePrivateData();
 }

◆ makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore	(	const U1 &	other,
		bool	warnUnlocked = `false`
	)

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore	(	const U1 *	other,
		bool	warnUnlocked = `false`
	)

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1	(	const AuxElement *	other,
		bool	warnUnlocked
	)

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 565 of file AuxElement.cxx.

 {
   makePrivateStore();
   if (other)
     this->copyAux (*other, warnUnlocked);
 }

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1	(	const void *	other,
		bool	warnUnlocked
	)

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ 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 553 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 57 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 129 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 647 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 612 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 617 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 622 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 597 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 602 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 607 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 728 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 706 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 485 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 158 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 73 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 112 of file TrackParticle_v1.cxx.

                                           {
     return genvecP4().Rapidity();
   }

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 210 of file AuxElement.cxx.

 {
   if (hadPrivateData()) {
     // We had a private store, but it was released because this object
     // was added to a container.  Just forget about it.
     IAuxElement::setNoPrivateData();
     return;
   }
  
   if (!havePrivateData() ||
       !m_container ||
       typeid(*m_container) != typeid(AuxElementPrivateData))
   {
     throw SG::ExcBadPrivateStore ("no private store exists");
   }
  
   IAuxElement::setIndex (0);
   IAuxElement::setNoPrivateData();
   delete m_container;
   m_container = 0;
 }

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData()) {
     delete m_container;
   }
 #else
   ConstAuxElement::releasePrivateStoreForDtor();
 #endif
 }

◆ resetCache()

void xAOD::TrackParticle_v1::resetCache ( )

Reset the internal cache of the object.

Definition at line 821 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 )

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ 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 177 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 202 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 213 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 394 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 408 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 460 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 534 of file TrackParticle_v1.cxx.

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

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHasValidTime()

void xAOD::TrackParticle_v1::setHasValidTime ( uint8_t hasValidTime )

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ 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.

◆ setIndex()

void SG::AuxElement::setIndex	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 505 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (hadPrivateData()) {
     // We had a private store, but it was released because we were added
     // to a container.
  
     if (container == 0) {
       // We're being moved out of the container.  Make a new private
       // store, copy the data, and switch to it.
       auto privateData = new SG::AuxElementPrivateData;
       AuxElement to (privateData, 0);
       to.copyAux (*this);
       IAuxElement::setIndex (0);
       IAuxElement::setHavePrivateData();
       m_container = privateData;
       return true;
     }
   }
   else if (havePrivateData() &&
            typeid(*m_container) == typeid(AuxElementPrivateData))
   {
     // We currently have a private store.
  
     if (container != 0 && container != m_container) {
       // We're being added to a container.
       // Aux data has already been copied.
       // Release private store.
       IAuxElement::setIndex (index);
       IAuxElement::setHadPrivateData();
       delete m_container;
       m_container = container;
       return false;
     }
   }
   else {
     // We have a standalone store.
     throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                   "from a container.");
   }
  
   IAuxElement::setIndex (index);
   m_container = container;
   return false;
 #else
   return ConstAuxElement::setIndexPrivate (index, container);
 #endif
 }

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ 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 667 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 473 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 723 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 718 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 713 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.

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store Link to the new store.

Definition at line 269 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 241 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 257 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 461 of file AuxElement.cxx.

 {
   if (store) {
     // Want this object be standalone.
     if (!m_container) {
       // Not in a container (and no private store).  Make a new object.
       AuxElementStandaloneData* data = new AuxElementStandaloneData;
       IAuxElement::setHavePrivateData();
       m_container = data;
       return data;
     }
     if (usingStandaloneStore()) {
       // Standalone --- return existing object.
       return static_cast<AuxElementStandaloneData*> (container());
     }
     // Otherwise, it's an error.
     throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                               "object in a container or with a private store.");
   }
  
   else {
     // Getting rid of a standalone store.
     if (usingStandaloneStore()) {
       IAuxElement::setNoPrivateData();
       delete m_container;
       m_container = 0;
     }
     else if (m_container != 0)
       throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                 "object in a container or with a private store.");
     return 0;
   }
 }

◆ setSummaryValue() [1/2]

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

Set method for TrackSummary values.

Definition at line 758 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 752 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 )

◆ setTimeResolution()

void xAOD::TrackParticle_v1::setTimeResolution ( float timeResolution )

◆ setTrackFitter()

void xAOD::TrackParticle_v1::setTrackFitter ( const TrackFitter fitter )

Method for setting the fitter, using the TrackFitter enum.

Definition at line 693 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 794 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 638 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 567 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 744 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 736 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.

◆ timeResolution()

float xAOD::TrackParticle_v1::timeResolution ( ) const

Returns the time resolution.

◆ 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 805 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 698 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));
   }

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

◆ 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 779 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 627 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 560 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 146 of file TrackParticle_v1.cxx.

                                               {
      return Type::TrackParticle;
   }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 280 of file AuxElement.cxx.

 {
   return havePrivateData() && 
     typeid(*m_container) == typeid(AuxElementPrivateData);
 }

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 290 of file AuxElement.cxx.

 {
   return havePrivateData() &&
     typeid(*m_container) == typeid(AuxElementStandaloneData);
 }

◆ 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 = 6

staticprivate

Definition at line 349 of file TrackParticle_v1.h.

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 335 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.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 368 of file TrackParticle_v1.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 959 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Functions for getting and setting user properties

IParticle functions

Defining parameters functions

Curvilinear functions

Fit quality functions

TrackInfo functions

Links

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ covMatrixIndexPairVec

◆ Decorator

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ covMatrixIndex

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ TrackParticle_v1() [1/2]

◆ ~TrackParticle_v1()

◆ TrackParticle_v1() [2/2]

Member Function Documentation

◆ assign()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ beamlineTiltX()

◆ beamlineTiltY()

◆ charge()

◆ chiSquared()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ compressDefiningParametersCovMatrixOffDiag()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ covMatrixComprIndexPairs()

◆ curvilinearParameters()

◆ d0()

◆ definingParameters()

◆ definingParametersCovMatrix()

◆ definingParametersCovMatrixDiagVec()

◆ definingParametersCovMatrixFilled()

◆ definingParametersCovMatrixOffDiagCompr()

◆ definingParametersCovMatrixOffDiagVec()

◆ definingParametersCovMatrixVec()

◆ e()

◆ eta()

◆ genvecP4()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ hasValidTime()

◆ havePrivateData()

◆ hitPattern()

◆ identifierOfFirstHit()

◆ index() [1/2]

◆ index() [2/2]

◆ indexOfParameterAtPosition()