Class describing properties of a LVL1 jFEX global Trigger Object (TOB) in the xAOD format. More...

#include <jFexSRJetRoI_v1.h>

Inheritance diagram for xAOD::jFexSRJetRoI_v1:

Collaboration diagram for xAOD::jFexSRJetRoI_v1:

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

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

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

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

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

void	initialize (uint8_t jFexNumber, uint8_t fpgaNumber, uint32_t tobWord, char istob, int resolution, float_t eta, float_t phi)
	In future initialze the EDM. More...

uint32_t	tobWord () const
	The "raw" 32-bit word describing the object candidate. More...

uint8_t	jFexNumber () const

uint8_t	fpgaNumber () const

uint16_t	tobEt () const

uint8_t	tobLocalEta () const

uint8_t	tobLocalPhi () const

uint8_t	tobSat () const

int	globalEta () const

uint	globalPhi () const

float	eta () const

float	phi () const

int	tobEtScale () const

char	isTOB () const

int	menuEta () const
	the eta index to use for looking up thresholds in the menu the current jFex fw only supports symmetric thresholds so index will always be >=0 to guarantee the symmetry (see L1TopoAlgorithms/jJetMultiplicity) More...

void	setIsTOB (char value)
	Set the isTOB variable (TOB or xTOB) More...

void	setTobWord (uint32_t tobWord)
	Set the "raw" 32-bit words describing the object candidate. More...

void	setjFexNumber (uint8_t jFexNumber)

void	setfpgaNumber (uint8_t fpgaNumber)

unsigned int	unpackEtTOB () const
	TOB ET (decoded from TOB, stored for convenience) More...

void	setTobEt (uint16_t value)

unsigned int	et () const
	Methods that require combining results or applying scales. More...

unsigned int	unpackEtaIndex () const
	Eta coordinates. More...

void	setTobLocalEta (uint8_t value)

unsigned int	unpackPhiIndex () const
	Phi coordinates. More...

void	setTobLocalPhi (uint8_t value)

unsigned int	unpackSaturationIndex () const

void	setTobSat (uint8_t value)

int	unpackGlobalEta () const

void	setGlobalEta (int value)

void	setEta (float value)

uint	unpackGlobalPhi () const

void	setGlobalPhi (uint value)

void	setPhi (float value)

void	setResolution (int value)

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 >::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 >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	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 Accessor< T, ALLOC >::const_reference_type	auxdata (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 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	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading. 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...

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)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other)
	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...

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

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

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

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

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

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

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

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

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

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

Private Types
enum	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 *)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other)
	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)
	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

Static Private Attributes
static const std::vector< int >	s_FWD_EtaPosition

static const std::vector< int >	s_FCAL_EtaPosition = {32,34,35,37,38,40,41,43,44,46,47,49}

static const int	s_resBit = 21

static const int	s_etBit = 10

static const int	s_etaBit = 5

static const int	s_phiBit = 1

static const int	s_satBit = 0

static const int	s_etMask = 0x7ff

static const int	s_etaMask = 0x1f

static const int	s_phiMask = 0xf

static const int	s_resMask = 0x7ff

static const int	s_satMask = 0x1

Detailed Description

Class describing properties of a LVL1 jFEX global Trigger Object (TOB) in the xAOD format.

Definition at line 22 of file jFexSRJetRoI_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 548 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 545 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 551 of file AuxElement.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 542 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

◆ jFexSRJetRoI_v1()

xAOD::jFexSRJetRoI_v1::jFexSRJetRoI_v1 ( )

Default constructor.

Definition at line 34 of file jFexSRJetRoI_v1.cxx.

35 : SG::AuxElement() {

36 }

Member Function Documentation

◆ 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 , class ALLOC = AuxAllocator_t<T>>

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

inherited

Fetch an aux data variable, 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.

◆ auxdata() [4/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 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 Accessor or ConstAccessor classes.

◆ 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 535 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 319 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 385 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 )

privateinherited

Copy aux data from another object.

Parameters

other The object from which to copy.

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 561 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();
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
     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);
     }
   }
 }

◆ et()

unsigned int xAOD::jFexSRJetRoI_v1::et ( ) const

Methods that require combining results or applying scales.

ET on TOB scale

Definition at line 138 of file jFexSRJetRoI_v1.cxx.

                                           {
        // Returns the TOB Et in a 1 MeV scale
        return tobEt()*tobEtScale(); 
    }

◆ eta()

