Class describing a LVL1 muon region of interest. More...

#include <MuonRoI_v1.h>

Inheritance diagram for xAOD::MuonRoI_v1:

Collaboration diagram for xAOD::MuonRoI_v1:

Public Types
enum	RoISource { Barrel, Endcap, Forward }
	RoI source enumeration. More...

enum	Hemisphere { Positive, Negative }
	RoI hemisphere enumeration. More...

enum	Charge { Neg = 0, Pos = 1, Undef = 100 }
	Charge sign. 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
	MuonRoI_v1 ()
	Default constructor. More...

void	initialize (uint32_t roiword, float eta, float phi, const std::string &thrname, float thrvalue, uint32_t extraword=0u)
	Initialise the object with all its properties. More...

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

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

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

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::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...

Independent properties stored for the muon candidate
float	eta () const
	The pseudorapidity ( \(\eta\)) of the muon candidate. More...

void	setEta (float v)
	Set the pseudorapidity of the muon candidate. More...

float	phi () const
	The azimuthal angle ( \(\phi\)) of the muon candidate. More...

void	setPhi (float v)
	Set the azimuthal angle of the muon candidate. More...

uint32_t	roiWord () const
	The "raw" RoI word describing the muon candidate. More...

void	setRoIWord (uint32_t value)
	Set the "raw" RoI word, describing the muon candidate. More...

float	thrValue () const
	The highest threshold value (in MeV) passed by the muon candidate. More...

void	setThrValue (float v)
	Set the threshold value passed by the muon candidate. More...

const std::string &	thrName () const
	The name of the highest threshold value passed by the muon candidate. More...

void	setThrName (const std::string &value)
	Set the name of the threshold passed by the muon candidate. More...

Properties extracted from the 32-bit muon RoI word
int	getThrNumber () const
	Get the logic number of the highest threshold this RoI passed. More...

int	getRoI () const
	Get the "RoI number" (position inside the sector) More...

int	getSectorAddress () const
	Get the full sector address. More...

int	getSectorID () const
	Get the sector ID number. More...

bool	isFirstCandidate () const
	Returns if the candidate had the highest p_T in the sector. More...

bool	isMoreCandInRoI () const
	Returns if there were other muons detected in the same RoI. More...

bool	isMoreCandInSector () const
	Returns if there were other muons detected in the same sector. More...

RoISource	getSource () const
	Returns the system that detected the muon candidate. More...

Hemisphere	getHemisphere () const
	Returns the hemisphere that detected the muon candidate. More...

bool	getPhiOverlap () const
	Returns whether there's overlap between barrel sectors. More...

bool	getEtaOverlap () const
	Returns whether there's overlap between the barrel-EC sectors. More...

Charge	getCharge () const
	Returns the charge sign of the muon candidate. More...

bool	getBW3Coincidence () const
	Returns whether or not there was a 3-station coincidence in the TGC. More...

bool	getInnerCoincidence () const
	Returns whether or not there was an inner coincidence in the TGC. More...

bool	getGoodMF () const
	Returns whether or not there was a good magnetic field quality in the TGC. More...

bool	isVetoed () const
	Returns the veto flag for the candidate. More...

bool	isRun3 () const
	Returns extra flag at end of RoI word indicating that it's in Run3 format. More...

Properties available only for Run 4+
uint32_t	roiExtraWord () const
	The second "raw" RoI word describing extra information of the muon candidate. More...

void	setRoIExtraWord (uint32_t value)
	Set the second "raw" RoI word, describing extra information of the muon candidate. More...

float	pt () const
	the transverse momentum of the muon candidate More...

bool	isRun4 () const
	flag whether it is Run4+ RoI definition More...

Static Public Attributes
static constexpr uint32_t	ETA_MASK = 0x3fff
	constants to decode RoI word for Run 4+ More...

static constexpr uint32_t	PHI_MASK = 0x1ff

static constexpr uint32_t	PT_MASK = 0xff

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 constexpr uint32_t	ETA_SHIFT = 0

static constexpr uint32_t	PHI_SHIFT = 14

static constexpr uint32_t	CHARGE_SHIFT = 23

static constexpr uint32_t	PT_SHIFT = 24

static constexpr float	PT_WIDTH = 0.5

Detailed Description

Class describing a LVL1 muon region of interest.

This class describes all the properties of a muon region of interest (RoI) in the xAOD format.

