ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::gFexJetRoI_v1 Class Reference

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

#include <gFexJetRoI_v1.h>

Inheritance diagram for xAOD::gFexJetRoI_v1:
Collaboration diagram for xAOD::gFexJetRoI_v1:

Public Types

enum  ObjectType { gRho = 0 , gBlockLead = 1 , gBlockSub = 2 , gJet = 3 }
 Object types. More...
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

 gFexJetRoI_v1 ()
 Default constructor.
void initialize (uint32_t word, int tobEtScale)
 Initialise the object with its most important properties: only the word for gFEX.
uint32_t word () const
 The "raw" 32-bit word describing the object candidate.
void setWord (uint32_t value)
 Set the "raw" 32-bit words describing the object candidate.
int menuEta () const
 the eta index to use for looking up thresholds in the menu
int tobEtScale () const
void setScale (int value)
 Set the "raw" 32-bit words describing the object candidate.
int16_t gFexTobEt () const
 TOB ET (decoded from TOB, stored for convenience)
void setTobEt (int16_t value)
 getter for integer ET on TOB scale (3.2 GeV/count)
int16_t unpackEt () const
 setter for the above
float et () const
 retrieves the Et index from the 32-bit word
uint8_t iEta () const
 floating point value (GeV, TOB scale)
void setEta (uint8_t value)
 getter for integer eta index (0-63)
unsigned int unpackEtaIndex () const
 setter for the above
float eta () const
 retrieves the Eta index from the 32-bit word
float etaMin () const
 Floating point.
float etaMax () const
 Floating point.
uint8_t iPhi () const
 Floating point.
void setPhi (uint8_t value)
 Getter for integer phi index (0-32) --> check numbers for gFEX.
unsigned int unpackPhiIndex () const
 Setter for the above.
float phi_gFex () const
 retrieves the phi index from the 32-bit word
float phiMin_gFex () const
 Central value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float phiMax_gFex () const
 Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float phi () const
 High value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float phiMin () const
 Central value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
float phiMax () const
 Low value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
int iPhiTopo () const
 High value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
uint8_t status () const
 phi index in the range used by L1Topo (0->127)
void setStatus (uint8_t value)
unsigned int unpackStatus () const
uint8_t saturated () const
 retrieves the Status info from the 32-bit word
void setSaturated (uint8_t value)
unsigned int unpackSaturated () const
int gFexType () const
 retrieves the Saturated info from the 32-bit word
void setgFexType (int type)
int unpackType () const
bool isgBlockLead () const
 Identification of object type with flags.
bool isgBlockSub () const
bool isgJet () const
bool isgRho () const
void assign (const AuxElement &other, bool warnUnlocked=false)
 Assignment.
const SG::AuxVectorDatacontainer () const
 Return the container holding this element.
SG::AuxVectorDatacontainer ()
 Return the container holding this element.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type auxdata (const std::string &name)
 Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type auxdata (const std::string &name, const std::string &clsname)
 Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdata (const std::string &name) const
 Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED 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.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdataConst (const std::string &name) const
 Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdataConst (const std::string &name, const std::string &clsname) const
 Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailable (const std::string &name, const std::string &clsname="") const
 Check if an aux variable is available for reading.
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.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
 Check if an aux variable is available for writing as a decoration.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type auxdecor (const std::string &name) const
 Fetch an aux decoration, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type auxdecor (const std::string &name, const std::string &clsname) const
 Fetch an aux decoration, as a non-const reference.
void makePrivateStore ()
 Create a new (empty) private store for this object.