float xAOD::jFexSRJetRoI_v1::eta ( ) const

◆ fpgaNumber()

uint8_t xAOD::jFexSRJetRoI_v1::fpgaNumber ( ) const

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

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

◆ getConstStore()

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

inherited

Return the current store, as a const interface.

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

Definition at line 284 of file AuxElement.cxx.

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

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

◆ globalEta()

int xAOD::jFexSRJetRoI_v1::globalEta ( ) const

◆ globalPhi()

uint xAOD::jFexSRJetRoI_v1::globalPhi ( ) const

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

◆ initialize()

void xAOD::jFexSRJetRoI_v1::initialize	(	uint8_t	jFexNumber,
		uint8_t	fpgaNumber,
		uint32_t	tobWord,
		char	istob,
		int	resolution,
		float_t	eta,
		float_t	phi
	)

In future initialze the EDM.

Definition at line 38 of file jFexSRJetRoI_v1.cxx.

                                                                                                                                                    {
     
     
      setTobWord( tobWord );
      setjFexNumber( jFexNumber );
      setfpgaNumber( fpgaNumber);
      setTobEt(unpackEtTOB());
      setTobLocalEta( unpackEtaIndex() );
      setTobLocalPhi( unpackPhiIndex() );      
      setTobSat(unpackSaturationIndex());
      setGlobalEta(unpackGlobalEta());
      setGlobalPhi(unpackGlobalPhi()); 
      setEta( eta ); 
      setPhi( phi ); 
      setResolution( resolution );
      setIsTOB(istob);
  
       return;
    }

◆ isAvailable()

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

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

inherited

Check if an aux variable is available for reading.

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()

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.

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

◆ isTOB()

char xAOD::jFexSRJetRoI_v1::isTOB ( ) const

◆ jFexNumber()

uint8_t xAOD::jFexSRJetRoI_v1::jFexNumber ( ) const

◆ 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 172 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 )

inherited

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

Parameters

other The object from which aux data should be copied.

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 )

inherited

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

Parameters

other The object from which aux data should be copied.

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 )

privateinherited

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

Parameters

other The object from which aux data should be copied.

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

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

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * )

privateinherited

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

Parameters

other The object from which aux data should be copied.

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.

◆ menuEta()

int xAOD::jFexSRJetRoI_v1::menuEta ( ) const

the eta index to use for looking up thresholds in the menu the current jFex fw only supports symmetric thresholds so index will always be >=0 to guarantee the symmetry (see L1TopoAlgorithms/jJetMultiplicity)

Definition at line 58 of file jFexSRJetRoI_v1.cxx.

                                        {
       // adapted from TSU::toTopoInteger
       static const unsigned int RESOLUTION = 40;
         float tmp = eta()*RESOLUTION;
         int index;
         if ( (abs(tmp)-0.5)/2. == std::round((abs(tmp)-0.5)/2.) ) {
             if ( tmp>0 ) { index = std::floor(tmp); }
             else { index = std::ceil(tmp); }
         } else {
             index = std::round(tmp);
         }
         return std::abs(index/4);
     }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ phi()

float xAOD::jFexSRJetRoI_v1::phi ( ) const

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

◆ setEta()

void xAOD::jFexSRJetRoI_v1::setEta ( float value )

◆ setfpgaNumber()

void xAOD::jFexSRJetRoI_v1::setfpgaNumber ( uint8_t fpgaNumber )

◆ setGlobalEta()

void xAOD::jFexSRJetRoI_v1::setGlobalEta ( int value )

◆ setGlobalPhi()

void xAOD::jFexSRJetRoI_v1::setGlobalPhi ( uint value )

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

◆ setIsTOB()

void xAOD::jFexSRJetRoI_v1::setIsTOB ( char value )

Set the isTOB variable (TOB or xTOB)

◆ setjFexNumber()

void xAOD::jFexSRJetRoI_v1::setjFexNumber ( uint8_t jFexNumber )

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

◆ setPhi()

void xAOD::jFexSRJetRoI_v1::setPhi ( float value )

◆ setResolution()

void xAOD::jFexSRJetRoI_v1::setResolution ( int value )

◆ 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 249 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 221 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 237 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 418 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;
   }
 }

◆ setTobEt()

void xAOD::jFexSRJetRoI_v1::setTobEt ( uint16_t value )

◆ setTobLocalEta()

void xAOD::jFexSRJetRoI_v1::setTobLocalEta ( uint8_t value )

