Class describing a truth particle in the MC record. More...

#include <TruthParticle_v1.h>

Inheritance diagram for xAOD::TruthParticle_v1:

Collaboration diagram for xAOD::TruthParticle_v1:

Classes
struct	Polarization
	Single container for full polarization information. More...

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	Decorator = SG::Decorator<T, ALLOC>

Public Member Functions
	TruthParticle_v1 ()
	Default constructor.
void	toPersistent ()
	Function making sure that the object is ready for persistification.
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.
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.
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.
void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
const SG::AuxVectorData *	container () const
	Return the container holding this element.
SG::AuxVectorData *	container ()
	Return the container holding this element.
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.
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.
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.
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.
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.
void	makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	releasePrivateStore ()
	Release and free any private store associated with this object.
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`.
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`.
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
void	clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	hasStore () const
	Return true if this object has an associated store.
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	clearDecorations () const
	Clear all decorations.
bool	trackIndices () const
	Return true if index tracking is enabled for this object.
size_t	index () const
	Return the index of this element within its container.
Functions identifying the particle in the MC record
void	setPdgId (int pid)
	Set PDG ID code.
int	pdgId () const
	PDG ID code.
int	pdg_id () const
	PDG ID code.
int	absPdgId () const
	Absolute PDG ID code (often useful)
int	uid () const
	Unique ID.
void	setUid (int value)
	Set unique ID.
int	status () const
	Status code.
void	setStatus (int value)
	Set status code.
Links to the production and decay vertices
bool	hasProdVtx () const
	Check for a production vertex on this particle.
const TruthVertex_v1 *	prodVtx () const
	The production vertex of this particle.
const TruthVertex_v1 *	production_vertex () const
	The production vertex of this particle.
const ElementLink< TruthVertexContainer > &	prodVtxLink () const
	The production vertex link of this particle.
void	setProdVtxLink (const ElementLink< TruthVertexContainer > &link)
	Set the production vertex of the particle.
bool	hasDecayVtx () const
	Check for a decay vertex on this particle.
const TruthVertex_v1 *	decayVtx () const
	The decay vertex of this particle.
const TruthVertex_v1 *	end_vertex () const
	The decay vertex of this particle.
const ElementLink< TruthVertexContainer > &	decayVtxLink () const
	The decay vertex link of this particle.
void	setDecayVtxLink (const ElementLink< TruthVertexContainer > &link)
	Set the decay vertex of the particle.
Particle connection / origin / decay information
size_t	nParents () const
	Number of parents of this particle.
const TruthParticle_v1 *	parent (size_t i) const
	Retrieve the i-th mother (TruthParticle) of this TruthParticle.
size_t	nChildren () const
	Number of children of this particle.
const TruthParticle_v1 *	child (size_t i) const
	Retrieve the i-th mother (TruthParticle) of this TruthParticle.
4-momentum accessors specific to truth particles
double	abseta () const
	The absolute pseudorapidity ( \(\|\eta\|\)) of the particle.
double	absrapidity () const
	The true absolute rapidity ( \(\|y\|\)) of the particle.
float	px () const
	The x component of the particle's momentum.
void	setPx (float value)
	Set the x component of the particle's momentum.
float	py () const
	The y component of the particle's momentum.
void	setPy (float value)
	Set the y component of the particle's momentum.
float	pz () const
	The z component of the particle's momentum.
void	setPz (float value)
	Set the z component of the particle's momentum.
void	setE (float value)
	Set the energy of the particle.
void	setM (float value)
	Also store the mass.
Particle species information
Just convenience methods here, since they all just forward to the utility functions operating on the PDG particle ID code.
double	charge () const
	Physical charge.
int	threeCharge () const
	3 x the physical charge (so it can be an int for quarks)
bool	isCharged () const
	Whether the particle is electrically charged.
bool	isNeutral () const
	Whether the particle is electrically neutral.
bool	isPhoton () const
	Whether the particle is a photon.
bool	isLepton () const
	Whether the particle is a lepton.
bool	isChLepton () const
	Whether the particle is a charged lepton.
bool	isElectron () const
	Whether the particle is an electron (or positron)
bool	isMuon () const
	Whether the particle is a muon (or antimuon)
bool	isTau () const
	Whether the particle is a tau (or antitau)