template<class U1>
void makePrivateStore (const U1 &other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data.
template<class U1>
void makePrivateStore (const U1 *other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data.
void releasePrivateStore ()
 Release and free any private store associated with this object.
void setStore (const SG::IConstAuxStore *store)
 Set the store associated with this object.
void setStore (SG::IAuxStore *store)
 Set the store associated with this object.
void setStore (const DataLink< SG::IConstAuxStore > &store)
 Set the store associated with this object.
void setConstStore (const SG::IConstAuxStore *store)
 Synonym for setStore with IConstAuxStore.
void setNonConstStore (SG::IAuxStore *store)
 Synonym for setStore with IAuxStore.
bool usingPrivateStore () const
 Test to see if this object is currently using a private store.
bool usingStandaloneStore () const
 Test to see if this object is currently using a standalone store.
const SG::IConstAuxStoregetConstStore () const
 Return the current store, as a const interface.
SG::IAuxStoregetStore () const
 Return the current store, as a non-const interface.
void clearCache ()
 Clear the cached aux data pointers.
const SG::auxid_set_tgetAuxIDs () const
 Return a set of identifiers for existing data items for this object.
const SG::auxid_set_tgetDecorIDs () const
 Return a set of identifiers for decorations for this object.
bool hasStore () const
 Return true if this object has an associated store.
bool hasNonConstStore () const
 Return true if this object has an associated non-const store.
bool clearDecorations () const
 Clear all decorations.
bool trackIndices () const
 Return true if index tracking is enabled for this object.
size_t index () const
 Return the index of this element within its container.

Static Public Attributes

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

Protected Member Functions

bool noPrivateData () const
 True if this element has no private data.
bool havePrivateData () const
 True if this element currently has private data.
bool hadPrivateData () const
 True if this element had private data before it was added to its current container.

Private Types

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

Private Member Functions

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

Static Private Member Functions

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

Private Attributes

const SG::AuxVectorDatam_container
 The container of which this object is an element.
size_t m_index
 The index of this element within its container.
PrivateStoreState m_privateStoreState

Static Private Attributes

static const float s_PhiWidth = (2*pi)/32
 Constants used in converting to ATLAS units.
static const float s_PhiWidthFR = (2*pi)/16
static const std::vector< floats_EtaEdge
static const std::vector< floats_EtaCenter
static const int s_saturBit = 31
 Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in the _v2 object so that different versions can be decoded by one class.
static const int s_phiBit = 26
static const int s_etaBit = 20
static const int s_etBit = 8
static const int s_statusBit = 7
static const int s_resBit = 5
static const int s_tobIDBit = 0
static const int s_saturMask = 0x1
static const int s_phiMask = 0x1f
static const int s_etaMask = 0x3f
static const int s_etMask = 0xfff
static const int s_statusMask = 0x1
static const int s_resMask = 0x3
static const int s_tobIDMask = 0x1f

Detailed Description

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

Definition at line 25 of file gFexJetRoI_v1.h.

Member Typedef Documentation

◆ Accessor

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

Definition at line 572 of file AuxElement.h.

◆ ConstAccessor

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

Definition at line 569 of file AuxElement.h.

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

◆ TypelessConstAccessor

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

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ ObjectType

Object types.

Enumerator
gRho 
gBlockLead 

This object is a TOB (32 bit word)

gBlockSub 

This object is a TOB (32 bit word)

gJet 

This object is a TOB (32 bit word)

This object is a TOB (32 bit word)

Definition at line 35 of file gFexJetRoI_v1.h.

35 {
36 gRho = 0,
37 gBlockLead = 1,
38 gBlockSub = 2,
39 gJet = 3,
41 };
@ gBlockLead
This object is a TOB (32 bit word)
@ gBlockSub
This object is a TOB (32 bit word)
@ gJet
This object is a TOB (32 bit word)

◆ PrivateStoreState

enum class SG::IAuxElement::PrivateStoreState : uint8_t
strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE 
HAVE_PRIVATE 
HAD_PRIVATE 

Definition at line 131 of file IAuxElement.h.

132 {
133 NO_PRIVATE = 0,
134 HAVE_PRIVATE = 1,
135 HAD_PRIVATE = 2,
136 };

Constructor & Destructor Documentation

◆ gFexJetRoI_v1()

xAOD::gFexJetRoI_v1::gFexJetRoI_v1 ( )

Default constructor.

Definition at line 38 of file gFexJetRoI_v1.cxx.

39 : SG::AuxElement() {
40
41 }

Member Function Documentation

◆ assign()

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

Assignment.

Parameters
otherThe object from which we're assigning.
warnUnlockedIf 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
nameName 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
nameName 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
nameName of the aux variable.
clsnameThe 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
nameName of the aux variable.
clsnameThe 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
nameName 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
nameName of the aux variable.
clsnameThe 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
nameName 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
nameName of the aux variable.
clsnameThe 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.

581{
582 if (!m_container) return;
584}
static void clearAuxHelper(AuxVectorData &container, size_t index)
Clear all aux data associated with an element.
const SG::AuxVectorData * container() const
Return the container holding this element.
size_t index() const
Return the index of this element within its container.
const SG::AuxVectorData * m_container
The container of which this object is an element.
Definition AuxElement.h:335

◆ clearAuxHelper()

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

Clear all aux data associated with an element.

Parameters
containerContainer of the element.
indexIndex of this element within the container.

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

Definition at line 639 of file AuxElement.cxx.

640{
641 if (!container.hasStore()) return;
642 if (!container.hasNonConstStore()) {
643 throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
644 }
645
646 SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
647 for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
648 r.clear (auxid, container, index, 1);
649 }
650}
static AuxTypeRegistry & instance()
Return the singleton registry instance.
int r
Definition globals.cxx:22
static const auxid_t null_auxid
To signal no aux data item.
Definition AuxTypes.h:30
size_t auxid_t
Identifier for a particular aux data item.
Definition AuxTypes.h:27

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

340{
341 if (container())
343}
void clearCache()
Clear the cached aux data pointers.

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

429{
430 if (havePrivateData())
431 return m_container->clearDecorations();
432 return false;
433}
bool havePrivateData() const
True if this element currently has private data.

◆ 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
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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

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

Definition at line 600 of file AuxElement.cxx.

602{
603 if (!m_container) return;
604 copyAuxHelper (*container(), index(), other, warnUnlocked);
605}
static void copyAuxHelper(AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
Copy aux data from another object.

◆ copyAuxHelper()

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

Copy aux data from another object.

Parameters
containerContainer of the element.
indexIndex of this element within the container.
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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

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

Definition at line 667 of file AuxElement.cxx.

671{
672 if (!container.hasStore()) return;
673 if (!container.hasNonConstStore())
674 throw SG::ExcConstAuxData ("copyAux");
675
676 const SG::AuxVectorData* ocont = other.container();
677
678 if (!ocont || !ocont->hasStore()) {
680 return;
681 }
682
683#ifndef XAOD_STANDALONE
684 const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
685#endif
686 SG::auxid_set_t other_ids = ocont->getAuxIDs();
687
688 size_t oindex = other.index();
689 SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
690
691 for (SG::auxid_t auxid : other_ids) {
692#ifndef XAOD_STANDALONE
693 if (other_decors.test (auxid)) {
694 // Don't copy decorations --- another thread may be modifying them.
695 other_ids.reset (auxid);
696 // Warn if we skip a decoration (except for mcEventWeights,
697 // for which this is expected).
698 if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
699 std::ostringstream ss;
700 ss << "skipped unlocked decoration " << r.getName(auxid)
701 << " (" << auxid << ")";
702 ATHCONTAINERS_WARNING("copyAux", ss.str());
703 }
704 }
705 else
706#endif
707 if (!r.isLinked (auxid)) {
708 r.copy (auxid, container, index, *ocont, oindex, 1);
709 }
710 }
711
712 for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
713 if (!other_ids.test (auxid)) {
714 r.clear (auxid, container, index, 1);
715 }
716 }
717}
static Double_t ss
bool test(bit_t bit) const
Test to see if a bit is set.
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items in store associated with this object.
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
bool hasStore() const
Return true if this object has an associated store.
#define ATHCONTAINERS_WARNING(ctx, msg)
Definition error.h:57