◆ setTobLocalPhi()

void xAOD::jFexSRJetRoI_v1::setTobLocalPhi ( uint8_t value )

◆ setTobSat()

void xAOD::jFexSRJetRoI_v1::setTobSat ( uint8_t value )

◆ setTobWord()

void xAOD::jFexSRJetRoI_v1::setTobWord ( uint32_t tobWord )

Set the "raw" 32-bit words describing the object candidate.

◆ tobEt()

uint16_t xAOD::jFexSRJetRoI_v1::tobEt ( ) const

◆ tobEtScale()

int xAOD::jFexSRJetRoI_v1::tobEtScale ( ) const

◆ tobLocalEta()

uint8_t xAOD::jFexSRJetRoI_v1::tobLocalEta ( ) const

◆ tobLocalPhi()

uint8_t xAOD::jFexSRJetRoI_v1::tobLocalPhi ( ) const

◆ tobSat()

uint8_t xAOD::jFexSRJetRoI_v1::tobSat ( ) const

◆ tobWord()

uint32_t xAOD::jFexSRJetRoI_v1::tobWord ( ) const

The "raw" 32-bit word describing the object candidate.

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

◆ unpackEtaIndex()

unsigned int xAOD::jFexSRJetRoI::unpackEtaIndex ( ) const

Eta coordinates.

Definition at line 122 of file jFexSRJetRoI_v1.cxx.

                                                    {
      return (tobWord() >> s_etaBit) & s_etaMask;
    }

◆ unpackEtTOB()

unsigned int xAOD::jFexSRJetRoI_v1::unpackEtTOB ( ) const

TOB ET (decoded from TOB, stored for convenience)

Raw data words.

Used to differencite TOBs from xTOBs Extracted from data words, stored for convenience global coordinates, stored for furture use but not sent to L1Topo
Setting the jFEX ET resolution Methods to decode data from the TOB/RoI and return to the user TOB or xTOB?

Definition at line 115 of file jFexSRJetRoI_v1.cxx.

                                                    {
      //Data content = TOB
      return (tobWord() >> s_etBit) & s_etMask;
    } 

◆ unpackGlobalEta()

int xAOD::jFexSRJetRoI_v1::unpackGlobalEta ( ) const

Definition at line 145 of file jFexSRJetRoI_v1.cxx.

                                                {
         int globalEta = 0;
  
         // this is covering from -2.5 to 2.5 in eta, which means half module 0 and 5 and modules 1, 2, 3 and 4
         if(tobLocalEta()<9){ 
             if(jFexNumber()<3){
                 globalEta= 8*(jFexNumber()-2) - (tobLocalEta()+1);
             }
             else if(jFexNumber()<6){
                 globalEta= 8*(jFexNumber()-3) + (tobLocalEta());
             }            
         }
         else{
             if(jFexNumber()==5 ) {
                         
                 if(tobLocalEta() <=s_FWD_EtaPosition[4]) { //Region 2 and 3
                     globalEta = 25 +2*(tobLocalEta()-9);
                 }
                 else if(tobLocalEta() <= s_FWD_EtaPosition[6]) { //Region 4
                     globalEta = s_FCAL_EtaPosition[tobLocalEta()-13];
                 }        
                 
             }
             else if(jFexNumber()==0) {
                 
                 if(tobLocalEta() <=s_FWD_EtaPosition[4]) { //Region 2 and 3
                     globalEta = -(25 +2*(tobLocalEta()-9))-1;
                 }
                 else if(tobLocalEta() <= s_FWD_EtaPosition[6]) { //Region 4
                     globalEta = -s_FCAL_EtaPosition[tobLocalEta()-13]-1;
                 }
             }            
         }
  
         return globalEta;
     }

◆ unpackGlobalPhi()

uint xAOD::jFexSRJetRoI_v1::unpackGlobalPhi ( ) const

Definition at line 182 of file jFexSRJetRoI_v1.cxx.

                                                 {
         uint globalPhi = 0;
         const unsigned int quadrant = ::getQuadrant(fpgaNumber());
  
         //16 is the phi height of an FPGA
         if(jFexNumber() == 0 || jFexNumber() == 5) {
             
             if(tobLocalEta() <=s_FWD_EtaPosition[1]) { //Region 1
                 globalPhi = tobLocalPhi() + (quadrant * 16);
             }
             else if(tobLocalEta() <=s_FWD_EtaPosition[4]) {//Region 2 and Region 3 have the same granularity
                 globalPhi = (16*quadrant) + 2*(tobLocalPhi());
             }
             else if(tobLocalEta() <=s_FWD_EtaPosition[6]) {//Region 4
                 globalPhi = (16*quadrant) + 4*(tobLocalPhi())+1;
             }
         }
         else { //Modules 1-4
             globalPhi = tobLocalPhi() + (quadrant * 16);
         }
  
         return globalPhi;
     }

