Class describing a jet. More...

#include <Jet_v1.h>

Inheritance diagram for xAOD::Jet_v1:

Collaboration diagram for xAOD::Jet_v1:

Public Types
typedef JetAttribute::AttributeID	AttributeID

typedef JetAttribute::AssoParticlesID	AssoParticlesID

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
	Jet_v1 ()
	Default constructor. More...

	Jet_v1 (const Jet_v1 &)
	Constructor with the 4-momentum properties of the jet. More...

	~Jet_v1 ()

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

Access signal state
access the various signal states of the jets For now provide the minimum by returning only FourMomentum. Access by the enum to the historical states
JetFourMom_t	jetP4 (JetScale s) const
	Access by the enum to the historical states. More...

JetFourMom_t	genvecP4 (JetScale s) const

JetFourMom_t	jetP4 (const std::string &statename) const
	Generic access to states. More...

JetFourMom_t	genvecP4 (const std::string &statename) const

void	setJetP4 (const JetFourMom_t &p4)

void	setJetP4 (JetScale s, const JetFourMom_t &p4)
	Access by the enum to the historical states. More...

void	setJetP4 (const std::string &sname, const JetFourMom_t &p4)

Access to auxiliary data
Functions to retrieve attributes added to jet objects. They concern any attributes (float, vector<float>, 4-momentum,...) except IParticles (for the later see associatedParticles() function below). Access is done by an enum identifier or by string. They internally translate calls using double or vector<double> (ex: getAttribute<double>() ) in calls using float. This guarantees values are saved as float (less disk space) This avoids potential confusions related to retrieving a number as a float or as a double.
template<class T >
bool	getAttribute (AttributeID type, T &value) const
	Retrieve attribute moment by enum. More...

template<class T >
bool	getAttribute (const std::string &name, T &value) const
	Retrieve attribute by string. More...

template<class T >
T	getAttribute (const std::string &name) const
	short form : more convenient and compact. Throws an exception if the moment is missing. More...

template<class T >
T	getAttribute (AttributeID type) const

template<class T >
void	setAttribute (const std::string &name, const T &v)

template<class T >
void	setAttribute (AttributeID type, const T &value)
	Set number by enum. More...

Access object or list of associated objects
Special functions to store list of objects are provided. The reason is we want to internally store every object as link (ElementLink). The setter and getter functions thus perform the conversion automatically from the internal format from/to const Object* or vector<const Object*>
template<typename T >
std::vector< const T * >	getAssociatedObjects (const std::string &name) const
	get associated objects as a vector<object> this compact form throws an exception if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer More...

template<typename T >
std::vector< const T * >	getAssociatedObjects (AssoParticlesID type) const

template<typename T >
bool	getAssociatedObjects (const std::string &name, std::vector< const T * > &vec) const
	get associated objects as a vector<object> returns false if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer AND the function returns false More...

template<typename T >
bool	getAssociatedObjects (AssoParticlesID type, std::vector< const T * > &vec) const

template<typename T >
void	setAssociatedObjects (const std::string &name, const std::vector< const T * > &vec)
	set associated objects from a vector of arbitrary object. More...

template<typename T >
void	setAssociatedObjects (AssoParticlesID type, const std::vector< const T * > &vec)

template<typename T >
const T *	getAssociatedObject (const std::string &name) const
	get a single associated object this compact form throws an exception if the object is not existing More...

template<typename T >
const T *	getAssociatedObject (AssoParticlesID type) const

template<typename T >
bool	getAssociatedObject (const std::string &name, const T *&vec) const
	get a single associated object returns false if the object is not existing More...

template<typename T >
bool	getAssociatedObject (AssoParticlesID type, const T *&vec) const

template<typename T >
void	setAssociatedObject (const std::string &name, const T *vec)
	set a single associated object T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed More...

template<typename T >
void	setAssociatedObject (AssoParticlesID type, const T *vec)

Metadata like information
float	getSizeParameter () const

JetAlgorithmType::ID	getAlgorithmType () const

JetInput::Type	getInputType () const

void	setSizeParameter (float p)

void	setAlgorithmType (JetAlgorithmType::ID a)

void	setInputType (JetInput::Type t)

Access to internal fastjet object. Reserved to expert usage.
Access to the internal fastjet object. CAN RETURN NULL, see the description of m_pseudoJet
const fastjet::PseudoJet *	getPseudoJet () const

template<class PSEUDOJET >
void	setPseudoJet (const PSEUDOJET *fj)
	Set the fast jet pointer. More...