◆ et()

float xAOD::gFexJetRoI_v1::et ( ) const

retrieves the Et index from the 32-bit word

Definition at line 160 of file gFexJetRoI_v1.cxx.

160 {
161 return gFexTobEt()*tobEtScale();
162 }
int16_t gFexTobEt() const
TOB ET (decoded from TOB, stored for convenience)
int tobEtScale() const

◆ eta()

float xAOD::gFexJetRoI_v1::eta ( ) const

retrieves the Eta index from the 32-bit word

Definition at line 167 of file gFexJetRoI_v1.cxx.

167 {
168 if (gFexType() != gRho){
169 int new_iEtaFR = 0;
170 // Remapping in the extreme FR
171 if (iEta() < 4 || iEta() > 35){
172 if (iEta() == 2){
173 new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
174 }
175 if (iEta() == 3){
176 new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
177 }
178 if (iEta() == 36){
179 new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
180 }
181 if (iEta() == 37){
182 new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
183 }
184 return s_EtaCenter[new_iEtaFR];
185 }
186 //No remapping for central region |eta| < 3.0
187 else{
188 return s_EtaCenter[iEta()];
189 }
190 }
191 return 0;
192 }
uint8_t iEta() const
floating point value (GeV, TOB scale)
uint8_t iPhi() const
Floating point.
static const std::vector< float > s_EtaCenter
int gFexType() const
retrieves the Saturated info from the 32-bit word
setRawEt setRawPhi int

◆ etaMax()

float xAOD::gFexJetRoI_v1::etaMax ( ) const

Floating point.

Definition at line 222 of file gFexJetRoI_v1.cxx.

222 {
223 if (gFexType() != gRho){
224 int new_iEtaFR = 0;
225 // Remapping in the extreme FR
226 if (iEta() < 4 || iEta() > 35){
227 if (iEta() == 2){
228 new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
229 }
230 if (iEta() == 3){
231 new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
232 }
233 if (iEta() == 36){
234 new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
235 }
236 if (iEta() == 37){
237 new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
238 }
239 return s_EtaEdge[new_iEtaFR + 1];
240 }
241 //No remapping for central region |eta| < 3.0
242 else{
243 return s_EtaEdge[iEta() + 1];
244 }
245 }
246 return 0;
247 }
static const std::vector< float > s_EtaEdge

◆ etaMin()