bool	isNeutrino () const
	Whether the particle is a neutrino (or antineutrino)
bool	isHadron () const
	Whether the particle is a hadron.
bool	isMeson () const
	Whether the particle is a meson.
bool	isBaryon () const
	Whether the particle is a baryon.
bool	hasStrange () const
	Whether the particle contains a strange quark (or antiquark)
bool	hasCharm () const
	Whether the particle contains a charm quark (or antiquark)
bool	hasBottom () const
	Whether the particle contains a bottom quark (or antiquark)
bool	isLightMeson () const
	Determine if the PID is that of a light flavour (not b or c) meson.
bool	isLightBaryon () const
	Determine if the PID is that of a light flavour (not b or c) baryon.
bool	isLightHadron () const
	Determine if the PID is that of a light flavour (not b or c) hadron.
bool	isHeavyMeson () const
	Determine if the PID is that of a heavy flavour (b or c) meson.
bool	isHeavyBaryon () const
	Determine if the PID is that of a heavy flavour (b or c) baryon.
bool	isHeavyHadron () const
	Determine if the PID is that of a heavy flavour (b or c) hadron.
bool	isBottomMeson () const
	Determine if the PID is that of a b-meson.
bool	isBottomBaryon () const
	Determine if the PID is that of a b-baryon.
bool	isBottomHadron () const
	Determine if the PID is that of a b-hadron.
bool	isCharmMeson () const
	Determine if the PID is that of a c-meson.
bool	isCharmBaryon () const
	Determine if the PID is that of a c-baryon.
bool	isCharmHadron () const
	Determine if the PID is that of a c-hadron.
bool	isStrangeMeson () const
	Determine if the PID is that of a strange meson.
bool	isStrangeBaryon () const
	Determine if the PID is that of a strange baryon.
bool	isStrangeHadron () const
	Determine if the PID is that of a strange hadron.
bool	isQuark () const
	Check if this particle is a quark.
bool	isParton () const
	Check if this particle is a parton.
bool	isTop () const
	Check if this particle is a top quark.
bool	isW () const
	Check if this particle is a W boson.
bool	isZ () const
	Check if this particle is a Z boson.
bool	isHiggs () const
	Check if this particle is a Higgs boson.
bool	isResonance () const
	Check if this particle is a resonant state.
bool	isGenSpecific () const
	Check if this is a generator specific (non-physical) particle.
bool	isBSM () const
	Check if this is a BSM particle.
bool	isGenStable () const
	Check if this is generator stable particle.
bool	isStable () const
	Check if this is a stable particle (generator or simulation produced)
bool	isSimulationParticle () const
	Check if this particle was produced during the simulation.
Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

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

Protected Types
template<class T, class ALLOC = AuxAllocator_t<T>>
using	Accessor

Protected Member Functions
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface.
bool	noPrivateData () const
	True if this element has no private data.
bool	havePrivateData () const
	True if this element currently has private data.
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container.

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

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor.
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	clearAux ()
	Clear all aux data associated with this element.
void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object.
void	setNoPrivateData ()
	Record that this element does not have private data.
void	setHavePrivateData ()
	Record that this element currently has private data.
void	setHadPrivateData ()
	Record that this element used to have private data.

Static Private Member Functions
static void	clearAuxHelper (AuxVectorData &container, size_t index)
	Clear all aux data associated with an element.
static void	copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
	Copy aux data from another object.

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element.
size_t	m_index
	The index of this element within its container.
PrivateStoreState	m_privateStoreState

Polarization properties (optional)
enum	PolParam { polarizationPhi = 0 , polarizationTheta = 1 }
	Polarization parameter types. More...
bool	polarizationParameter (float &value, PolParam parameter) const
	Accessor for polarization parameters.
bool	setPolarizationParameter (float value, PolParam parameter)
	Set method for polarization parameter values.
float	polarizationParameter (PolParam parameter) const
	Convenience accessor for a polariozation parameter.
Polarization	polarization () const
	Retrieve a full Polarization with a single call.

Functions implementing the xAOD::IParticle interface
Todo Add mappings of e.g. isPrimary, isDecayed, isPrompt, isFromDecay, hasHadronicDecay, hasLeptonicDecay, isHadronic/LeptonicTau ... Todo Add isFirstWith, isLastWith
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzE4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for TruthParticle.
virtual double	pt () const override final
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const override final
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const override final
	The azimuthal angle ( \(\phi\)) of the particle.