void	reset ()
	Function making sure that the object is ready for persistification. 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...

Protected Attributes
FastJetLinkBase *	m_fastJetLink
	Pointer to the fastjet object this jet is build from. More...

Private Types
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...

Private Attributes
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

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

Jet_v1 &	operator= (const Jet_v1 &other)

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

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

virtual double	phi () const
	The azimuthal angle ( \(\phi\)) of the particle. More...

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

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

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

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

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

Additionnal kinematics for jets.
typedef JetFourMom_t	GenVecFourMom_t
	define enum ot follow naming conventions More...

JetFourMom_t	jetP4 () const
	The full 4-momentum of the particle : internal jet type. More...

JetFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : internal jet type (same). More...

float	px () const
	The x-component of the jet's momentum. More...

float	py () const
	The y-component of the jet's momentum. More...

float	pz () const
	The z-component of the jet's momentum. More...

Jet constituents access
Access to the jet constituents. Constiuents are stored internally as IParticle. getConstituents() returns a special object : JetConstituentVector. The default 4-vectors of the constituents (ex: clusters) possibly differ from the 4-vector used in the jet finding procedure (ex: when find jets with non calibrated "EM scale" clusters). The JetConstituentVector behaves almost exactly as a simple vector<const IParticle*> AND guarantees that the 4-vectors it contains correpond to the 4-vector used at jet finding time. See the JetConstituentVector.h header for more details A direct access method rawConstituent() is provided for experts usage only. jet finding.
void	addConstituent (const ElementLink< IParticleContainer > &link, float weight=1.0)
	Add a constituent directly in the ElementLink format. More...

void	addConstituent (const IParticle *p, float weight=1.0)
	Add an IParticle as as constituent. More...

JetConstitScale	getConstituentsSignalState () const
	The state at which constituents were when this jet was found. More...

void	setConstituentsSignalState (JetConstitScale t)
	Set the state at which constituents were when this jet was found. This function is called by jet builders. More...

JetConstituentVector	getConstituents () const
	Return a vector of consituents. The object behaves like vector<const IParticle*>. See JetConstituentVector.h header for more details. More...

size_t	numConstituents () const
	Number of constituents in this jets (this is valid even when reading a file where the constituents have been removed). More...

const IParticle *	rawConstituent (size_t i) const
	Direct access to constituents. WARNING expert use only. More...

const std::vector< ElementLink< IParticleContainer > > &	constituentLinks () const
	Direct access to constituents. WARNING expert use only. More...

void	setNumConstituents (size_t n)

Detailed Description

Class describing a jet.

Jet is a generic class used to represent any "types" of hadronic jet within the Atlas Software. The various "types" of jets include for example jets build from calorimeter cluster or from reconstructed tracks or from truth particle, etc... The Jet class provides 4 main features :

list of constituents. This list is build by the jet finding algorithm and is the physical definition of the jet object. Methods are provided to set and access constituents as IParticle objects.
4-momentum. Accessed through the inherited IParticle interface. A Jet 4-mom is not necessarily the sum of its constituents 4-mom (for ex. if a calibration has been applied).
Signal States : Jets can hold several other 4-momentum representing various calibration states (primarily used for calo jets). See also P4SignalState
Attributes : depending on its "type" several other attributes can be added to a jet.
- numbers, vector of numbers : access through the get/setAttribute functions
- other IParticles : dedicated functions are provided get/setAssociatedParticles (because of internal I/O details)

Author: Pierre-Antoine Delsart delsa.nosp@m.rt@i.nosp@m.n2p3..nosp@m.fr; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 795692

Date: 2017-02-06 00:08:21 +0100 (Mon, 06 Feb 2017)

Definition at line 57 of file Jet_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.

◆ AssoParticlesID

typedef JetAttribute::AssoParticlesID xAOD::Jet_v1::AssoParticlesID

Definition at line 62 of file Jet_v1.h.

◆ AttributeID

typedef JetAttribute::AttributeID xAOD::Jet_v1::AttributeID

Definition at line 61 of file Jet_v1.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::Jet_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 92 of file Jet_v1.h.

◆ GenVecFourMom_t

typedef JetFourMom_t xAOD::Jet_v1::GenVecFourMom_t

define enum ot follow naming conventions

Definition at line 110 of file Jet_v1.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ 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

◆ Jet_v1() [1/2]

xAOD::Jet_v1::Jet_v1 ( )