float xAOD::gFexJetRoI_v1::etaMin ( ) const

Floating point.

Floating point coordinates. Return he minimum Eta and he maximum Eta of the Eta range.

Definition at line 195 of file gFexJetRoI_v1.cxx.

195 {
196 if (gFexType() != gRho){
197 int new_iEtaFR = 0;
198 // Remapping in the extreme FR
199 if (iEta() < 4 || iEta() > 35){
200 if (iEta() == 2){
201 new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
202 }
203 if (iEta() == 3){
204 new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
205 }
206 if (iEta() == 36){
207 new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
208 }
209 if (iEta() == 37){
210 new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
211 }
212 return s_EtaEdge[new_iEtaFR];
213 }
214 //No remapping for central region |eta| < 3.0
215 else{
216 return s_EtaEdge[iEta()];
217 }
218 }
219 return 0;
220 }

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

356{
357#ifdef ATHCONTAINERS_R21_COMPAT
358 if (havePrivateData())
359 return m_container->getConstStore()->getAuxIDs();
360 if (container())
361 return container()->getAuxIDs();
362 static const SG::auxid_set_t null_set;
363 return null_set;
364#else
366#endif
367}
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items for this object.

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

305{
306 if (havePrivateData()) {
307 return m_container->getConstStore();
308 }
309 return 0;
310}

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

379{
380#ifdef ATHCONTAINERS_R21_COMPAT
381 if (havePrivateData())
382 return m_container->getConstStore()->getDecorIDs();
383 if (container())
384 return container()->getDecorIDs();
385 static const SG::auxid_set_t null_set;
386 return null_set;
387#else
389#endif
390}
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.

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

320{
321 if (havePrivateData()) {
322#ifdef ATHCONTAINERS_R21_COMPAT
323 SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
324#else
325 SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
326#endif
327 return container_nc->getStore();
328 }
329 return 0;
330}
#define ATLAS_THREAD_SAFE

◆ gFexTobEt()

int16_t xAOD::gFexJetRoI_v1::gFexTobEt ( ) const

TOB ET (decoded from TOB, stored for convenience)

◆ gFexType()

int xAOD::gFexJetRoI_v1::gFexType ( ) const

retrieves the Saturated info from the 32-bit word

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

412{
413 if (havePrivateData())
414 return m_container->hasNonConstStore();
415 return false;
416}

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

399{
400 if (havePrivateData())
401 return m_container->hasStore();
402 return false;
403}

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const
protectedinherited

True if this element currently has private data.

◆ iEta()

uint8_t xAOD::gFexJetRoI_v1::iEta ( ) const

floating point value (GeV, TOB scale)

Eta Coordinates (decoded from TOB, stored for convenience)

◆ index()

size_t SG::IAuxElement::index ( ) const
inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ initialize()

void xAOD::gFexJetRoI_v1::initialize ( uint32_t word,
int tobEtScale )

Initialise the object with its most important properties: only the word for gFEX.

Definition at line 43 of file gFexJetRoI_v1.cxx.

43 {
44
45 setWord( word );
48 setTobEt( unpackEt() );
53
54 }
void setScale(int value)
Set the "raw" 32-bit words describing the object candidate.
void setPhi(uint8_t value)
Getter for integer phi index (0-32) --> check numbers for gFEX.
void setgFexType(int type)
void setTobEt(int16_t value)
getter for integer ET on TOB scale (3.2 GeV/count)
unsigned int unpackPhiIndex() const
Setter for the above.
unsigned int unpackEtaIndex() const
setter for the above
void setSaturated(uint8_t value)
uint32_t word() const
The "raw" 32-bit word describing the object candidate.
void setEta(uint8_t value)
getter for integer eta index (0-63)
unsigned int unpackStatus() const
void setWord(uint32_t value)
Set the "raw" 32-bit words describing the object candidate.
void setStatus(uint8_t value)
unsigned int unpackSaturated() const
int16_t unpackEt() const
setter for the above

◆ iPhi()

uint8_t xAOD::gFexJetRoI_v1::iPhi ( ) const

Floating point.

Phi coordinates

◆ iPhiTopo()

int xAOD::gFexJetRoI_v1::iPhiTopo ( ) const

High value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 332 of file gFexJetRoI_v1.cxx.

332 {
333 int phi_out = 0;
334 if (gFexType() != gRho){
335 if (( iEta() <= 3 ) || ( (iEta() >= 36) )){
336 phi_out = ( 8 * iPhi() ) + 4;
337 }
338 else {
339 phi_out = ( 4 * iPhi() ) + 2;
340 }
341 }
342 return phi_out;
343 }

◆ 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
nameName of the aux variable.
clsnameThe 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
nameName of the aux variable.
clsnameThe 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
nameName of the aux variable.
clsnameThe 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.