virtual double	m () const override final
	The mass of the particle.
virtual double	e () const override final
	The total energy of the particle.
virtual double	rapidity () const override final
	The true rapidity ( \(y\)) of the particle.
virtual FourMom_t	p4 () const override final
	The full 4-momentum of the particle.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector form.
virtual Type::ObjectType	type () const override final
	The type of the object as a simple enumeration.

Detailed Description

Class describing a truth particle in the MC record.

The xAOD truth record mimicks the structure of HepMC. Truth particles and truth vertices form a decay tree. Where each truth particle is connected to a single production and decay vertex. And each vertex is connected to one or more incoming, and one or more outgoing particles.

Author: Andy Buckley Andy..nosp@m.Buck.nosp@m.ley@c.nosp@m.ern..nosp@m.ch; Jovan Mitrevski Jovan.nosp@m..Mit.nosp@m.revsk.nosp@m.i@ce.nosp@m.rn.ch

Definition at line 37 of file TruthParticle_v1.h.

Member Typedef Documentation

◆ Accessor

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

using SG::AuxElement::Accessor

protectedinherited

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.

◆ 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::TruthParticle_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 142 of file TruthParticle_v1.h.

◆ GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > xAOD::TruthParticle_v1::GenVecFourMom_t

Base 4 Momentum type for TruthParticle.

Definition at line 152 of file TruthParticle_v1.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ PolParam

enum xAOD::TruthParticle_v1::PolParam

Polarization parameter types.

Enumerator
polarizationPhi	Polarization in ( \(\phi\))
polarizationTheta	Polarization in ( \(\theta\))

Definition at line 316 of file TruthParticle_v1.h.

                    {
         polarizationPhi   = 0, 
         polarizationTheta = 1  
      };

◆ PrivateStoreState

enum class 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

◆ TruthParticle_v1()

xAOD::TruthParticle_v1::TruthParticle_v1 ( )

Default constructor.

Definition at line 31 of file TruthParticle_v1.cxx.

   : IParticle() {
 
   }

Member Function Documentation

◆ abseta()

double xAOD::TruthParticle_v1::abseta ( ) const

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

Todo: Remove this when/if supported in xAOD::IParticle

Definition at line 213 of file TruthParticle_v1.cxx.

                                         {
 
      return std::abs( eta() );
   }

◆ absPdgId()

int xAOD::TruthParticle_v1::absPdgId ( ) const

Absolute PDG ID code (often useful)

◆ absrapidity()

double xAOD::TruthParticle_v1::absrapidity ( ) const

The true absolute rapidity ( \(|y|\)) of the particle.

Todo: Remove this when/if supported in xAOD::IParticle

Definition at line 218 of file TruthParticle_v1.cxx.

                                              {
 
      return std::abs( rapidity() );
   }

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

◆ charge()

double xAOD::TruthParticle_v1::charge ( ) const

Physical charge.

◆ child()

const TruthParticle_v1 * xAOD::TruthParticle_v1::child ( size_t i ) const

Retrieve the i-th mother (TruthParticle) of this TruthParticle.

Definition at line 144 of file TruthParticle_v1.cxx.

                                                                   {
      if (hasDecayVtx() && decayVtx()->nOutgoingParticles()>0){
        return decayVtx()->outgoingParticle( i );
      } else if ( acc_childLinks.isAvailable( *this ) && i<acc_childLinks( *this ).size() ) {
        return acc_childLinks( *this )[i].isValid() ? *(acc_childLinks( *this )[i]) : nullptr;
      }
      return nullptr;
   }

◆ 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;
  clearAuxHelper (*container(), index());
}

◆ clearAuxHelper()

void SG::AuxElement::clearAuxHelper	(	AuxVectorData &	container,
		size_t	index )

staticprivateinherited

Clear all aux data associated with an element.

Parameters

container	Container of the element.
index	Index of this element within the container.

If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 639 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore()) {
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  }
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : 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;
}

◆ 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 600 of file AuxElement.cxx.

{
  if (!m_container) return;
  copyAuxHelper (*container(), index(), other, warnUnlocked);
}

◆ copyAuxHelper()