Default constructor.

Definition at line 14 of file Jet_v1.cxx.

     : IParticle() 
     , m_fastJetLink(nullptr) 
   {
   }

◆ Jet_v1() [2/2]

xAOD::Jet_v1::Jet_v1 ( const Jet_v1 & o )

Constructor with the 4-momentum properties of the jet.

Copy constructor

Definition at line 23 of file Jet_v1.cxx.

                                  : IParticle( o )
                                    , m_fastJetLink(nullptr)
   {
     makePrivateStore( o );
     if( o.m_fastJetLink  ) m_fastJetLink = o.m_fastJetLink->clone();    
   }   

◆ ~Jet_v1()

xAOD::Jet_v1::~Jet_v1 ( )

Definition at line 39 of file Jet_v1.cxx.

                  {
     if(m_fastJetLink) delete m_fastJetLink;
   }

Member Function Documentation

◆ addConstituent() [1/2]

void xAOD::Jet_v1::addConstituent	(	const ElementLink< IParticleContainer > &	link,
		float	weight = `1.0`
	)

Add a constituent directly in the ElementLink format.

Definition at line 111 of file Jet_v1.cxx.

                                          {
  
     constituentAcc( *this ).push_back( link );
     constituentWeightAcc( *this ).push_back( w );
     return;
   }

◆ addConstituent() [2/2]

void xAOD::Jet_v1::addConstituent	(	const IParticle *	p,
		float	weight = `1.0`
	)

Add an IParticle as as constituent.

Warning ! A link to the original container of this particle p will be used internally. Thus one can not persistify correctly constituents from a container in VIEW mode.

Definition at line 119 of file Jet_v1.cxx.

                                                            {
     int idx = c->index();
     const IParticleContainer* pcon =
       dynamic_cast<const IParticleContainer*>(c->container());
     ElementLink<IParticleContainer> el(*pcon, idx);
 #if 0
     ElementLink< IParticleContainer > el;
     el.toIndexedElement( *( dynamic_cast< const IParticleContainer* >( c->container() ) ), c->index() );
 #endif
     constituentAcc(*this).push_back(el);
     constituentWeightAcc( *this ).push_back( w );
     return;
   }

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

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

◆ constituentLinks()

const std::vector< ElementLink< IParticleContainer > > & xAOD::Jet_v1::constituentLinks ( ) const

Direct access to constituents. WARNING expert use only.

Definition at line 162 of file Jet_v1.cxx.

                                                                                        {
     return constituentAcc(*this);
   }

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

◆ e()

double xAOD::Jet_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 63 of file Jet_v1.cxx.

                           {
      return jetP4().E();
    }

◆ eta()

double xAOD::Jet_v1::eta ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 49 of file Jet_v1.cxx.

                             {
      
      return momentumAcc.eta( *this );
    }

◆ genvecP4() [1/3]

JetFourMom_t xAOD::Jet_v1::genvecP4 ( ) const

The full 4-momentum of the particle : internal jet type (same).

Definition at line 81 of file Jet_v1.cxx.

                                        {
      return jetP4();
    }

◆ genvecP4() [2/3]

JetFourMom_t xAOD::Jet_v1::genvecP4 ( const std::string & statename ) const

Definition at line 221 of file Jet_v1.cxx.

                                                                 {
     return jetP4(statename);
   }

◆ genvecP4() [3/3]

JetFourMom_t xAOD::Jet_v1::genvecP4 ( JetScale s ) const

Definition at line 193 of file Jet_v1.cxx.

                                                 {
     return jetP4(s);
   }

◆ getAlgorithmType()

JetAlgorithmType::ID xAOD::Jet_v1::getAlgorithmType ( ) const

Definition at line 249 of file Jet_v1.cxx.

                                                    {
     return (JetAlgorithmType::ID) algAcc(*this);
   }

◆ getAssociatedObject() [1/4]

template<typename T >

const T* xAOD::Jet_v1::getAssociatedObject ( AssoParticlesID type ) const

◆ getAssociatedObject() [2/4]

template<typename T >

bool xAOD::Jet_v1::getAssociatedObject	(	AssoParticlesID	type,
		const T *&	vec
	)		const

◆ getAssociatedObject() [3/4]

template<typename T >

const T* xAOD::Jet_v1::getAssociatedObject ( const std::string & name ) const

get a single associated object this compact form throws an exception if the object is not existing

◆ getAssociatedObject() [4/4]

template<typename T >