◆ isgBlockLead()

bool xAOD::gFexJetRoI_v1::isgBlockLead ( ) const

Identification of object type with flags.

Definition at line 114 of file gFexJetRoI_v1.cxx.

114 {
115 return gFexType() == gBlockLead;
116 }

◆ isgBlockSub()

bool xAOD::gFexJetRoI_v1::isgBlockSub ( ) const

Definition at line 118 of file gFexJetRoI_v1.cxx.

118 {
119 return gFexType() == gBlockSub;
120 }

◆ isgJet()

bool xAOD::gFexJetRoI_v1::isgJet ( ) const

Definition at line 122 of file gFexJetRoI_v1.cxx.

122 {
123 return gFexType() == gJet;
124 }

◆ isgRho()

bool xAOD::gFexJetRoI_v1::isgRho ( ) const

Definition at line 126 of file gFexJetRoI_v1.cxx.

126 {
127 return gFexType() == gRho;
128 }

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

193{
194 if (m_container) {
195 throw SG::ExcBadPrivateStore ("store already exists");
196 }
197
198 m_container = new SG::AuxElementPrivateData;
201}
void setIndex(size_t index)
Set the index of this element within its container.
void setHavePrivateData()
Record that this element currently has private data.

◆ 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
otherThe object from which aux data should be copied.
warnUnlockedIf 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
otherThe object from which aux data should be copied.
warnUnlockedIf 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
otherThe object from which aux data should be copied.
warnUnlockedIf 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.

567{
569 if (other)
570 this->copyAux (*other, warnUnlocked);
571}
void makePrivateStore()
Create a new (empty) private store for this object.
void copyAux(const ConstAuxElement &other, bool warnUnlocked=false)
Copy aux data from another object.

◆ 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
otherThe object from which aux data should be copied.
warnUnlockedIf 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.

◆ menuEta()

int xAOD::gFexJetRoI_v1::menuEta ( ) const

the eta index to use for looking up thresholds in the menu

Definition at line 56 of file gFexJetRoI_v1.cxx.

56 {
57 return static_cast<int>(eta()*40)/4;
58 }
float eta() const
retrieves the Eta index from the 32-bit word

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const
protectedinherited

True if this element has no private data.

◆ phi()

float xAOD::gFexJetRoI_v1::phi ( ) const

High value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 300 of file gFexJetRoI_v1.cxx.

300 {
301 float phi_out = 0;
302 if (gFexType() != gRho){
303 if (phi_gFex() < pi) phi_out = phi_gFex();
304 else phi_out = (phi_gFex() - 2*pi);
305 }
306 return phi_out;
307 }
#define pi
float phi_gFex() const
retrieves the phi index from the 32-bit word

◆ phi_gFex()

float xAOD::gFexJetRoI_v1::phi_gFex ( ) const

retrieves the phi index from the 32-bit word

Definition at line 254 of file gFexJetRoI_v1.cxx.

254 {
255 float phi_out = 0;
256 if (gFexType() != gRho){
257 float phi_idx;
258 if (iEta() < 4 || iEta() > 35){
259 // take the even iphi() and divide by 2 to get a continuous range (0-15)
260 if (int(iPhi()%2) == 0 ){
261 phi_idx = iPhi()/2;
262 phi_out = (phi_idx * s_PhiWidthFR) + (s_PhiWidthFR/2);
263 }
264 // take the odd iphi() and get a continuous range (0,15)
265 else {
266 phi_idx = (iPhi()-1)/2;
267 phi_out = (phi_idx * s_PhiWidthFR) + (s_PhiWidthFR/2);}
268 }
269 else{
270 phi_out = (iPhi() * s_PhiWidth) + (s_PhiWidth/2);
271 }
272
273 }
274 return phi_out;
275 }
static const float s_PhiWidth
Constants used in converting to ATLAS units.
static const float s_PhiWidthFR

◆ phiMax()

float xAOD::gFexJetRoI_v1::phiMax ( ) const

Low value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 311 of file gFexJetRoI_v1.cxx.

311 {
312 float phi_out = 0;
313 if (gFexType() != gRho){
314 if (phiMax_gFex() < pi) phi_out = phiMax_gFex();
315 else phi_out = (phiMax_gFex() - 2*pi);
316 }
317 return phi_out;
318 }
float phiMax_gFex() const
Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

◆ phiMax_gFex()

float xAOD::gFexJetRoI_v1::phiMax_gFex ( ) const

Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 290 of file gFexJetRoI_v1.cxx.

290 {
291 float phi_out = 0;
292 if (gFexType() != gRho){
293 phi_out = iPhi() * s_PhiWidth + s_PhiWidth;
294 }
295 return phi_out;
296 }

◆ phiMin()