void SG::AuxElement::copyAuxHelper	(	AuxVectorData &	container,
		size_t	index,
		const ConstAuxElement &	other,
		bool	warnUnlocked )

staticprivateinherited

Copy aux data from another object.

Parameters

container	Container of the element.
index	Index of this element within the container.
other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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 667 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    AuxElement::clearAuxHelper (container, index);
    return;
  }
 
#ifndef XAOD_STANDALONE
  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
#endif
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  size_t oindex = other.index();
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  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, container, index, *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, container, index, 1);
    }
  }
}

◆ decayVtx()

const TruthVertex_v1 * xAOD::TruthParticle_v1::decayVtx ( ) const

The decay vertex of this particle.

◆ decayVtxLink()

const ElementLink< TruthVertexContainer > & xAOD::TruthParticle_v1::decayVtxLink ( ) const

The decay vertex link of this particle.

◆ e()

virtual double xAOD::TruthParticle_v1::e ( ) const

finaloverridevirtual

The total energy of the particle.

Implements xAOD::IParticle.

◆ end_vertex()

const TruthVertex_v1 * xAOD::TruthParticle_v1::end_vertex ( ) const

inline

The decay vertex of this particle.

Definition at line 90 of file TruthParticle_v1.h.

90{ return decayVtx();}

◆ eta()

double xAOD::TruthParticle_v1::eta ( ) const

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 169 of file TruthParticle_v1.cxx.

                                      {
 
      // Calculate the pseudo-rapidity using TLorentzVector.
      // Could do something more lightweight later on.
      return genvecP4().Eta();
   }

◆ genvecP4()

TruthParticle_v1::GenVecFourMom_t xAOD::TruthParticle_v1::genvecP4 ( ) const

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

Definition at line 196 of file TruthParticle_v1.cxx.

                                                                    {
     return GenVecFourMom_t(px(), py(), pz(), e() );
   }

◆ 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

protectedinherited

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 869 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

protectedinherited

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

◆ hasBottom()

bool xAOD::TruthParticle_v1::hasBottom ( ) const

Whether the particle contains a bottom quark (or antiquark)

◆ hasCharm()

bool xAOD::TruthParticle_v1::hasCharm ( ) const

Whether the particle contains a charm quark (or antiquark)

◆ hasDecayVtx()

bool xAOD::TruthParticle_v1::hasDecayVtx ( ) const

Check for a decay vertex on this particle.

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

◆ hasProdVtx()

bool xAOD::TruthParticle_v1::hasProdVtx ( ) const

Check for a production vertex on this particle.

Definition at line 69 of file TruthParticle_v1.cxx.

                                           {
 
      return ( acc_prodVtxLink.isAvailable( *this ) &&
               acc_prodVtxLink( *this ).isValid() );
   }

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

◆ hasStrange()

bool xAOD::TruthParticle_v1::hasStrange ( ) const

Whether the particle contains a strange quark (or antiquark)

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ index()

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

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

◆ isBaryon()

bool xAOD::TruthParticle_v1::isBaryon ( ) const

Whether the particle is a baryon.

◆ isBottomBaryon()

bool xAOD::TruthParticle_v1::isBottomBaryon ( ) const

Determine if the PID is that of a b-baryon.

◆ isBottomHadron()

bool xAOD::TruthParticle_v1::isBottomHadron ( ) const

Determine if the PID is that of a b-hadron.

◆ isBottomMeson()

bool xAOD::TruthParticle_v1::isBottomMeson ( ) const

Determine if the PID is that of a b-meson.

◆ isBSM()

bool xAOD::TruthParticle_v1::isBSM ( ) const

Check if this is a BSM particle.

◆ isCharged()

bool xAOD::TruthParticle_v1::isCharged ( ) const

Whether the particle is electrically charged.

◆ isCharmBaryon()

bool xAOD::TruthParticle_v1::isCharmBaryon ( ) const

Determine if the PID is that of a c-baryon.

Specifically, the heaviest quark is a c: a baryon containing a b & c is a b-baryon and NOT a c-baryon. To test for the simpler case, just use a combination of hasCharm() and isBaryon().

◆ isCharmHadron()

bool xAOD::TruthParticle_v1::isCharmHadron ( ) const

Determine if the PID is that of a c-hadron.

◆ isCharmMeson()

bool xAOD::TruthParticle_v1::isCharmMeson ( ) const