Author: Lukas Heinrich Lukas.nosp@m..Hei.nosp@m.nrich.nosp@m.@cer.nosp@m.n.ch; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 29 of file MuonRoI_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

◆ Charge

enum xAOD::MuonRoI_v1::Charge

Charge sign.

Enumerator
Neg	Candidate is a mu- from a TGC sector.
Pos	Candidate is a mu+ from a TGC sector.
Undef	This is an RPC candidate.

Definition at line 44 of file MuonRoI_v1.h.

                   {
          Neg = 0, 
          Pos = 1, 
          Undef = 100 
       };

◆ Hemisphere

enum xAOD::MuonRoI_v1::Hemisphere

RoI hemisphere enumeration.

Enumerator
Positive	The candidate came from the +z side (side A)
Negative	The candidate came from the -z side (side C)

Definition at line 39 of file MuonRoI_v1.h.

                       {
          Positive, 
          Negative  
       };

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

◆ RoISource

enum xAOD::MuonRoI_v1::RoISource

RoI source enumeration.

Enumerator
Barrel	The muon candidate was detected in the barrel region.
Endcap	The muon candidate was detected in the endcap region.
Forward	The muon candidate was detected in the forward region.

Definition at line 33 of file MuonRoI_v1.h.

                      {
          Barrel, 
          Endcap, 
          Forward 
       };

Constructor & Destructor Documentation

◆ MuonRoI_v1()

xAOD::MuonRoI_v1::MuonRoI_v1 ( )

Default constructor.

Definition at line 17 of file MuonRoI_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.

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

◆ eta()

float xAOD::MuonRoI_v1::eta ( ) const

The pseudorapidity ( \(\eta\)) of the muon candidate.

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

◆ getBW3Coincidence()

bool xAOD::MuonRoI_v1::getBW3Coincidence ( ) const

Returns whether or not there was a 3-station coincidence in the TGC.

Get whether or not there was a 3-station coincidence in the TGC.

Valid for Run-3 candidates only.

Definition at line 289 of file MuonRoI_v1.cxx.

                                             {
      if (isRun4()) return false;  // TBI
      if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_BW2OR3_SHIFT) & 0x1;
      else return false;
    }

◆ getCharge()

MuonRoI_v1::Charge xAOD::MuonRoI_v1::getCharge ( ) const

Returns the charge sign of the muon candidate.

Endcap and forward sectors can tell you what was the charge of the muon candidate.

Barrel candidates can't do this.

See also: MuonRoI_v1::RoISource; MuonRoI_v1::getSource()

Definition at line 264 of file MuonRoI_v1.cxx.

                                                 {
      if (isRun4()) {
        return ((roiWord() >> CHARGE_SHIFT) & 0x1) ? Pos : Neg;
      }
  
      if( getSource() == Barrel ) return Undef;
  
       if (isRun3()) {
     if( ( roiWord() >> RUN3_CAND_TGC_CHARGE_SIGN_SHIFT) & 0x1 ) {
       return Pos;
     } else {
       return Neg;
     }
       } else {
     if( ( roiWord() >> CAND_TGC_CHARGE_SIGN_SHIFT) & 0x1 ) {
       return Pos;
     } else {
       return Neg;
     }
       }
    }

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

◆ getEtaOverlap()

bool xAOD::MuonRoI_v1::getEtaOverlap ( ) const

Returns whether there's overlap between the barrel-EC sectors.

Get whether or not there was a eta overlap between barrel and endcap sectors at SL-level.

This is different from the overlap removal performed in the MUCTPI. Valid for Run-2 RPC/TGC candidates only

Definition at line 249 of file MuonRoI_v1.cxx.

                                         {
      if (isRun4()) return false;  // TBI
      if (isRun3()) return false;
      else {
        if (getSource() == Barrel) return (roiWord() >> BARREL_OL_SHIFT) & BARREL_ETA_OL_MASK;
        else return (roiWord() >> ENDCAP_OL_SHIFT) & ENDCAP_OL_MASK;
      }
    }

◆ getGoodMF()

bool xAOD::MuonRoI_v1::getGoodMF ( ) const

Returns whether or not there was a good magnetic field quality in the TGC.

Get whether or not there was a good magnetic field quality in the TGC.

Valid for Run-3 candidates only.

Definition at line 309 of file MuonRoI_v1.cxx.

                                     {
      if (isRun4()) return false;  // TBI
      if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_GOODMF_SHIFT) & 0x1;
      else return false;
    }

◆ getHemisphere()