bool xAOD::Jet_v1::getAssociatedObject	(	const std::string &	name,
		const T *&	vec
	)		const

get a single associated object returns false if the object is not existing

◆ getAssociatedObjects() [1/4]

template<typename T >

std::vector<const T*> xAOD::Jet_v1::getAssociatedObjects ( AssoParticlesID type ) const

◆ getAssociatedObjects() [2/4]

template<typename T >

bool xAOD::Jet_v1::getAssociatedObjects	(	AssoParticlesID	type,
		std::vector< const T * > &	vec
	)		const

◆ getAssociatedObjects() [3/4]

template<typename T >

std::vector<const T*> xAOD::Jet_v1::getAssociatedObjects ( const std::string & name ) const

get associated objects as a vector<object> this compact form throws an exception if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer

◆ getAssociatedObjects() [4/4]

template<typename T >

bool xAOD::Jet_v1::getAssociatedObjects	(	const std::string &	name,
		std::vector< const T * > &	vec
	)		const

get associated objects as a vector<object> returns false if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer AND the function returns false

◆ getAttribute() [1/4]

template<class T >

T xAOD::Jet_v1::getAttribute ( AttributeID type ) const

◆ getAttribute() [2/4]

template<class T >

bool xAOD::Jet_v1::getAttribute	(	AttributeID	type,
		T &	value
	)		const

Retrieve attribute moment by enum.

◆ getAttribute() [3/4]

template<class T >

T xAOD::Jet_v1::getAttribute ( const std::string & name ) const

short form : more convenient and compact. Throws an exception if the moment is missing.

◆ getAttribute() [4/4]

template<class T >

bool xAOD::Jet_v1::getAttribute	(	const std::string &	name,
		T &	value
	)		const

Retrieve attribute by string.

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

◆ getConstituents()

JetConstituentVector xAOD::Jet_v1::getConstituents ( ) const

Return a vector of consituents. The object behaves like vector<const IParticle*>. See JetConstituentVector.h header for more details.

Definition at line 147 of file Jet_v1.cxx.

                                                      {
     
     JetConstituentVector vec( & constituentAcc(*this) , getConstituentsSignalState() );
     return vec;
   }

◆ getConstituentsSignalState()

JetConstitScale xAOD::Jet_v1::getConstituentsSignalState ( ) const

The state at which constituents were when this jet was found.

Definition at line 136 of file Jet_v1.cxx.

                                                            {
     if( constitScaleAcc.isAvailable(*this) ) return (JetConstitScale)constitScaleAcc(*this);
     return UnknownConstitScale; 
   }

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

◆ getInputType()

JetInput::Type xAOD::Jet_v1::getInputType ( ) const

Definition at line 253 of file Jet_v1.cxx.

                                          {
     return (JetInput::Type) inputAcc(*this);
   }

◆ getPseudoJet()

const fastjet::PseudoJet * xAOD::Jet_v1::getPseudoJet ( ) const

Definition at line 236 of file Jet_v1.cxx.

                                                       {
     if(m_fastJetLink) return m_fastJetLink->pseudoJet;
     return nullptr;
   }

◆ getSizeParameter()

float xAOD::Jet_v1::getSizeParameter ( ) const

Definition at line 245 of file Jet_v1.cxx.

                                        {
     return spAcc(*this);
   }

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

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

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

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

◆ jetP4() [1/3]

JetFourMom_t xAOD::Jet_v1::jetP4 ( ) const

The full 4-momentum of the particle : internal jet type.

Definition at line 76 of file Jet_v1.cxx.

                                     {
      return momentumAcc.getAttribute( *this);
    }

◆ jetP4() [2/3]

JetFourMom_t xAOD::Jet_v1::jetP4 ( const std::string & statename ) const

Generic access to states.

Definition at line 216 of file Jet_v1.cxx.

                                                              {
     if(statename=="JetAssignedScaleMomentum") return jetP4();
     return getAttribute<JetFourMom_t>(statename);
   }

◆ jetP4() [3/3]

JetFourMom_t xAOD::Jet_v1::jetP4 ( JetScale s ) const

Access by the enum to the historical states.

Definition at line 181 of file Jet_v1.cxx.

                                              {
    switch( s ){ 
     case JetEMScaleMomentum: return jetEMScaleAcc.getAttribute( *this );
     case JetConstitScaleMomentum : return jetConstitScaleAcc.getAttribute( *this );
     case JetAssignedScaleMomentum: return jetP4();
     default :
       std::cerr << " Error p4(P4SignalState) unknown state "<< s << std::endl;
       break;
     }
     return JetFourMom_t();
   }