Determine if the PID is that of a c-meson.

Specifically, the heaviest quark is a c: a B_c is a b-meson and NOT a c-meson. Charmonia (closed charm) are counted as c-mesons here.

◆ isChLepton()

bool xAOD::TruthParticle_v1::isChLepton ( ) const

Whether the particle is a charged lepton.

◆ isElectron()

bool xAOD::TruthParticle_v1::isElectron ( ) const

Whether the particle is an electron (or positron)

◆ isGenSpecific()

bool xAOD::TruthParticle_v1::isGenSpecific ( ) const

Check if this is a generator specific (non-physical) particle.

◆ isGenStable()

bool xAOD::TruthParticle_v1::isGenStable ( ) const

Check if this is generator stable particle.

Definition at line 311 of file TruthParticle_v1.cxx.

311{ return MC::isGenStable(this); };

MC::isGenStable

bool isGenStable(const T &p)

Determine if the particle is stable at the generator (not det-sim) level,.

Definition HepMCHelpers.h:54

◆ isHadron()

bool xAOD::TruthParticle_v1::isHadron ( ) const

Whether the particle is a hadron.

◆ isHeavyBaryon()

bool xAOD::TruthParticle_v1::isHeavyBaryon ( ) const

Determine if the PID is that of a heavy flavour (b or c) baryon.

◆ isHeavyHadron()

bool xAOD::TruthParticle_v1::isHeavyHadron ( ) const

Determine if the PID is that of a heavy flavour (b or c) hadron.

◆ isHeavyMeson()

bool xAOD::TruthParticle_v1::isHeavyMeson ( ) const

Determine if the PID is that of a heavy flavour (b or c) meson.

◆ isHiggs()

bool xAOD::TruthParticle_v1::isHiggs ( ) const

Check if this particle is a Higgs boson.

◆ isLepton()

bool xAOD::TruthParticle_v1::isLepton ( ) const

Whether the particle is a lepton.

◆ isLightBaryon()

bool xAOD::TruthParticle_v1::isLightBaryon ( ) const

Determine if the PID is that of a light flavour (not b or c) baryon.

◆ isLightHadron()

bool xAOD::TruthParticle_v1::isLightHadron ( ) const

Determine if the PID is that of a light flavour (not b or c) hadron.

◆ isLightMeson()

bool xAOD::TruthParticle_v1::isLightMeson ( ) const

Determine if the PID is that of a light flavour (not b or c) meson.

◆ isMeson()

bool xAOD::TruthParticle_v1::isMeson ( ) const

Whether the particle is a meson.

◆ isMuon()

bool xAOD::TruthParticle_v1::isMuon ( ) const

Whether the particle is a muon (or antimuon)

◆ isNeutral()

bool xAOD::TruthParticle_v1::isNeutral ( ) const

Whether the particle is electrically neutral.

◆ isNeutrino()

bool xAOD::TruthParticle_v1::isNeutrino ( ) const

Whether the particle is a neutrino (or antineutrino)

◆ isParton()

bool xAOD::TruthParticle_v1::isParton ( ) const

Check if this particle is a parton.

◆ isPhoton()

bool xAOD::TruthParticle_v1::isPhoton ( ) const

Whether the particle is a photon.

◆ isQuark()

bool xAOD::TruthParticle_v1::isQuark ( ) const

Check if this particle is a quark.

◆ isResonance()

bool xAOD::TruthParticle_v1::isResonance ( ) const

Check if this particle is a resonant state.

◆ isSimulationParticle()

bool xAOD::TruthParticle_v1::isSimulationParticle ( ) const

Check if this particle was produced during the simulation.

Definition at line 313 of file TruthParticle_v1.cxx.

313{ return HepMC::is_simulation_particle(this); };

HepMC::is_simulation_particle

bool is_simulation_particle(const T &p)