MuonRoI_v1::Hemisphere xAOD::MuonRoI_v1::getHemisphere ( ) const

Returns the hemisphere that detected the muon candidate.

The function decodes the sector hemisphere encoded in the 8-bit sector address into an easy to understand enumeration.

See also: MuonRoI_v1::getSectorAddress(); MuonRoI_v1::Hemisphere

Definition at line 220 of file MuonRoI_v1.cxx.

                                                         {
      if (isRun4()) return Positive;  // TBI - not correct
      //same mask for run2 and run3
      if( this->getSectorAddress() & SECTOR_HEMISPHERE_MASK ) {
          return Positive;
       } else {
          return Negative;
       }
    }

◆ getInnerCoincidence()

bool xAOD::MuonRoI_v1::getInnerCoincidence ( ) const

Returns whether or not there was an inner coincidence in the TGC.

Get whether or not there was an inner coincidence with the TGC.

Valid for Run-3 candidates only.

Definition at line 299 of file MuonRoI_v1.cxx.

                                               {
      if (isRun4()) return false;  // TBI
      if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_INNERCOIN_SHIFT) & 0x1;
      else return false;
    }

◆ getPhiOverlap()

bool xAOD::MuonRoI_v1::getPhiOverlap ( ) const

Returns whether there's overlap between barrel sectors.

Get whether or not there was a phi overlap between barrel sectors at SL-level.

This is different from the overlap removal performed in the MUCTPI. Valid for Run-2 and Run-3 RPC candidates only

Definition at line 234 of file MuonRoI_v1.cxx.

                                         {
      if (isRun4()) return false;  // TBI
      if (isRun3()) {
        if (getSource() == Barrel) return (roiWord() >> RUN3_CAND_WORD_CANDFLAGS_BA_PHIOVERLAP_SHIFT) & RUN3_CAND_WORD_CANDFLAGS_BA_PHIOVERLAP_MASK;
        else return false;
      } else {
        if (getSource() == Barrel) return (roiWord() >> BARREL_OL_SHIFT) & BARREL_PHI_OL_MASK;
        else return false;
      }
    }

◆ getRoI()

int xAOD::MuonRoI_v1::getRoI ( ) const

Get the "RoI number" (position inside the sector)

A muon's spacial location is identified from the sector number and the hemisphere that detected it.

Each sector is additionally divided into multiple areas, called RoIs that tell you which part of the sector the muon candidate was detected in.

Returns: Integer number smaller than 147

Definition at line 89 of file MuonRoI_v1.cxx.

                                 {
      if (isRun4()) {
        return 0;   // TBI
      } else if (isRun3()) {
        if( this->getSource() == Forward ) {
      return ( ( roiWord() >> RUN3_ROI_SHIFT ) & FORWARD_ROI_MASK );
        } else if( this->getSource() == Endcap ) {
      return ( ( roiWord() >> RUN3_ROI_SHIFT ) & ENDCAP_ROI_MASK );
        } else if( this->getSource() == Barrel ) {
      return ( ( roiWord() >> RUN3_ROI_SHIFT ) & BARREL_ROI_MASK );
        }
      } else {
        if( this->getSource() == Forward ) {
      return ( ( roiWord() >> ROI_SHIFT ) & FORWARD_ROI_MASK );
        } else if( this->getSource() == Endcap ) {
      return ( ( roiWord() >> ROI_SHIFT ) & ENDCAP_ROI_MASK );
        } else if( this->getSource() == Barrel ) {
      return ( ( roiWord() >> ROI_SHIFT ) & BARREL_ROI_MASK );
        }
      }
      return 0;
    }

◆ getSectorAddress()

int xAOD::MuonRoI_v1::getSectorAddress ( ) const

Get the full sector address.

The sector address is an 8-bit identifier of the sector.

For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

The least significant bit shown which hemisphere the sector is in (0: positive side, 1: negative side), the upper (1 or 2) bits show what kind of sector it is, the rest of the address is the number of the sector.

Returns: An 8-bit identifier

Definition at line 122 of file MuonRoI_v1.cxx.

                                           {
      if (isRun4()) return 0;  // TBI
      else if (isRun3()) return ( ( roiWord() >> RUN3_CAND_SECTOR_ADDRESS_SHIFT ) & CAND_SECTOR_ADDRESS_MASK );
      else return ( ( roiWord() >> CAND_SECTOR_ADDRESS_SHIFT ) & CAND_SECTOR_ADDRESS_MASK );
    }