◆ m()

double xAOD::Jet_v1::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 59 of file Jet_v1.cxx.

                           {
      return momentumAcc.m( *this );
    }

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

◆ numConstituents()

size_t xAOD::Jet_v1::numConstituents ( ) const

Number of constituents in this jets (this is valid even when reading a file where the constituents have been removed).

Definition at line 153 of file Jet_v1.cxx.

                                        {
  
      return constituentAcc( *this ).size();
   }

◆ operator=()

Jet_v1 & xAOD::Jet_v1::operator= ( const Jet_v1 & other )

Definition at line 30 of file Jet_v1.cxx.

                                            {
     if(this == &o) return *this;
  
     if( ( ! hasStore() ) && ( ! container() ) ) makePrivateStore();
     this->IParticle::operator=( o );
     if( (o.m_fastJetLink) && (m_fastJetLink==nullptr) ) m_fastJetLink = o.m_fastJetLink->clone();    
     return *this;
   }

◆ p4()

Jet_v1::FourMom_t xAOD::Jet_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 71 of file Jet_v1.cxx.

                                     {
      JetFourMom_t p = jetP4();
      return FourMom_t(p.Px(), p.Py(), p.Pz(), p.E() );
    }

◆ phi()

double xAOD::Jet_v1::phi ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 54 of file Jet_v1.cxx.

                             {
  
      return momentumAcc.phi( *this );
    }

◆ pt()

double xAOD::Jet_v1::pt ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 44 of file Jet_v1.cxx.

                            {
  
      return momentumAcc.pt( *this );
    }

◆ px()

float xAOD::Jet_v1::px ( ) const

The x-component of the jet's momentum.

Assuming that when one of px py pz is called the other will be too. So provoke the build of FourMom_t.

Definition at line 90 of file Jet_v1.cxx.

                           {
  
      return p4().Px();
    }

◆ py()

float xAOD::Jet_v1::py ( ) const

The y-component of the jet's momentum.

Definition at line 94 of file Jet_v1.cxx.

                           {
  
      return p4().Py();     
    }

◆ pz()

float xAOD::Jet_v1::pz ( ) const

The z-component of the jet's momentum.

Definition at line 99 of file Jet_v1.cxx.

                           {
  
      return p4().Pz();
    }

◆ rapidity()

double xAOD::Jet_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 67 of file Jet_v1.cxx.

                                  {
      return jetP4().Rapidity();
    }

◆ rawConstituent()

const IParticle * xAOD::Jet_v1::rawConstituent ( size_t i ) const

Direct access to constituents. WARNING expert use only.

Definition at line 158 of file Jet_v1.cxx.

                                                         {
     return * ( constituentAcc(*this)[i]);
   }

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

◆ reset()

void xAOD::Jet_v1::reset ( )

Function making sure that the object is ready for persistification.

workaround some I/O limitations

Definition at line 231 of file Jet_v1.cxx.

                      {
     if(m_fastJetLink) delete m_fastJetLink; 
     m_fastJetLink = nullptr;
   }

◆ setAlgorithmType()

void xAOD::Jet_v1::setAlgorithmType ( JetAlgorithmType::ID a )

Definition at line 258 of file Jet_v1.cxx.

258 { algAcc(*this) = a;}

◆ setAssociatedObject() [1/2]

template<typename T >

void xAOD::Jet_v1::setAssociatedObject	(	AssoParticlesID	type,
		const T *	vec
	)

◆ setAssociatedObject() [2/2]

template<typename T >

void xAOD::Jet_v1::setAssociatedObject	(	const std::string &	name,
		const T *	vec
	)

set a single associated object T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed

◆ setAssociatedObjects() [1/2]

template<typename T >

void xAOD::Jet_v1::setAssociatedObjects	(	AssoParticlesID	type,
		const std::vector< const T * > &	vec
	)

◆ setAssociatedObjects() [2/2]

template<typename T >

void xAOD::Jet_v1::setAssociatedObjects	(	const std::string &	name,
		const std::vector< const T * > &	vec
	)

set associated objects from a vector of arbitrary object.

T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed

◆ setAttribute() [1/2]

template<class T >

void xAOD::Jet_v1::setAttribute	(	AttributeID	type,
		const T &	value
	)

Set number by enum.

◆ setAttribute() [2/2]

template<class T >

