Class describing a LVL1 eFEX EM region of interest. More...

#include <eFexEMRoI_v1.h>

Inheritance diagram for xAOD::eFexEMRoI_v1:

Collaboration diagram for xAOD::eFexEMRoI_v1:

Public Types
enum	ObjectType { xTOB = 0, TOB = 1 }
	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
	eFexEMRoI_v1 ()
	Default constructor. More...

void	initialize (unsigned int eFexNumber, unsigned int shelf, uint32_t word0)
	Initialise the object with its most important properties TOB initialiser. More...

void	initialize (uint32_t word0, uint32_t word1)
	xTOB initialiser More...

uint32_t	word0 () const
	The "raw" 32-bit words describing the e/gamma candidate. More...

uint32_t	word1 () const

void	setWord0 (uint32_t value)
	Set the "raw" 32-bit words describing the e/gamma candidate. More...

void	setWord1 (uint32_t value)

float	et () const
	TOB ET (decoded from TOB, stored for convenience) More...

void	setEt (float value)
	floating point value (MeV, TOB scale) More...

float	eta () const
	setter for the above More...

void	setEta (float value)
	Getter for floating point, full precision (0.025) eta. More...

int	iEta () const
	setter for the above More...

unsigned int	seed () const
	getter for integer eta index (-25->+24) More...

float	phi () const
	Seed supercell index within central tower (0 -> 3) More...

void	setPhi (float value)
	Floating point, ATLAS phi convention (-pi -> pi) More...

int	iPhi () const
	Setter for the above. More...

int	iEtaTopo () const
	Getter for integer phi index (0-63) More...

int	iPhiTopo () const
	Return phi index in the range used by L1Topo (0->127) More...

float	Reta () const
	Jet Discriminants Derived floating point values (not used in actual algorithm) More...

float	Rhad () const

float	Wstot () const

uint16_t	RetaCore () const
	Actual values used in algorithm (setters and getters) More...

uint16_t	RetaEnv () const

uint16_t	RhadEM () const

uint16_t	RhadHad () const

uint16_t	WstotNumerator () const

uint16_t	WstotDenominator () const

void	setRetaCore (uint16_t value)

void	setRetaEnv (uint16_t value)

void	setRhadEM (uint16_t value)

void	setRhadHad (uint16_t value)

void	setWstotNumerator (uint16_t value)

void	setWstotDenominator (uint16_t value)

char	isTOB () const
	Is this one a TOB (or xTOB partner of a TOB)? More...

void	setIsTOB (char value)

uint32_t	tobWord () const
	Return TOB word corresponding to this TOB or xTOB. More...

ObjectType	type () const
	Data decoded from the TOB/RoI word and eFEX number. More...

unsigned int	shelfNumber () const
	Shelf number. More...

unsigned int	eFexNumber () const
	Methods to decode data from the TOB/RoI and return to the user. More...

unsigned int	fpga () const
	FPGA number. More...

unsigned int	fpgaEta () const
	eta index within FPGA More...

unsigned int	fpgaPhi () const
	phi index within FPGA More...

unsigned int	UpNotDown () const
	Cluster up/down flag (1 = up, 0 = down) More...

unsigned int	etTOB () const
	Cluster ET (TOB ET scale, 100 MeV/count) More...

unsigned int	etXTOB () const
	Cluster ET (xTOB ET scale, 25 MeV/count) More...

unsigned int	RetaThresholds () const
	Jet Discriminant 1 (R_eta) results. More...

unsigned int	RhadThresholds () const
	Jet Discriminant 2 (R_had) results. More...

unsigned int	WstotThresholds () const
	Jet Discriminant 3 (W_stot) results. More...

unsigned int	seedMax () const
	Seed = max flag. Is this really useful? More...

unsigned int	bcn4 () const

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

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

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

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::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, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrivateStoreState	m_privateStoreState

Static Private Attributes
static const float	s_tobEtScale = 100.
	Constants used in converting to ATLAS units. More...

static const float	s_xTobEtScale = 25.

static const float	s_towerEtaWidth = 0.1