◆ getSectorID()

int xAOD::MuonRoI_v1::getSectorID ( ) const

Get the sector ID number.

The sector ID is a 5- or 6-bit identifier of the sector number.

For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

Returns: A 5- or 6-bit identifier

Definition at line 133 of file MuonRoI_v1.cxx.

                                      {
      if (isRun4()) {
        return 0;   // TBI
      } else if (isRun3()) {
        if( this->getSource() == Forward ) {
      return ( ( roiWord() >> RUN3_CAND_SECTORID_SHIFT ) & FORWARD_SECTORID_MASK );
        } else if( this->getSource() == Endcap ) {
      return ( ( roiWord() >> RUN3_CAND_SECTORID_SHIFT ) & ENDCAP_SECTORID_MASK );
        } else if( this->getSource() == Barrel ) {
      return ( ( roiWord() >> RUN3_CAND_SECTORID_SHIFT ) & BARREL_SECTORID_MASK );
        }
      } else {
        if( this->getSource() == Forward ) {
      return ( ( roiWord() >> CAND_SECTORID_SHIFT ) & FORWARD_SECTORID_MASK );
        } else if( this->getSource() == Endcap ) {
      return ( ( roiWord() >> CAND_SECTORID_SHIFT ) & ENDCAP_SECTORID_MASK );
        } else if( this->getSource() == Barrel ) {
      return ( ( roiWord() >> CAND_SECTORID_SHIFT ) & BARREL_SECTORID_MASK );
        }
      }
      return 0;
    }

◆ getSource()

MuonRoI_v1::RoISource xAOD::MuonRoI_v1::getSource ( ) const

Returns the system that detected the muon candidate.

The function decodes the sector type encoded in the 8-bit sector address into an easy to understand enumeration.

See also: MuonRoI_v1::getSectorAddress(); MuonRoI_v1::RoISource

Definition at line 202 of file MuonRoI_v1.cxx.

                                                    {
      if (isRun4()) return Barrel;  // TBI - not correct
      //same mask for run2 and run3
      if( this->getSectorAddress() & ENDCAP_ADDRESS_MASK ) {
          return Endcap;
      } else if( this->getSectorAddress() & FORWARD_ADDRESS_MASK ) {
          return Forward;
       } else {
          return Barrel;
       }
    }

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

◆ getThrNumber()

setThrValue setRoIExtraWord int xAOD::MuonRoI_v1::getThrNumber ( ) const

Get the logic number of the highest threshold this RoI passed.

Each detected LVL1 muon candidate is assigned a p_T threshold.

The hardware can assign one of 6/15 p_T thresholds to the candidate, which are numbered from 1 to 6 for Run-1/2, and 1 to 15 for Run-3.

Returns: Integer number in the [1, 6] range

Definition at line 76 of file MuonRoI_v1.cxx.

                                       {
      if (isRun4()) return 0;   // TBI
      else if (isRun3()) return ( ( roiWord() >> RUN3_CAND_PT_SHIFT ) & RUN3_CAND_PT_MASK );
      else return ( ( roiWord() >> CAND_PT_SHIFT ) & CAND_PT_MASK );
    }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

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

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

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

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

Definition at line 411 of file AuxElement.cxx.

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

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

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

Definition at line 398 of file AuxElement.cxx.

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

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ initialize()

void xAOD::MuonRoI_v1::initialize	(	uint32_t	roiword,
		float	eta,
		float	phi,
		const std::string &	thrname,
		float	thrvalue,
		uint32_t	extraword = `0u`
	)

Initialise the object with all its properties.

Initialize the object for Run-4+ RoI definition.

Parameters

roiword	The 32-bit RoI word coming from the MuCTPI
eta	The pseudorapidity of the candidate
phi	The aximuthal angle of the candidate
thrname	The name of the highest threshold passed by the candidate
thrvalue	The value (in MeV) of the threshold passed
extraWord	The 32-bit extra RoI word from the MUCTPI

Definition at line 31 of file MuonRoI_v1.cxx.

                                                      {
  
       setRoIWord( roiword );
       setEta( eta );
       setPhi( phi );
       setThrValue( thrvalue );
       setThrName( thrname );
       setRoIExtraWord( extraword );
       return;
    }

◆ isAvailable()

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

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

inherited

Check if an aux variable is available for reading.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

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

◆ isAvailableWritable()

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

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

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

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