Method to establish if a particle (or barcode) was created during the simulation (TODO update to be s...

Definition MagicNumbers.h:355

◆ isStable()

bool xAOD::TruthParticle_v1::isStable ( ) const

Check if this is a stable particle (generator or simulation produced)

Definition at line 312 of file TruthParticle_v1.cxx.

312{ return MC::isStable(this); };

MC::isStable

bool isStable(const T &p)

Identify if the particle is stable, i.e. has not decayed.

Definition HepMCHelpers.h:45

◆ isStrangeBaryon()

bool xAOD::TruthParticle_v1::isStrangeBaryon ( ) const

Determine if the PID is that of a strange baryon.

◆ isStrangeHadron()

bool xAOD::TruthParticle_v1::isStrangeHadron ( ) const

Determine if the PID is that of a strange hadron.

◆ isStrangeMeson()

bool xAOD::TruthParticle_v1::isStrangeMeson ( ) const

Determine if the PID is that of a strange meson.

◆ isTau()

bool xAOD::TruthParticle_v1::isTau ( ) const

Whether the particle is a tau (or antitau)

◆ isTop()

bool xAOD::TruthParticle_v1::isTop ( ) const

Check if this particle is a top quark.

◆ isW()

bool xAOD::TruthParticle_v1::isW ( ) const

Check if this particle is a W boson.

◆ isZ()

bool xAOD::TruthParticle_v1::isZ ( ) const

Check if this particle is a Z boson.

◆ m()

virtual double xAOD::TruthParticle_v1::m ( ) const

finaloverridevirtual

The mass of the particle.

Note, not necessarily = \(E^2-p^2\) if not on mass shell.

Implements xAOD::IParticle.

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

◆ nChildren()

size_t xAOD::TruthParticle_v1::nChildren ( ) const

Number of children of this particle.

Definition at line 135 of file TruthParticle_v1.cxx.

                                            {
      if (hasDecayVtx() && decayVtx()->nOutgoingParticles()>0){
        return decayVtx()->nOutgoingParticles();
      } else if ( acc_childLinks.isAvailable( *this ) ) {
        return acc_childLinks( *this ).size();
      }
      return 0;
   }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nParents()

size_t xAOD::TruthParticle_v1::nParents ( ) const

Number of parents of this particle.

Definition at line 117 of file TruthParticle_v1.cxx.

                                           {
      if (hasProdVtx() && prodVtx()->nIncomingParticles()>0){
        return prodVtx()->nIncomingParticles();
      } else if ( acc_parentLinks.isAvailable( *this ) ) {
        return acc_parentLinks( *this ).size();
      }
      return 0;
   }

◆ p4()

TruthParticle_v1::FourMom_t xAOD::TruthParticle_v1::p4 ( ) const

finaloverridevirtual

The full 4-momentum of the particle.

Note that m may not be right, though, if not on mass shell. In which case p4().M() will be different from m().

Implements xAOD::IParticle.

Definition at line 191 of file TruthParticle_v1.cxx.

                                                        {
     return FourMom_t(px(), py(), pz(), e() );
   }

◆ parent()

const TruthParticle_v1 * xAOD::TruthParticle_v1::parent ( size_t i ) const

Retrieve the i-th mother (TruthParticle) of this TruthParticle.

Definition at line 126 of file TruthParticle_v1.cxx.

                                                                    {
      if (hasProdVtx() && prodVtx()->nIncomingParticles()>0){
        return prodVtx()->incomingParticle( i );
      } else if ( acc_parentLinks.isAvailable( *this ) && i<acc_parentLinks( *this ).size() ) {
        return acc_parentLinks( *this )[i].isValid() ? *(acc_parentLinks( *this )[i]) : nullptr;
      }
      return nullptr;
   }

◆ pdg_id()

int xAOD::TruthParticle_v1::pdg_id ( ) const

inline

PDG ID code.

Definition at line 52 of file TruthParticle_v1.h.

52{ return pdgId();}

xAOD::TruthParticle_v1::pdgId

int pdgId() const

PDG ID code.

◆ pdgId()

int xAOD::TruthParticle_v1::pdgId ( ) const

PDG ID code.

◆ phi()

double xAOD::TruthParticle_v1::phi ( ) const

finaloverridevirtual

The azimuthal angle ( \(\phi\)) of the particle.

Implements xAOD::IParticle.

Definition at line 176 of file TruthParticle_v1.cxx.

                                      {
 
      // Calculate the azimuth angle using TLorentzVector.
      // Could do something more lightweight later on.
      return genvecP4().Phi();
   }

◆ polarization()

TruthParticle_v1::Polarization xAOD::TruthParticle_v1::polarization ( ) const

Retrieve a full Polarization with a single call.

Note: May have invalid values – use valid() to check.

Returns: An object holding the full polarization information

Definition at line 380 of file TruthParticle_v1.cxx.

                                                                     {
 
      // Construct the object:
      Polarization rtn;
      polarizationParameter( rtn.phi, polarizationPhi );
      polarizationParameter( rtn.theta, polarizationTheta );
 
      return rtn;
   }

◆ polarizationParameter() [1/2]

bool xAOD::TruthParticle_v1::polarizationParameter	(	float &	value,
		PolParam	parameter ) const

Accessor for polarization parameters.

Generic C++ code should use this function to retrieve the polarization parameters of a truth particle. Since these parameters are optional, the function is designed to tell the user whether the requested parameter could be retrieved or not.

Parameters

value	The polarization parameter value read from the object
parameter	The polarization parameter that we are interested in

Returns: true if the retrieval was successful, false if it wasn't

Definition at line 325 of file TruthParticle_v1.cxx.

                                                                        {
 
      // Get the accessor object:
      const Accessor< float >* acc = polarizationAccessorV1( param );
      if( ! acc ) {
         // The user asked for a non-existent parameter type. o.O
         std::cerr << "xAOD::TruthParticle_v1::polarizationParameter ERROR "
                   << "Request for an unknown (" << param << ") polarization "
                   << "parameter type" << std::endl;
         return false;
      }
      // Check if the variable is available:
      if( ! acc->isAvailable( *this ) ) {
         // No, it is not.
         return false;
      }
 
      // Read the value:
      value = ( *acc )( *this );
      return true;
   }

◆ polarizationParameter() [2/2]

float xAOD::TruthParticle_v1::polarizationParameter ( PolParam parameter ) const

Convenience accessor for a polariozation parameter.

Throws an exception if the request can't be completed. It should mostly be used in PyROOT, as the other form of this function is very hard to use there. But one needs to know for sure that the requested parameter will exist.

Parameters

parameter The polarion parameter that we are interested in

Returns: The value of the polarization parameter requested

Definition at line 366 of file TruthParticle_v1.cxx.

                                                                       {
 
      // Get the accessor object:
      const Accessor< float >* acc = polarizationAccessorV1( param );
      if( ! acc ) {
         // Throw an exception:
         throw std::runtime_error( "Unrecognized polarization parameter "
                                   "requested" );
      }
 
      // Read the value:
      return ( *acc )( *this );
   }

◆ production_vertex()

const TruthVertex_v1 * xAOD::TruthParticle_v1::production_vertex ( ) const

inline

The production vertex of this particle.

Definition at line 77 of file TruthParticle_v1.h.

77{ return prodVtx();}

◆ prodVtx()

const TruthVertex * xAOD::TruthParticle_v1::prodVtx ( ) const

The production vertex of this particle.

Definition at line 75 of file TruthParticle_v1.cxx.

                                                      {
 
      return hasProdVtx() ? *prodVtxLink() : nullptr;
   }

◆ prodVtxLink()

const ElementLink< TruthVertexContainer > & xAOD::TruthParticle_v1::prodVtxLink ( ) const

The production vertex link of this particle.

◆ pt()

double xAOD::TruthParticle_v1::pt ( ) const

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 161 of file TruthParticle_v1.cxx.

                                     {
 
      // Do the calculation by hand:
      const double localPx = static_cast< double >( px() );
      const double localPy = static_cast< double >( py() );
      return std::sqrt( localPx * localPx + localPy * localPy );
   }

◆ px()

float xAOD::TruthParticle_v1::px ( ) const

The x component of the particle's momentum.

◆ py()

float xAOD::TruthParticle_v1::py ( ) const

The y component of the particle's momentum.

◆ pz()

float xAOD::TruthParticle_v1::pz ( ) const

The z component of the particle's momentum.

◆ rapidity()

double xAOD::TruthParticle_v1::rapidity ( ) const

finaloverridevirtual

The true rapidity ( \(y\)) of the particle.

Implements xAOD::IParticle.

Definition at line 186 of file TruthParticle_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
}

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setDecayVtxLink()