static const int	s_fpgaBit = 30
	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. More...

static const int	s_etaBit = 27

static const int	s_phiBit = 24

static const int	s_veto3Bit = 22

static const int	s_veto2Bit = 20

static const int	s_veto1Bit = 18

static const int	s_seedBit = 16

static const int	s_updownBit = 15

static const int	s_maxBit = 14

static const int	s_etBit = 0

static const int	s_etBitXTOB = 2

static const int	s_bcn4Bit = 28

static const int	s_shelfBit = 24

static const int	s_eFexBit = 20

static const int	s_fpgaMask = 0x3

static const int	s_etaMask = 0x7

static const int	s_phiMask = 0x7

static const int	s_veto1Mask = 0x3

static const int	s_veto2Mask = 0x3

static const int	s_veto3Mask = 0x3

static const int	s_seedMask = 0x3

static const int	s_updownMask = 0x1

static const int	s_maxMask = 0x1

static const int	s_etMask = 0xfff

static const int	s_etFullMask = 0xffff

static const int	s_bcn4Mask = 0xf

static const int	s_eFexMask = 0xf

static const int	s_shelfMask = 0xf

static const int	s_numPhi = 64

static const int	s_eFexPhiMask = 0xf

static const int	s_eFexPhiBit = 0

static const int	s_eFexPhiWidth = 8

static const int	s_eFexPhiOffset = 2

static const int	s_eFexEtaMask = 0xf

static const int	s_eFexEtaBit = 4

static const int	s_eFexEtaWidth = 16

static const int	s_fpgaEtaWidth = 4

static const int	s_shelfPhiWidth = 4

static const int	s_minEta = -25

Detailed Description

Class describing a LVL1 eFEX EM region of interest.

This class describes the properties of an EM Trigger Object (TOB) or Region of Interest (RoI) in the xAOD format.

Author: Alan Watson Alan..nosp@m.Wats.nosp@m.on@ce.nosp@m.rn.c.nosp@m.h

Revision: 1

Date: 2019-06-30 12:15:18 +0100 (Sun, 30 Jun 2019)

Definition at line 33 of file eFexEMRoI_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

enum xAOD::eFexEMRoI_v1::ObjectType

Object types.

Enumerator
xTOB	This object is an xTOB (2*32 bit words)
TOB	This object is a TOB (1*32 bit word)

Definition at line 46 of file eFexEMRoI_v1.h.

◆ 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

◆ eFexEMRoI_v1()

xAOD::eFexEMRoI_v1::eFexEMRoI_v1 ( )

Default constructor.

Definition at line 23 of file eFexEMRoI_v1.cxx.

       : SG::AuxElement() {
  
    }

Member Function Documentation

◆ assign()

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

inherited

Assignment.

Parameters

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

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

◆ auxdata() [1/4]

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

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

inherited

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

Parameters

name	Name of the aux variable.

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

◆ auxdata() [2/4]

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

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

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

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

◆ auxdata() [3/4]

template<class T , 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.

◆ bcn4()

unsigned int xAOD::eFexEMRoI_v1::bcn4 ( ) const

Definition at line 194 of file eFexEMRoI_v1.cxx.

                                          {
      return (word1() >> s_bcn4Bit) & s_bcn4Mask;
    }

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

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

Definition at line 580 of file AuxElement.cxx.

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

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

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

Definition at line 339 of file AuxElement.cxx.

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

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

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

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

Definition at line 428 of file AuxElement.cxx.

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

◆ container() [1/2]

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

inherited

Return the container holding this element.

◆ container() [2/2]

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

inherited

Return the container holding this element.

◆ copyAux()

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

privateinherited

Copy aux data from another object.

Parameters

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

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

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

Definition at line 607 of file AuxElement.cxx.

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

◆ eFexNumber()

setWord1 setRetaEnv setRhadHad setWstotDenominator setEt setPhi unsigned int xAOD::eFexEMRoI_v1::eFexNumber ( ) const

Methods to decode data from the TOB/RoI and return to the user.

eFEX number