◆ isAvailableWritableAsDecoration()

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

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

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

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

◆ isFirstCandidate()

bool xAOD::MuonRoI_v1::isFirstCandidate ( ) const

Returns if the candidate had the highest p_T in the sector.

Each muon trigger sector can only send information about a maximum of two LVL1 muon candidate to the central trigger.

If this flag is true, this candidate had the highest p_T threshold assigned to it in its sector. If it's false, it was the second candidate in its sector.

actually v1 only ...

Definition at line 163 of file MuonRoI_v1.cxx.

                                            {
      if (isRun4()) return true;  // TBI
      else if (isRun3()) return true;  // undefined in run3, return default true
      else return ( ( roiWord() >> CAND_HIGHEST_PT_SHIFT ) & CAND_HIGHEST_PT_MASK );
    }

◆ isMoreCandInRoI()

bool xAOD::MuonRoI_v1::isMoreCandInRoI ( ) const

Returns if there were other muons detected in the same RoI.

One RoI (one part of the trigger sector) can only send information about one LVL1 muon candidate to the central trigger.

This flag is true if the particular RoI that detected this muon candidate also detected another candidate with lower p_T.

Definition at line 174 of file MuonRoI_v1.cxx.

                                           {
      if (isRun4()) {
        return false;   // TBI
      } else if (isRun3()) {
        if (getSource() == Barrel) return ( ( roiWord() >> RUN3_ROI_OVERFLOW_SHIFT ) & ROI_OVERFLOW_MASK );
        else return false; // Endcap + Fwd have no flag for this
      } else {
        return ( ( roiWord() >> ROI_OVERFLOW_SHIFT ) & ROI_OVERFLOW_MASK );
      }
    }

◆ isMoreCandInSector()

bool xAOD::MuonRoI_v1::isMoreCandInSector ( ) const

Returns if there were other muons detected in the same sector.

This flag is set to true if the sector that this muon candidate came from, detected more than 2 LVL1 muon candidates.

See also: MuonRoI_v1::isFirstCandidate()

Definition at line 190 of file MuonRoI_v1.cxx.

                                              {
      if (isRun4()) return false;  // TBI
      else if (isRun3()) return ( ( roiWord() >> RUN3_CAND_OVERFLOW_SHIFT ) & CAND_OVERFLOW_MASK );
      else return ( ( roiWord() >> CAND_OVERFLOW_SHIFT ) & CAND_OVERFLOW_MASK );
    }

◆ isRun3()

bool xAOD::MuonRoI_v1::isRun3 ( ) const

Returns extra flag at end of RoI word indicating that it's in Run3 format.

An extra bit is added at the end of the RoI word for run3 candidates in the EDM for technical purposes to distinguish whether we want to use the run2 or run3 bitmasks in decoding the word.

Definition at line 328 of file MuonRoI_v1.cxx.

                                  {
      return isRun4() ? false : (roiWord() >> 31 & 0x1);
    }

◆ isRun4()

bool xAOD::MuonRoI_v1::isRun4 ( ) const

flag whether it is Run4+ RoI definition

The indicator whether the RoI is Run-1/2/3 or Run-4+ format.

roiExtraWord exists only in Run-4+.

Definition at line 349 of file MuonRoI_v1.cxx.

                                  {
      static const Accessor<uint32_t> acc{"roiExtraWord"};
      if (!acc.isAvailable(*this)) {
        return false;
      } else {
        return (roiExtraWord() > 0);
      }
    }

◆ isVetoed()

bool xAOD::MuonRoI_v1::isVetoed ( ) const

Returns the veto flag for the candidate.

When the overlap handling is activated in the MuCTPI, candidates can be ignored in the multiplicity sum sent to the CTP.

This flag tells you whether this particular candidate was ignored in the multiplicity sum.

Definition at line 319 of file MuonRoI_v1.cxx.

                                    {
      if (isRun4()) return false;  // TBI
      if (isRun3()) return ( ( roiWord() >> RUN3_CAND_VETO_SHIFT) & 0x1 );
      else return ( ( roiWord() >> CAND_VETO_SHIFT) & 0x1 );
    }

◆ 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::MuonRoI_v1::phi ( ) const

The azimuthal angle ( \(\phi\)) of the muon candidate.

◆ pt()

float xAOD::MuonRoI_v1::pt ( ) const

the transverse momentum of the muon candidate

the transverse momentum of the muon candidate, which can be calculated from roiWord valid for Run-4+ only