void xAOD::TruthParticle_v1::setDecayVtxLink ( const ElementLink< TruthVertexContainer > & link )

Set the decay vertex of the particle.

◆ setE()

void xAOD::TruthParticle_v1::setE ( float value )

Set the energy of the particle.

Definition at line 230 of file TruthParticle_v1.cxx.

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

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

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

◆ setM()

void xAOD::TruthParticle_v1::setM ( float value )

Also store the mass.

Definition at line 236 of file TruthParticle_v1.cxx.

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

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

◆ setPdgId()

void xAOD::TruthParticle_v1::setPdgId ( int pid )

Set PDG ID code.

◆ setPolarizationParameter()

bool xAOD::TruthParticle_v1::setPolarizationParameter	(	float	value,
		PolParam	parameter )

Set method for polarization parameter values.

In order to keep the symmetry with the getter function, this setter communicates a possible failure in its operation through a return value. Setting a polariozation parameter is much less likely to fail than retrieving one, but in some situations it may still happen...

Parameters

value	The polarization parameter value to set on the object
parameter	The polarization parameter type that we want to set

Returns: true if the operation was successful, or false if it wasn't

Definition at line 348 of file TruthParticle_v1.cxx.

                                                                     {
 
      // Get the accessor object:
      const Accessor< float >* acc = polarizationAccessorV1( param );
      if( ! acc ) {
         // The user asked for a non-existent parameter type. o.O
         std::cerr << "xAOD::TruthParticle_v1::setPolarizationParameter ERROR "
                   << "Request for an unknown (" << param << ") polarization "
                   << "parameter type" << std::endl;
         return false;
      }
 
      // Set the value:
      ( *acc )( *this ) = value;
      return true;
   }