Definition at line 121 of file eFexEMRoI_v1.cxx.

                                                {
      return (word1() >> s_eFexBit) & s_eFexMask;
    }

◆ et()

float xAOD::eFexEMRoI_v1::et ( ) const

TOB ET (decoded from TOB, stored for convenience)

◆ eta()

float xAOD::eFexEMRoI_v1::eta ( ) const

setter for the above

Eta Coordinates (decoded from TOB, float stored for convenience)

◆ etTOB()

unsigned int xAOD::eFexEMRoI_v1::etTOB ( ) const

Cluster ET (TOB ET scale, 100 MeV/count)

Raw ET on TOB scale (100 MeV/count)

Definition at line 162 of file eFexEMRoI_v1.cxx.

                                           {
      // Data content = TOB
      if (etXTOB() == 0) {
        return (word0() >> s_etBit) & s_etMask;
      }
      // Data Content = xTOB. Need to remove lower bits and cap range
      else {
        unsigned int etWord = (etXTOB() >> s_etBitXTOB);
        if (etWord > s_etMask) etWord = s_etMask; 
        return etWord;
      }
    }

◆ etXTOB()

unsigned int xAOD::eFexEMRoI_v1::etXTOB ( ) const

Cluster ET (xTOB ET scale, 25 MeV/count)