float xAOD::gFexJetRoI_v1::phiMin ( ) const

Central value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 322 of file gFexJetRoI_v1.cxx.

322 {
323 float phi_out = 0;
324 if (gFexType() != gRho){
325 if (phiMin_gFex() < pi) phi_out = phiMin_gFex();
326 else phi_out = (phiMin_gFex() - 2*pi);
327 }
328 return phi_out;
329 }
float phiMin_gFex() const
Central value of phi corresponding to phi index (using gFex convention, phi in [0,...

◆ phiMin_gFex()

float xAOD::gFexJetRoI_v1::phiMin_gFex ( ) const

Central value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 280 of file gFexJetRoI_v1.cxx.

280 {
281 float phi_out = 0;
282 if (gFexType() != gRho){
283 phi_out = iPhi() * s_PhiWidth;
284 }
285 return phi_out;
286 }

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

211{
212 if (hadPrivateData()) {
213 // We had a private store, but it was released because this object
214 // was added to a container. Just forget about it.
216 return;
217 }
218
219 if (!havePrivateData() ||
220 !m_container ||
221 typeid(*m_container) != typeid(AuxElementPrivateData))
222 {
223 throw SG::ExcBadPrivateStore ("no private store exists");
224 }
225
228 delete m_container;
229 m_container = 0;
230}
bool hadPrivateData() const
True if this element had private data before it was added to its current container.
void setNoPrivateData()
Record that this element does not have private data.

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

442{
443#ifdef ATHCONTAINERS_R21_COMPAT
444 if (havePrivateData()) {
445 delete m_container;
446 }
447#else
449#endif
450}
void releasePrivateStoreForDtor()
Out-of-line portion of destructor.

◆ saturated()

uint8_t xAOD::gFexJetRoI_v1::saturated ( ) const

retrieves the Status info from the 32-bit word

Energy saturation: if any gTower is saturated within gBlock and gJet, this bit is set. Always 0 for Rho.

◆ setConstStore()

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

Synonym for setStore with IConstAuxStore.

Parameters
storeThe new store.

◆ setEta()

void xAOD::gFexJetRoI_v1::setEta ( uint8_t value)

getter for integer eta index (0-63)

◆ setgFexType()

void xAOD::gFexJetRoI_v1::setgFexType ( int type)

◆ 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
indexThe index of this object within the container.
containerThe 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
indexThe index of this object within the container.
containerThe 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.

506{
507#ifdef ATHCONTAINERS_R21_COMPAT
508 if (hadPrivateData()) {
509 // We had a private store, but it was released because we were added
510 // to a container.
511
512 if (container == 0) {
513 // We're being moved out of the container. Make a new private
514 // store, copy the data, and switch to it.
515 auto privateData = new SG::AuxElementPrivateData;
516 AuxElement to (privateData, 0);
517 to.copyAux (*this);
520 m_container = privateData;
521 return true;
522 }
523 }
524 else if (havePrivateData() &&
525 typeid(*m_container) == typeid(AuxElementPrivateData))
526 {
527 // We currently have a private store.
528
529 if (container != 0 && container != m_container) {
530 // We're being added to a container.
531 // Aux data has already been copied.
532 // Release private store.
535 delete m_container;
537 return false;
538 }
539 }
540 else {
541 // We have a standalone store.
542 throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
543 "from a container.");
544 }
545
548 return false;
549#else
551#endif
552}
AuxElement()
Default constructor.
bool setIndexPrivate(size_t index, const SG::AuxVectorData *container)
Set the index/container for this element.
void setHadPrivateData()
Record that this element used to have private data.
CONT to(RANGE &&r)
Definition ranges.h:39

◆ setNonConstStore()

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

Synonym for setStore with IAuxStore.

Parameters
storeThe new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )
privateinherited

Record that this element does not have private data.

◆ setPhi()

void xAOD::gFexJetRoI_v1::setPhi ( uint8_t value)

Getter for integer phi index (0-32) --> check numbers for gFEX.

◆ setSaturated()

void xAOD::gFexJetRoI_v1::setSaturated ( uint8_t value)

◆ setScale()

void xAOD::gFexJetRoI_v1::setScale ( int value)

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

◆ setStatus()

void xAOD::gFexJetRoI_v1::setStatus ( uint8_t value)

◆ setStore() [1/3]

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

Set the store associated with this object.

Parameters
storeThe 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
storeLink to the new store.

Definition at line 269 of file AuxElement.cxx.

270{
271 AuxElementStandaloneData* data = setStore1 (store);
272 if (store)
273 data->setStore (store);
274}
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
AuxElementStandaloneData * setStore1(const SG::IConstAuxStore *store)
Set the store associated with this object.

◆ setStore() [2/3]

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