Definition at line 342 of file MuonRoI_v1.cxx.

                               {
      if (isRun4()) return static_cast<float>((roiWord() >> PT_SHIFT) & PT_MASK) * PT_WIDTH;
      else return 0.;
    }

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

◆ roiExtraWord()

uint32_t xAOD::MuonRoI_v1::roiExtraWord ( ) const

The second "raw" RoI word describing extra information of the muon candidate.

◆ roiWord()

uint32_t xAOD::MuonRoI_v1::roiWord ( ) const

The "raw" RoI word describing the muon candidate.

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setEta()

void xAOD::MuonRoI_v1::setEta ( float v )

Set the pseudorapidity of the muon candidate.

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

◆ 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::MuonRoI_v1::setPhi ( float v )

Set the azimuthal angle of the muon candidate.

◆ setRoIExtraWord()

void xAOD::MuonRoI_v1::setRoIExtraWord ( uint32_t value )

Set the second "raw" RoI word, describing extra information of the muon candidate.

◆ setRoIWord()

void xAOD::MuonRoI_v1::setRoIWord ( uint32_t value )

Set the "raw" RoI word, describing the muon candidate.

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

◆ setThrName()

void xAOD::MuonRoI_v1::setThrName ( const std::string & value )

Set the name of the threshold passed by the muon candidate.

◆ setThrValue()

void xAOD::MuonRoI_v1::setThrValue ( float v )

Set the threshold value passed by the muon candidate.

◆ thrName()

const std::string& xAOD::MuonRoI_v1::thrName ( ) const

The name of the highest threshold value passed by the muon candidate.

◆ thrValue()

float xAOD::MuonRoI_v1::thrValue ( ) const

The highest threshold value (in MeV) passed by the muon candidate.

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

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

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 280 of file AuxElement.cxx.

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

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

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

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

Definition at line 290 of file AuxElement.cxx.

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

Member Data Documentation

◆ CHARGE_SHIFT

constexpr uint32_t xAOD::MuonRoI_v1::CHARGE_SHIFT = 23

staticconstexprprivate

Definition at line 154 of file MuonRoI_v1.h.

◆ ETA_MASK

constexpr uint32_t xAOD::MuonRoI_v1::ETA_MASK = 0x3fff

staticconstexpr

constants to decode RoI word for Run 4+

Definition at line 147 of file MuonRoI_v1.h.

◆ ETA_SHIFT

constexpr uint32_t xAOD::MuonRoI_v1::ETA_SHIFT = 0

staticconstexprprivate

Definition at line 152 of file MuonRoI_v1.h.

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

◆ PHI_MASK

constexpr uint32_t xAOD::MuonRoI_v1::PHI_MASK = 0x1ff

staticconstexpr

Definition at line 148 of file MuonRoI_v1.h.

◆ PHI_SHIFT

constexpr uint32_t xAOD::MuonRoI_v1::PHI_SHIFT = 14

staticconstexprprivate

Definition at line 153 of file MuonRoI_v1.h.

◆ PT_MASK

constexpr uint32_t xAOD::MuonRoI_v1::PT_MASK = 0xff

staticconstexpr

Definition at line 149 of file MuonRoI_v1.h.

◆ PT_SHIFT

constexpr uint32_t xAOD::MuonRoI_v1::PT_SHIFT = 24

staticconstexprprivate

Definition at line 155 of file MuonRoI_v1.h.

◆ PT_WIDTH

constexpr float xAOD::MuonRoI_v1::PT_WIDTH = 0.5

staticconstexprprivate

Definition at line 157 of file MuonRoI_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

◆ Charge

◆ Hemisphere

◆ PrivateStoreState

◆ RoISource

Constructor & Destructor Documentation

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

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ eta()

◆ getAuxIDs()

◆ getBW3Coincidence()

◆ getCharge()

◆ getConstStore()

◆ getDecorIDs()

◆ getEtaOverlap()

◆ getGoodMF()

◆ getHemisphere()

◆ getInnerCoincidence()

◆ getPhiOverlap()

◆ getRoI()

◆ getSectorAddress()

◆ getSectorID()

◆ getSource()

◆ getStore()

◆ getThrNumber()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ initialize()

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ isFirstCandidate()

◆ isMoreCandInRoI()

◆ isMoreCandInSector()

◆ isRun3()

◆ isRun4()

◆ isVetoed()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ noPrivateData()

◆ phi()

◆ pt()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()