void xAOD::Jet_v1::setAttribute	(	const std::string &	name,
		const T &	v
	)

◆ setConstituentsSignalState()

void xAOD::Jet_v1::setConstituentsSignalState ( JetConstitScale t )

Set the state at which constituents were when this jet was found. This function is called by jet builders.

Definition at line 141 of file Jet_v1.cxx.

                                                            {
     constitScaleAcc(*this) = t;
   }

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

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

◆ setInputType()

void xAOD::Jet_v1::setInputType ( JetInput::Type t )

Definition at line 259 of file Jet_v1.cxx.

259 {inputAcc(*this)=t;}

◆ setJetP4() [1/3]

void xAOD::Jet_v1::setJetP4 ( const JetFourMom_t & p4 )

Definition at line 171 of file Jet_v1.cxx.

                                                 {
     
     momentumAcc.setAttribute( *this, p4 );
     return;
   }

◆ setJetP4() [2/3]

void xAOD::Jet_v1::setJetP4	(	const std::string &	sname,
		const JetFourMom_t &	p4
	)

Definition at line 225 of file Jet_v1.cxx.

                                                                            {
     if(statename=="JetAssignedScaleMomentum") return setJetP4(JetAssignedScaleMomentum,p4);
     return setAttribute<JetFourMom_t>(statename, p4);
   }

◆ setJetP4() [3/3]

void xAOD::Jet_v1::setJetP4	(	JetScale	s,
		const JetFourMom_t &	p4
	)

Access by the enum to the historical states.

Definition at line 198 of file Jet_v1.cxx.

                                                            {
     switch( s ){ 
     case JetEMScaleMomentum: 
       jetEMScaleAcc.setAttribute( *this, p4 );
       break;
     case JetConstitScaleMomentum: 
       jetConstitScaleAcc.setAttribute(*this, p4 ) ;
       break;
     case JetAssignedScaleMomentum:
       setJetP4(p4);
       break;
     default :
       std::cerr << " Error p4(P4SignalState) unknown state "<< s << std::endl;
       break;
     }
   }

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

◆ setNumConstituents()

void xAOD::Jet_v1::setNumConstituents ( size_t n )

protected

◆ setPseudoJet()

template<class PSEUDOJET >

void xAOD::Jet_v1::setPseudoJet ( const PSEUDOJET * fj )

Set the fast jet pointer.

Expert usage only. This function is templated in order to avoid a dependency of xAODJet on fastjet.

◆ setSizeParameter()

void xAOD::Jet_v1::setSizeParameter ( float p )

Definition at line 257 of file Jet_v1.cxx.

257 { spAcc(*this) = p;}

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

◆ 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::Jet_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 85 of file Jet_v1.cxx.

                                     {    
       return Type::Jet;
    }

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

FastJetLinkBase* xAOD::Jet_v1::m_fastJetLink

protected

Pointer to the fastjet object this jet is build from.

WARNING : this pointer is meant to be used in reco flow only. It is transient only, provided only to ease calculation of some jet quantities, and will be invalid for jets read from files.

Definition at line 346 of file Jet_v1.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

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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

xAOD::IParticle functions

Additionnal kinematics for jets.

Jet constituents access

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ AssoParticlesID

◆ AttributeID

◆ ConstAccessor

◆ Decorator

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ Jet_v1() [1/2]

◆ Jet_v1() [2/2]

◆ ~Jet_v1()

Member Function Documentation

◆ addConstituent() [1/2]

◆ addConstituent() [2/2]

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

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ constituentLinks()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ e()

◆ eta()

◆ genvecP4() [1/3]

◆ genvecP4() [2/3]

◆ genvecP4() [3/3]

◆ getAlgorithmType()

◆ getAssociatedObject() [1/4]

◆ getAssociatedObject() [2/4]

◆ getAssociatedObject() [3/4]

◆ getAssociatedObject() [4/4]

◆ getAssociatedObjects() [1/4]

◆ getAssociatedObjects() [2/4]

◆ getAssociatedObjects() [3/4]

◆ getAssociatedObjects() [4/4]

◆ getAttribute() [1/4]

◆ getAttribute() [2/4]

◆ getAttribute() [3/4]

◆ getAttribute() [4/4]

◆ getAuxIDs()

◆ getConstituents()

◆ getConstituentsSignalState()

◆ getConstStore()

◆ getDecorIDs()

◆ getInputType()

◆ getPseudoJet()

◆ getSizeParameter()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ isAvailable()