Full precision ET (25 MeV/count, only available if object is an xTOB.

If the object is not an xTOB this will return 0

Definition at line 176 of file eFexEMRoI_v1.cxx.

                                            {
      return (word1() >> s_etBit) & s_etFullMask;
    }

◆ fpga()

unsigned int xAOD::eFexEMRoI_v1::fpga ( ) const

FPGA number.

Hardware coordinate elements.

Definition at line 137 of file eFexEMRoI_v1.cxx.

                                          {
      return (word0() >> s_fpgaBit) & s_fpgaMask;
    }

◆ fpgaEta()

unsigned int xAOD::eFexEMRoI_v1::fpgaEta ( ) const

eta index within FPGA

Definition at line 141 of file eFexEMRoI_v1.cxx.

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

◆ fpgaPhi()

unsigned int xAOD::eFexEMRoI_v1::fpgaPhi ( ) const

phi index within FPGA

Definition at line 145 of file eFexEMRoI_v1.cxx.

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

◆ getAuxIDs()

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

inherited

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

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

Definition at line 355 of file AuxElement.cxx.

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

◆ getConstStore()

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

inherited

Return the current store, as a const interface.

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

Definition at line 304 of file AuxElement.cxx.

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

◆ getDecorIDs()

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

inherited

Return a set of identifiers for decorations for this object.

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

Definition at line 378 of file AuxElement.cxx.

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

◆ getStore()

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

inherited

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

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

Definition at line 319 of file AuxElement.cxx.

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

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

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

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

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

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

Definition at line 411 of file AuxElement.cxx.

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

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

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

Definition at line 398 of file AuxElement.cxx.

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

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ iEta()

int xAOD::eFexEMRoI_v1::iEta ( ) const

setter for the above

Return an eta index in the range -25 -> +24 Value corresponds to 10*lower eta edge of tower Note that this may not be the final format! And you need to combine with the seed() value to get full eta precision.

With appropriate constants this should work in one line...

Return value

Definition at line 248 of file eFexEMRoI_v1.cxx.

                                 {
  
      int index = s_minEta + (eFexNumber()%3)*s_eFexEtaWidth + fpga()*s_fpgaEtaWidth + fpgaEta();
  
      return index;
  
    }

◆ iEtaTopo()

int xAOD::eFexEMRoI_v1::iEtaTopo ( ) const

Getter for integer phi index (0-63)

Return an eta index in the range used by L1Topo (-100->+99)

Getters for Topo coordinate indices

This returns e/g seed position as an integer index. Value corresponds to 4*lower eta edge of supercell (so 0 means 0.0 -> 0.025)

Definition at line 267 of file eFexEMRoI_v1.cxx.

                                     {
  
      return iEta()*4 + seed();
  
    }

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

void xAOD::eFexEMRoI_v1::initialize	(	uint32_t	word0,
		uint32_t	word1
	)

xTOB initialiser

xTOB initialize method

Quantities derived from TOB data, stored for convenience

If the object is a TOB then the isTOB should be true. For xTOB default is false, but should be set if a matching TOB is found

Definition at line 58 of file eFexEMRoI_v1.cxx.

                                                                  {
  
       using std::numbers::pi;
  
       // xTOBs will have eFEX and Shelf numbers in word 1 
       // So all we need to do is set the TOB words
       setWord0( word0 );
       setWord1( word1 );
  
       setEt( etTOB()*s_tobEtScale );
       float etaVal = iEta()*s_towerEtaWidth + (seed()+0.5)*s_towerEtaWidth/4;
       setEta( etaVal );
       float phiVal = iPhi() * pi/32. + pi/64.;
       if (phiVal > pi) phiVal = phiVal - 2.*pi;
       setPhi( phiVal );
  
       if (type() == TOB) setIsTOB(1);
       else               setIsTOB(0);
  
       return;
    }

◆ initialize() [2/2]

void xAOD::eFexEMRoI_v1::initialize	(	unsigned int	eFexNumber,
		unsigned int	shelf,
		uint32_t	word0
	)

Initialise the object with its most important properties TOB initialiser.

Quantities derived from TOB data, stored for convenience

If the object is a TOB then the isTOB should be true. For xTOB default is false, but should be set by the user if a matching TOB is found

Definition at line 28 of file eFexEMRoI_v1.cxx.

                                                                                               {
  
       using std::numbers::pi;
  
       // xTOBs will have eFEX and Shelf numbers in word 1 
       // To save space, use the second word of this object, which is not part of a TOB, to store these values
       uint32_t word1 = 0;
       word1 |= (eFexNumber&s_eFexMask)<<s_eFexBit;
       word1 |= (shelf&s_shelfMask)<<s_shelfBit;
       setWord0( word0 );
       setWord1( word1 );
  
       setEt( etTOB()*s_tobEtScale );
       float etaVal = iEta()*s_towerEtaWidth + (seed()+0.5)*s_towerEtaWidth/4;
       setEta( etaVal );
       float phiVal = iPhi() * pi/32. + pi/64.;
       if (phiVal > pi) phiVal = phiVal - 2.*pi;
       setPhi( phiVal );
  
       if (type() == TOB) setIsTOB(1);
       else               setIsTOB(0);
  
       return;
    }

◆ iPhi()

int xAOD::eFexEMRoI_v1::iPhi ( ) const

Setter for the above.

Methods that decode the eFEX number.

Return phi index in the range 0-63

Calculate octant (0-7) from eFEX and shelf numbers

Find global phi index (0-63) for this window in this eFEX

Definition at line 232 of file eFexEMRoI_v1.cxx.

                                {
  
      unsigned int octant = int(eFexNumber()/3) + shelfNumber()*s_shelfPhiWidth;
  
      int index = s_eFexPhiWidth*octant + fpgaPhi() + s_eFexPhiOffset;
      if (index >= s_numPhi) index -= s_numPhi;
  
      return index;
    }

◆ iPhiTopo()

int xAOD::eFexEMRoI_v1::iPhiTopo ( ) const

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

Topo use pi/64 steps. Ours are pi/32, so we simply return 2* our integer index

Definition at line 259 of file eFexEMRoI_v1.cxx.

                                    {
  
      return iPhi()*2;
  
    }

◆ 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::eFexEMRoI_v1::isTOB ( ) const

Is this one a TOB (or xTOB partner of a TOB)?

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

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

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

Definition at line 192 of file AuxElement.cxx.

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

◆ makePrivateStore() [2/3]

template<class U1 >

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

inherited

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

Parameters

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

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

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

◆ makePrivateStore() [3/3]

template<class U1 >

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

inherited

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

Parameters

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

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

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

◆ makePrivateStore1() [1/2]

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

privateinherited

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

Parameters

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

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

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

Definition at line 565 of file AuxElement.cxx.

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

◆ makePrivateStore1() [2/2]

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

privateinherited

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

Parameters

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

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

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

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ phi()

float xAOD::eFexEMRoI_v1::phi ( ) const

Seed supercell index within central tower (0 -> 3)

Phi coordinates (as for eta)

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

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

Definition at line 210 of file AuxElement.cxx.

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

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

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

◆ Reta()

float xAOD::eFexEMRoI_v1::Reta ( ) const

Jet Discriminants Derived floating point values (not used in actual algorithm)

Jet discriminant values.

Note that these are for convenience & intelligibility, but these should not be used for bitwise-accurate menu studies

Definition at line 212 of file eFexEMRoI_v1.cxx.

                                   {
      float sum = RetaCore() + RetaEnv();
      if (sum > 0) return (1. - RetaCore()/sum);
      else         return -1.;
    }

◆ RetaCore()

uint16_t xAOD::eFexEMRoI_v1::RetaCore ( ) const

Actual values used in algorithm (setters and getters)

◆ RetaEnv()

uint16_t xAOD::eFexEMRoI_v1::RetaEnv ( ) const

◆ RetaThresholds()

unsigned int xAOD::eFexEMRoI_v1::RetaThresholds ( ) const

Jet Discriminant 1 (R_eta) results.

Results of the 3 jet discriminant algorithms.

Definition at line 182 of file eFexEMRoI_v1.cxx.

                                                    {
      return (word0() >> s_veto1Bit) & s_veto1Mask;
    }

◆ Rhad()

float xAOD::eFexEMRoI_v1::Rhad ( ) const

Definition at line 218 of file eFexEMRoI_v1.cxx.

                                   {
      float sum = RhadEM() + RhadHad();
      if (sum > 0) return (RhadHad()/sum);
      else         return -1.;
    }

◆ RhadEM()

uint16_t xAOD::eFexEMRoI_v1::RhadEM ( ) const

◆ RhadHad()

uint16_t xAOD::eFexEMRoI_v1::RhadHad ( ) const

◆ RhadThresholds()

unsigned int xAOD::eFexEMRoI_v1::RhadThresholds ( ) const

Jet Discriminant 2 (R_had) results.

Definition at line 186 of file eFexEMRoI_v1.cxx.

                                                    {
      return (word0() >> s_veto3Bit) & s_veto3Mask;
    }

◆ seed()

unsigned int xAOD::eFexEMRoI_v1::seed ( ) const

getter for integer eta index (-25->+24)

Definition at line 153 of file eFexEMRoI_v1.cxx.

                                          {
      return (word0() >> s_seedBit) & s_seedMask;
    }

◆ seedMax()

unsigned int xAOD::eFexEMRoI_v1::seedMax ( ) const

Seed = max flag. Is this really useful?

Definition at line 157 of file eFexEMRoI_v1.cxx.

                                             {
      return (word0() >> s_maxBit) & s_maxMask;
    }

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setEt()

void xAOD::eFexEMRoI_v1::setEt ( float value )

floating point value (MeV, TOB scale)

◆ setEta()

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

Getter for floating point, full precision (0.025) eta.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setIndex()

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

privateinherited

Set the index/container for this element.

Parameters

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

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

◆ setIndexPrivate()

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

privateinherited

Set the index/container for this element.

Parameters

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

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

Definition at line 505 of file AuxElement.cxx.

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

◆ setIsTOB()

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

◆ 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::eFexEMRoI_v1::setPhi ( float value )

Floating point, ATLAS phi convention (-pi -> pi)

◆ setRetaCore()

void xAOD::eFexEMRoI_v1::setRetaCore ( uint16_t value )

◆ setRetaEnv()

void xAOD::eFexEMRoI_v1::setRetaEnv ( uint16_t value )

◆ setRhadEM()

void xAOD::eFexEMRoI_v1::setRhadEM ( uint16_t value )

◆ setRhadHad()

void xAOD::eFexEMRoI_v1::setRhadHad ( uint16_t 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 269 of file AuxElement.cxx.

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

◆ setStore() [2/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 241 of file AuxElement.cxx.

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

◆ setStore() [3/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 257 of file AuxElement.cxx.

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

◆ setStore1()

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

privateinherited

Set the store associated with this object.

Parameters

store The new store.

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

Parameters

store The new store.

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

Definition at line 461 of file AuxElement.cxx.

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

◆ setWord0()

void xAOD::eFexEMRoI_v1::setWord0 ( uint32_t value )

Set the "raw" 32-bit words describing the e/gamma candidate.

◆ setWord1()

void xAOD::eFexEMRoI_v1::setWord1 ( uint32_t value )

◆ setWstotDenominator()

void xAOD::eFexEMRoI_v1::setWstotDenominator ( uint16_t value )

◆ setWstotNumerator()

void xAOD::eFexEMRoI_v1::setWstotNumerator ( uint16_t value )

◆ shelfNumber()

unsigned int xAOD::eFexEMRoI_v1::shelfNumber ( ) const

Shelf number.

Definition at line 126 of file eFexEMRoI_v1.cxx.

                                                 {
      return (word1() >> s_shelfBit) & s_shelfMask;
    }

◆ tobWord()

uint32_t xAOD::eFexEMRoI_v1::tobWord ( ) const

Return TOB word corresponding to this TOB or xTOB.

Return single 32-bit TOB word from an xTOB.

Definition at line 199 of file eFexEMRoI_v1.cxx.

                                         {
      // Do something sensible if called for a TOB
      if (etXTOB() == 0) return word0();
      // When called for xTOB
      else {
        uint32_t word = word0() + etTOB();
        return word;
      }
    }

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

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

◆ type()

eFexEMRoI_v1::ObjectType xAOD::eFexEMRoI_v1::type ( ) const

Data decoded from the TOB/RoI word and eFEX number.

TOB or xTOB?

Object type (TOB or xTOB)

Definition at line 131 of file eFexEMRoI_v1.cxx.

                                                    {
      if (etXTOB() == 0) return TOB;
      else               return xTOB;
    }

◆ UpNotDown()

unsigned int xAOD::eFexEMRoI_v1::UpNotDown ( ) const

Cluster up/down flag (1 = up, 0 = down)

Definition at line 149 of file eFexEMRoI_v1.cxx.

                                               {
      return (word0() >> s_updownBit) & s_updownMask;
    }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 280 of file AuxElement.cxx.

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

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

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

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

Definition at line 290 of file AuxElement.cxx.

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

◆ word0()

uint32_t xAOD::eFexEMRoI_v1::word0 ( ) const

The "raw" 32-bit words describing the e/gamma candidate.

◆ word1()

uint32_t xAOD::eFexEMRoI_v1::word1 ( ) const

◆ Wstot()

float xAOD::eFexEMRoI_v1::Wstot ( ) const

Definition at line 224 of file eFexEMRoI_v1.cxx.

                                    {
      if (WstotDenominator() > 0) return (static_cast<float>(WstotNumerator())/WstotDenominator());
      else         return -1.;
    }

◆ WstotDenominator()

uint16_t xAOD::eFexEMRoI_v1::WstotDenominator ( ) const

◆ WstotNumerator()

uint16_t xAOD::eFexEMRoI_v1::WstotNumerator ( ) const

◆ WstotThresholds()

unsigned int xAOD::eFexEMRoI_v1::WstotThresholds ( ) const

Jet Discriminant 3 (W_stot) results.

Definition at line 190 of file eFexEMRoI_v1.cxx.

                                                     {
      return (word0() >> s_veto2Bit) & s_veto2Mask;
    }

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_bcn4Bit

const int xAOD::eFexEMRoI_v1::s_bcn4Bit = 28

staticprivate

Definition at line 174 of file eFexEMRoI_v1.h.

◆ s_bcn4Mask

const int xAOD::eFexEMRoI_v1::s_bcn4Mask = 0xf

staticprivate

Definition at line 190 of file eFexEMRoI_v1.h.

◆ s_eFexBit

const int xAOD::eFexEMRoI_v1::s_eFexBit = 20

staticprivate

Definition at line 176 of file eFexEMRoI_v1.h.

◆ s_eFexEtaBit

const int xAOD::eFexEMRoI_v1::s_eFexEtaBit = 4

staticprivate

Definition at line 201 of file eFexEMRoI_v1.h.

◆ s_eFexEtaMask

const int xAOD::eFexEMRoI_v1::s_eFexEtaMask = 0xf

staticprivate

Definition at line 200 of file eFexEMRoI_v1.h.

◆ s_eFexEtaWidth

const int xAOD::eFexEMRoI_v1::s_eFexEtaWidth = 16

staticprivate

Definition at line 202 of file eFexEMRoI_v1.h.

◆ s_eFexMask

const int xAOD::eFexEMRoI_v1::s_eFexMask = 0xf

staticprivate

Definition at line 191 of file eFexEMRoI_v1.h.

◆ s_eFexPhiBit

const int xAOD::eFexEMRoI_v1::s_eFexPhiBit = 0

staticprivate

Definition at line 197 of file eFexEMRoI_v1.h.

◆ s_eFexPhiMask

const int xAOD::eFexEMRoI_v1::s_eFexPhiMask = 0xf

staticprivate

Definition at line 196 of file eFexEMRoI_v1.h.

◆ s_eFexPhiOffset

const int xAOD::eFexEMRoI_v1::s_eFexPhiOffset = 2

staticprivate

Definition at line 199 of file eFexEMRoI_v1.h.

◆ s_eFexPhiWidth

const int xAOD::eFexEMRoI_v1::s_eFexPhiWidth = 8

staticprivate

Definition at line 198 of file eFexEMRoI_v1.h.

◆ s_etaBit

const int xAOD::eFexEMRoI_v1::s_etaBit = 27

staticprivate

Definition at line 164 of file eFexEMRoI_v1.h.

◆ s_etaMask

const int xAOD::eFexEMRoI_v1::s_etaMask = 0x7

staticprivate

Definition at line 180 of file eFexEMRoI_v1.h.

◆ s_etBit

const int xAOD::eFexEMRoI_v1::s_etBit = 0

staticprivate

Definition at line 172 of file eFexEMRoI_v1.h.

◆ s_etBitXTOB

const int xAOD::eFexEMRoI_v1::s_etBitXTOB = 2

staticprivate

Definition at line 173 of file eFexEMRoI_v1.h.

◆ s_etFullMask

const int xAOD::eFexEMRoI_v1::s_etFullMask = 0xffff

staticprivate

Definition at line 189 of file eFexEMRoI_v1.h.

◆ s_etMask

const int xAOD::eFexEMRoI_v1::s_etMask = 0xfff

staticprivate

Definition at line 188 of file eFexEMRoI_v1.h.

◆ s_fpgaBit

const int xAOD::eFexEMRoI_v1::s_fpgaBit = 30

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 163 of file eFexEMRoI_v1.h.

◆ s_fpgaEtaWidth

const int xAOD::eFexEMRoI_v1::s_fpgaEtaWidth = 4

staticprivate

Definition at line 203 of file eFexEMRoI_v1.h.

◆ s_fpgaMask

const int xAOD::eFexEMRoI_v1::s_fpgaMask = 0x3

staticprivate

Definition at line 179 of file eFexEMRoI_v1.h.

◆ s_maxBit

const int xAOD::eFexEMRoI_v1::s_maxBit = 14

staticprivate

Definition at line 171 of file eFexEMRoI_v1.h.

◆ s_maxMask

const int xAOD::eFexEMRoI_v1::s_maxMask = 0x1

staticprivate

Definition at line 187 of file eFexEMRoI_v1.h.

◆ s_minEta

const int xAOD::eFexEMRoI_v1::s_minEta = -25

staticprivate

Definition at line 205 of file eFexEMRoI_v1.h.

◆ s_numPhi

const int xAOD::eFexEMRoI_v1::s_numPhi = 64

staticprivate

Definition at line 195 of file eFexEMRoI_v1.h.

◆ s_phiBit

const int xAOD::eFexEMRoI_v1::s_phiBit = 24

staticprivate

Definition at line 165 of file eFexEMRoI_v1.h.

◆ s_phiMask

const int xAOD::eFexEMRoI_v1::s_phiMask = 0x7

staticprivate

Definition at line 181 of file eFexEMRoI_v1.h.

◆ s_seedBit

const int xAOD::eFexEMRoI_v1::s_seedBit = 16

staticprivate

Definition at line 169 of file eFexEMRoI_v1.h.

◆ s_seedMask

const int xAOD::eFexEMRoI_v1::s_seedMask = 0x3

staticprivate

Definition at line 185 of file eFexEMRoI_v1.h.

◆ s_shelfBit

const int xAOD::eFexEMRoI_v1::s_shelfBit = 24

staticprivate

Definition at line 175 of file eFexEMRoI_v1.h.

◆ s_shelfMask

const int xAOD::eFexEMRoI_v1::s_shelfMask = 0xf

staticprivate

Definition at line 192 of file eFexEMRoI_v1.h.

◆ s_shelfPhiWidth

const int xAOD::eFexEMRoI_v1::s_shelfPhiWidth = 4

staticprivate

Definition at line 204 of file eFexEMRoI_v1.h.

◆ s_tobEtScale

const float xAOD::eFexEMRoI_v1::s_tobEtScale = 100.

staticprivate

Constants used in converting to ATLAS units.

Definition at line 152 of file eFexEMRoI_v1.h.

◆ s_towerEtaWidth

const float xAOD::eFexEMRoI_v1::s_towerEtaWidth = 0.1

staticprivate

Definition at line 154 of file eFexEMRoI_v1.h.

◆ s_updownBit

const int xAOD::eFexEMRoI_v1::s_updownBit = 15

staticprivate

Definition at line 170 of file eFexEMRoI_v1.h.

◆ s_updownMask

const int xAOD::eFexEMRoI_v1::s_updownMask = 0x1

staticprivate

Definition at line 186 of file eFexEMRoI_v1.h.

◆ s_veto1Bit

const int xAOD::eFexEMRoI_v1::s_veto1Bit = 18

staticprivate

Definition at line 168 of file eFexEMRoI_v1.h.

◆ s_veto1Mask

const int xAOD::eFexEMRoI_v1::s_veto1Mask = 0x3

staticprivate

Definition at line 182 of file eFexEMRoI_v1.h.

◆ s_veto2Bit

const int xAOD::eFexEMRoI_v1::s_veto2Bit = 20

staticprivate

Definition at line 167 of file eFexEMRoI_v1.h.

◆ s_veto2Mask

const int xAOD::eFexEMRoI_v1::s_veto2Mask = 0x3

staticprivate

Definition at line 183 of file eFexEMRoI_v1.h.

◆ s_veto3Bit

const int xAOD::eFexEMRoI_v1::s_veto3Bit = 22

staticprivate

Definition at line 166 of file eFexEMRoI_v1.h.

◆ s_veto3Mask

const int xAOD::eFexEMRoI_v1::s_veto3Mask = 0x3

staticprivate

Definition at line 184 of file eFexEMRoI_v1.h.

◆ s_xTobEtScale

const float xAOD::eFexEMRoI_v1::s_xTobEtScale = 25.

staticprivate

Definition at line 153 of file eFexEMRoI_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 959 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ ObjectType

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ eFexEMRoI_v1()

Member Function Documentation

◆ assign()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ bcn4()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ eFexNumber()

◆ et()

◆ eta()

◆ etTOB()

◆ etXTOB()

◆ fpga()

◆ fpgaEta()

◆ fpgaPhi()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ iEta()

◆ iEtaTopo()

◆ index() [1/2]

◆ index() [2/2]

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ iPhi()

◆ iPhiTopo()

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ isTOB()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ noPrivateData()

◆ phi()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()

◆ Reta()

◆ RetaCore()

◆ RetaEnv()

◆ RetaThresholds()

◆ Rhad()

◆ RhadEM()

◆ RhadHad()