Set the store associated with this object.

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

242{
243 AuxElementStandaloneData* data = setStore1 (store);
244 if (store)
245 data->setStore (store);
246}

◆ setStore() [3/3]

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

Set the store associated with this object.

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

258{
259 AuxElementStandaloneData* data = setStore1 (store);
260 if (store)
261 data->setStore (store);
262}

◆ setStore1()

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Parameters
storeThe new store.

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

Definition at line 461 of file AuxElement.cxx.

462{
463 if (store) {
464 // Want this object be standalone.
465 if (!m_container) {
466 // Not in a container (and no private store). Make a new object.
467 AuxElementStandaloneData* data = new AuxElementStandaloneData;
470 return data;
471 }
472 if (usingStandaloneStore()) {
473 // Standalone --- return existing object.
474 return static_cast<AuxElementStandaloneData*> (container());
475 }
476 // Otherwise, it's an error.
477 throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
478 "object in a container or with a private store.");
479 }
480
481 else {
482 // Getting rid of a standalone store.
483 if (usingStandaloneStore()) {
485 delete m_container;
486 m_container = 0;
487 }
488 else if (m_container != 0)
489 throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
490 "object in a container or with a private store.");
491 return 0;
492 }
493}
bool usingStandaloneStore() const
Test to see if this object is currently using a standalone store.

◆ setTobEt()

void xAOD::gFexJetRoI_v1::setTobEt ( int16_t value)

getter for integer ET on TOB scale (3.2 GeV/count)

◆ setWord()

void xAOD::gFexJetRoI_v1::setWord ( uint32_t value)

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

◆ status()

uint8_t xAOD::gFexJetRoI_v1::status ( ) const

phi index in the range used by L1Topo (0->127)

TOB status: set to 1 if TOB Et exceeds TOB threshold (gBlocks & gJets). Status is set to 1 if Rho calculation is valid

◆ tobEtScale()

int xAOD::gFexJetRoI_v1::tobEtScale ( ) const

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

◆ unpackEt()

int16_t xAOD::gFexJetRoI_v1::unpackEt ( ) const

setter for the above

Definition at line 141 of file gFexJetRoI_v1.cxx.

141 {
142 // Data content = TOB
143 int16_t energy = (word() >> s_etBit) & s_etMask;
144 return energy;
145 }
static const int s_etBit
static const int s_etMask
setScaleOne setStatusOne setSaturated int16_t

◆ unpackEtaIndex()

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

setter for the above

Definition at line 148 of file gFexJetRoI_v1.cxx.

148 {
149 return (word() >> s_etaBit) & s_etaMask;
150 }
static const int s_etaBit
static const int s_etaMask

◆ unpackPhiIndex()

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

Setter for the above.

Definition at line 153 of file gFexJetRoI_v1.cxx.

153 {
154 return (word() >> s_phiBit) & s_phiMask;
155
156 }
static const int s_phiMask
static const int s_phiBit

◆ unpackSaturated()

unsigned int xAOD::gFexJetRoI_v1::unpackSaturated ( ) const

Definition at line 135 of file gFexJetRoI_v1.cxx.

135 {
136 return (word() >> s_saturBit) & s_saturMask;
137 }
static const int s_saturMask
static const int s_saturBit
Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in t...

◆ unpackStatus()

unsigned int xAOD::gFexJetRoI_v1::unpackStatus ( ) const

Definition at line 131 of file gFexJetRoI_v1.cxx.

131 {
132 return (word() >> s_statusBit) & s_statusMask;
133 }
static const int s_statusMask
static const int s_statusBit

◆ unpackType()

int xAOD::gFexJetRoI_v1::unpackType ( ) const

Definition at line 97 of file gFexJetRoI_v1.cxx.

97 {
98 auto tobID = (word() >> s_tobIDBit) & s_tobIDMask;
99 if (tobID == 0 ){
100 return gRho;
101 }
102 else if (tobID == 1 || tobID == 2) {
103 return gBlockLead;
104 }
105 else if (tobID == 3 || tobID == 4 ) {
106 return gBlockSub;
107 }
108 else if (tobID == 5 || tobID == 6) {
109 return gJet;
110 }
111 else return -999;
112 }
static const int s_tobIDMask
static const int s_tobIDBit

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

281{
282 return havePrivateData() &&
283 typeid(*m_container) == typeid(AuxElementPrivateData);
284}

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

291{
292 return havePrivateData() &&
293 typeid(*m_container) == typeid(AuxElementStandaloneData);
294}

◆ word()

uint32_t xAOD::gFexJetRoI_v1::word ( ) const

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

Member Data Documentation

◆ m_container

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

The container of which this object is an element.

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

Definition at line 335 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index
privateinherited

The index of this element within its container.

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

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState
privateinherited