◆ setProdVtxLink()

void xAOD::TruthParticle_v1::setProdVtxLink ( const ElementLink< TruthVertexContainer > & link )

Set the production vertex of the particle.

◆ setPx()

void xAOD::TruthParticle_v1::setPx ( float value )

Set the x component of the particle's momentum.

◆ setPy()

void xAOD::TruthParticle_v1::setPy ( float value )

Set the y component of the particle's momentum.

◆ setPz()

void xAOD::TruthParticle_v1::setPz ( float value )

Set the z component of the particle's momentum.

◆ setStatus()

void xAOD::TruthParticle_v1::setStatus ( int value )

Set status code.

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

◆ setUid()

void xAOD::TruthParticle_v1::setUid ( int value )

Set unique ID.

◆ status()

int xAOD::TruthParticle_v1::status ( ) const

Status code.

◆ threeCharge()

int xAOD::TruthParticle_v1::threeCharge ( ) const

3 x the physical charge (so it can be an int for quarks)

◆ toPersistent()

void xAOD::TruthParticle_v1::toPersistent ( )

Function making sure that the object is ready for persistification.

Definition at line 393 of file TruthParticle_v1.cxx.

                                       {
 
      if( acc_prodVtxLink.isAvailableWritable( *this ) ) {
         acc_prodVtxLink( *this ).toPersistent();
      }
      if( acc_decayVtxLink.isAvailableWritable( *this ) ) {
         acc_decayVtxLink( *this ).toPersistent();
      }
      return;
   }

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

◆ type()

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

finaloverridevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 200 of file TruthParticle_v1.cxx.

                                               {
 
      return Type::TruthParticle;
   }

◆ uid()

int xAOD::TruthParticle_v1::uid ( ) const

Unique ID.

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

Member Data Documentation

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

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

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:

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Polarization properties (optional)

Functions implementing the xAOD::IParticle interface

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PolParam

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ TruthParticle_v1()

Member Function Documentation

◆ abseta()

◆ absPdgId()

◆ absrapidity()

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

◆ charge()

◆ child()

◆ clearAux()

◆ clearAuxHelper()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ copyAuxHelper()

◆ decayVtx()

◆ decayVtxLink()

◆ e()

◆ end_vertex()

◆ eta()

◆ genvecP4()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasBottom()

◆ hasCharm()

◆ hasDecayVtx()

◆ hasNonConstStore()

◆ hasProdVtx()

◆ hasStore()

◆ hasStrange()

◆ havePrivateData()

◆ index()

◆ isAvailable()

◆ isAvailableWritable() [1/2]

◆ isAvailableWritable() [2/2]

◆ isAvailableWritableAsDecoration()

◆ isBaryon()

◆ isBottomBaryon()

◆ isBottomHadron()

◆ isBottomMeson()

◆ isBSM()

◆ isCharged()

◆ isCharmBaryon()

◆ isCharmHadron()