◆ unpackPhiIndex()

unsigned int xAOD::jFexSRJetRoI::unpackPhiIndex ( ) const

Phi coordinates.

Definition at line 126 of file jFexSRJetRoI_v1.cxx.

                                                    {
      return (tobWord() >> s_phiBit) & s_phiMask;
    }

◆ unpackSaturationIndex()

unsigned int xAOD::jFexSRJetRoI::unpackSaturationIndex ( ) const

Definition at line 131 of file jFexSRJetRoI_v1.cxx.

                                                          {
      return (tobWord() >> s_satBit) & s_satMask;
    }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 260 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 270 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 324 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.

◆ s_etaBit

const int xAOD::jFexSRJetRoI_v1::s_etaBit = 5

staticprivate

Definition at line 96 of file jFexSRJetRoI_v1.h.

◆ s_etaMask

const int xAOD::jFexSRJetRoI_v1::s_etaMask = 0x1f

staticprivate

Definition at line 102 of file jFexSRJetRoI_v1.h.

◆ s_etBit

const int xAOD::jFexSRJetRoI_v1::s_etBit = 10

staticprivate

Definition at line 95 of file jFexSRJetRoI_v1.h.

◆ s_etMask

const int xAOD::jFexSRJetRoI_v1::s_etMask = 0x7ff

staticprivate

Definition at line 101 of file jFexSRJetRoI_v1.h.

◆ s_FCAL_EtaPosition

const std::vector< int > xAOD::jFexSRJetRoI_v1::s_FCAL_EtaPosition = {32,34,35,37,38,40,41,43,44,46,47,49}

staticprivate

Definition at line 91 of file jFexSRJetRoI_v1.h.

◆ s_FWD_EtaPosition

const std::vector< int > xAOD::jFexSRJetRoI_v1::s_FWD_EtaPosition

staticprivate

Initial value:

=   {0,  8,   
                                                                 9, 11,   
                                                                    12,   
                                                                13, 24}

Definition at line 90 of file jFexSRJetRoI_v1.h.

◆ s_phiBit

const int xAOD::jFexSRJetRoI_v1::s_phiBit = 1

staticprivate

Definition at line 97 of file jFexSRJetRoI_v1.h.

◆ s_phiMask

const int xAOD::jFexSRJetRoI_v1::s_phiMask = 0xf

staticprivate

Definition at line 103 of file jFexSRJetRoI_v1.h.

◆ s_resBit

const int xAOD::jFexSRJetRoI_v1::s_resBit = 21

staticprivate

Definition at line 94 of file jFexSRJetRoI_v1.h.

◆ s_resMask

const int xAOD::jFexSRJetRoI_v1::s_resMask = 0x7ff

staticprivate

Definition at line 104 of file jFexSRJetRoI_v1.h.

◆ s_satBit

const int xAOD::jFexSRJetRoI_v1::s_satBit = 0

staticprivate

Definition at line 98 of file jFexSRJetRoI_v1.h.

◆ s_satMask

const int xAOD::jFexSRJetRoI_v1::s_satMask = 0x1

staticprivate

Definition at line 105 of file jFexSRJetRoI_v1.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 920 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ jFexSRJetRoI_v1()

Member Function Documentation

◆ 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()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ et()

◆ eta()

◆ fpgaNumber()

◆ getAuxIDs()

◆ getConstStore()

◆ getStore()

◆ globalEta()

◆ globalPhi()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ initialize()

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ isTOB()

◆ jFexNumber()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ menuEta()

◆ noPrivateData()

◆ phi()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()

◆ setConstStore()

◆ setEta()

◆ setfpgaNumber()

◆ setGlobalEta()

◆ setGlobalPhi()

◆ setHadPrivateData()

◆ setHavePrivateData()

◆ setIndex()

◆ setIndexPrivate()

◆ setIsTOB()

◆ setjFexNumber()

◆ setNonConstStore()

◆ setNoPrivateData()

◆ setPhi()

◆ setResolution()

◆ setStore() [1/3]

◆ setStore() [2/3]