Definition at line 137 of file IAuxElement.h.

◆ s_etaBit

const int xAOD::gFexJetRoI_v1::s_etaBit = 20
staticprivate

Definition at line 125 of file gFexJetRoI_v1.h.

◆ s_EtaCenter

const std::vector< float > xAOD::gFexJetRoI_v1::s_EtaCenter
staticprivate
Initial value:
= { -4.5, -3.8, -3.38, -3.18, -3.15, -3,
-2.8, -2.6, -2.35, -2.1, -1.9, -1.7, -1.5, -1.3, -1.1, -0.9,
-0.7, -0.5, -0.3, -0.1, 0.1, 0.3, 0.5, 0.7, 0.9, 1.1,
1.3, 1.5, 1.7, 1.9, 2.1, 2.35, 2.6, 2.8, 3.0,
3.15, 3.18, 3.38, 3.8, 4.5}

Definition at line 114 of file gFexJetRoI_v1.h.

◆ s_EtaEdge

const std::vector< float > xAOD::gFexJetRoI_v1::s_EtaEdge
staticprivate
Initial value:
= { -4.9, -4.1, -3.5, -3.25, -3.2, -3.1,
-2.9, -2.7, -2.5, -2.2, -2.0, -1.8, -1.6, -1.4, -1.2, -1.0,
-0.8, -0.6, -0.4, -0.2, 0.0, 0.2, 0.4, 0.6, 0.8, 1.0,
1.2, 1.4, 1.6, 1.8, 2.0, 2.2, 2.5, 2.7, 2.9,
3.1,3.25, 3.3, 3.5, 4.1, 4.9 }

Definition at line 113 of file gFexJetRoI_v1.h.

◆ s_etaMask

const int xAOD::gFexJetRoI_v1::s_etaMask = 0x3f
staticprivate

Definition at line 134 of file gFexJetRoI_v1.h.

◆ s_etBit

const int xAOD::gFexJetRoI_v1::s_etBit = 8
staticprivate

Definition at line 126 of file gFexJetRoI_v1.h.

◆ s_etMask

const int xAOD::gFexJetRoI_v1::s_etMask = 0xfff
staticprivate

Definition at line 135 of file gFexJetRoI_v1.h.

◆ s_phiBit

const int xAOD::gFexJetRoI_v1::s_phiBit = 26
staticprivate

Definition at line 124 of file gFexJetRoI_v1.h.

◆ s_phiMask

const int xAOD::gFexJetRoI_v1::s_phiMask = 0x1f
staticprivate

Definition at line 133 of file gFexJetRoI_v1.h.

◆ s_PhiWidth

const float xAOD::gFexJetRoI_v1::s_PhiWidth = (2*pi)/32
staticprivate

Constants used in converting to ATLAS units.

Definition at line 111 of file gFexJetRoI_v1.h.

◆ s_PhiWidthFR

const float xAOD::gFexJetRoI_v1::s_PhiWidthFR = (2*pi)/16
staticprivate

Definition at line 112 of file gFexJetRoI_v1.h.

◆ s_resBit

const int xAOD::gFexJetRoI_v1::s_resBit = 5
staticprivate

Definition at line 128 of file gFexJetRoI_v1.h.

◆ s_resMask

const int xAOD::gFexJetRoI_v1::s_resMask = 0x3
staticprivate

Definition at line 137 of file gFexJetRoI_v1.h.

◆ s_saturBit

const int xAOD::gFexJetRoI_v1::s_saturBit = 31
staticprivate

Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in the _v2 object so that different versions can be decoded by one class.

Definition at line 123 of file gFexJetRoI_v1.h.

◆ s_saturMask

const int xAOD::gFexJetRoI_v1::s_saturMask = 0x1
staticprivate

Definition at line 132 of file gFexJetRoI_v1.h.

◆ s_statusBit

const int xAOD::gFexJetRoI_v1::s_statusBit = 7
staticprivate

Definition at line 127 of file gFexJetRoI_v1.h.

◆ s_statusMask

const int xAOD::gFexJetRoI_v1::s_statusMask = 0x1
staticprivate

Definition at line 136 of file gFexJetRoI_v1.h.

◆ s_tobIDBit

const int xAOD::gFexJetRoI_v1::s_tobIDBit = 0
staticprivate

Definition at line 129 of file gFexJetRoI_v1.h.

◆ s_tobIDMask

const int xAOD::gFexJetRoI_v1::s_tobIDMask = 0x1f
staticprivate

Definition at line 138 of file gFexJetRoI_v1.h.

◆ supportsThinning

bool SG::AuxElement::supportsThinning = true
staticconstexprinherited

Mark that this type supports thinning operations.

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

Definition at line 959 of file AuxElement.h.


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