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

Class describing the basic event information. More...

#include <EventInfo_v1.h>

Inheritance diagram for xAOD::EventInfo_v1:
Collaboration diagram for xAOD::EventInfo_v1:

Classes

class  StreamTag
 Class describing a stream tag on the event. More...
struct  PileUpMixtureID
 Unique pile-up mixture identifier definition. More...
class  SubEvent
 Class describing the properties of one pileup sub-event. More...

Public Member Functions

 EventInfo_v1 ()
 Default constructor.
 EventInfo_v1 (const EventInfo_v1 &parent)
 Copy constructor.
EventInfo_v1operator= (const EventInfo_v1 &rhs)
 Assignment operator.
void toPersistent ()
 Prepare the object for writing.
void toTransient ()
 Cleanse the object after being read in.
Basic event information
uint32_t runNumber () const
 The current event's run number.
void setRunNumber (uint32_t value)
 Set the current event's run number.
uint64_t eventNumber () const
 The current event's event number.
void setEventNumber (uint64_t value)
 Set the current event's event number.
uint32_t lumiBlock () const
 The current event's luminosity block number.
void setLumiBlock (uint32_t value)
 Set the current event's luminosity block number.
uint32_t timeStamp () const
 POSIX time in seconds from 1970. January 1st.
void setTimeStamp (uint32_t value)
 Set the POSIX time of the event.
uint32_t timeStampNSOffset () const
 Nanosecond time offset wrt. the time stamp.
void setTimeStampNSOffset (uint32_t value)
 Set the nanosecond offset wrt. the time stamp.
uint32_t bcid () const
 The bunch crossing ID of the event.
void setBCID (uint32_t value)
 Set the bunch crossing ID of the event.
uint32_t detectorMask0 () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMask0 (uint32_t value)
 Set the bit field indicating with TTC timezones were present.
uint32_t detectorMask1 () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMask1 (uint32_t value)
 Set the bit field indicating with TTC timezones were present.
uint32_t detectorMask2 () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMask2 (uint32_t value)
 Set the bit field indicating with TTC timezones were present.
uint32_t detectorMask3 () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMask3 (uint32_t value)
 Set the bit field indicating with TTC timezones were present.
uint64_t detectorMask () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMask (uint32_t mask0, uint32_t mask1)
 Set the bit fields indicating with TTC timezones were present.
void setDetectorMask (uint64_t mask)
 Set the bit fields indicating with TTC timezones were present.
uint64_t detectorMaskExt () const
 Bit field indicating which TTC zones are present in the event.
void setDetectorMaskExt (uint32_t mask2, uint32_t mask3)
 Set the bit fields indicating with TTC timezones were present.
void setDetectorMaskExt (uint64_t mask)
 Set the bit fields indicating with TTC timezones were present.
Trigger related information
uint32_t statusElement () const
 Trigger status element.
void setStatusElement (uint32_t value)
 Set the trigger status element.
uint32_t extendedLevel1ID () const
 The extended Level-1 identifier.
void setExtendedLevel1ID (uint32_t value)
 Set the extended Level-1 identifier.
uint16_t level1TriggerType () const
 The Level-1 trigger type.
void setLevel1TriggerType (uint16_t value)
 Set the Level-1 trigger type.
const std::vector< StreamTag > & streamTags () const
 Get the streams that the event was put in.
void setStreamTags (const std::vector< StreamTag > &value)
 Set the streams that the event was put in.
Beam spot information
float beamPosX () const
 X coordinate of the beam spot position.
float beamPosY () const
 Y coordinate of the beam spot position.
float beamPosZ () const
 Z coordinate of the beam spot position.
void setBeamPos (float x, float y, float z)
 Set the beam spot position.
float beamPosSigmaX () const
 The width of the beam spot in the X direction.
float beamPosSigmaY () const
 The width of the beam spot in the Y direction.
float beamPosSigmaZ () const
 The length of the beam spot in the Z direction.
void setBeamPosSigma (float x, float y, float z)
 Set the size of the beam spot.
float beamPosSigmaXY () const
 The beam spot shape's X-Y correlation.
void setBeamPosSigmaXY (float value)
 Set the beam spot shape's X-Y correlation.
float beamTiltXZ () const
 The beam's tilt in radians in XZ.
void setBeamTiltXZ (float value)
 Set the beam's tilt in radians in XZ.
float beamTiltYZ () const
 The beam's tilt in radians in YZ.
void setBeamTiltYZ (float value)
 Set the beam's tilt in radians in YZ.
uint32_t beamStatus () const
 The beam spot's status word.
void setBeamStatus (uint32_t value)
 Set the beam spot's status word.
float beamSpotWeight () const
 Weight for beam spot size reweighting.
bool hasBeamSpotWeight () const
 Check if weight for beam spot size reweighting exists.
void setBeamSpotWeight (float value)
 Set weight for beam spot size reweighting.
Functions used by pile-up digitisation
StoreGateSvc *evtStore ATLAS_NOT_CONST_THREAD_SAFE () const
 Get the pointer to the event store associated with this event.
void setEvtStore (StoreGateSvc *svc)
 Set the pointer to the event store associated with this event.

Private Member Functions

std::vector< EventInfo_v1::SubEventmakeSubEvents () const

Private Attributes

CxxUtils::CachedValue< std::vector< StreamTag > > m_streamTags
 Cached stream tag objects.
CxxUtils::CachedValue< std::vector< SubEvent > > m_subEvents
 Cached sub-event objects.
StoreGateSvcm_evtStore
 Transient pointer to the StoreGateSvc instance associated with the event (Needed for pile-up digitisation).

Event type information

enum  EventType { IS_SIMULATION = 1 , IS_TESTBEAM = 2 , IS_CALIBRATION = 4 }
 Event type codes that can be set/checked in the bitmask. More...
typedef std::vector< std::pair< std::string, std::string > > DetDescrTags_t
 Type of the detector description tags.
const DetDescrTags_tdetDescrTags () const
 The detector description tags.
void setDetDescrTags (const DetDescrTags_t &value)
 Set the detector description tags.
uint32_t mcChannelNumber () const
 The MC generator's channel number.
void setMCChannelNumber (uint32_t value)
 Set the MC generator's channel number.
uint64_t mcEventNumber () const
 The MC generator's event number.
void setMCEventNumber (uint64_t value)
 Set the MC generator's event number.
const std::vector< float > & mcEventWeights () const
 The weights of all the MC events used in the simulation.
void setMCEventWeights (const std::vector< float > &value)
 Set the weights of all the MC events used in the simulation.
float mcEventWeight (size_t i=0) const
 The weight of one specific MC event used in the simulation.
uint32_t eventTypeBitmask () const
 The event type bitmask.
void setEventTypeBitmask (uint32_t value)
 Set the event type bitmask.
bool eventType (EventType type) const
 Check for one particular bitmask value.

Pileup information

enum  PileUpType {
  Unknown = 99 , Signal = 0 , MinimumBias = 1 , Cavern = 2 ,
  HaloGas = 3 , HighPtMinimumBias = 4 , ZeroBias = 5 , PileUp_NTYPES
}
 Enumerator describing the types of pileup events. More...
float actualInteractionsPerCrossing () const
 Average interactions per crossing for the current BCID - for in-time pile-up.
void setActualInteractionsPerCrossing (float value)
 Set average interactions per crossing for the current BCID.
float averageInteractionsPerCrossing () const
 Average interactions per crossing for all BCIDs - for out-of-time pile-up.
void setAverageInteractionsPerCrossing (float value)
 Set average interactions per crossing for all BCIDs.
PileUpMixtureID pileUpMixtureID () const
 Unique pile-up mixture identifier.
void setPileUpMixtureID (const PileUpMixtureID &value)
 Set unique pile-up mixture identifier.
uint64_t pileUpMixtureIDLowBits () const
 Unique pile-up mixture identifier low bits.
void setPileUpMixtureIDLowBits (uint64_t value)
 Set unique pile-up mixture identifier low bits.
uint64_t pileUpMixtureIDHighBits () const
 Unique pile-up mixture identifier high bits.
void setPileUpMixtureIDHighBits (uint64_t value)
 Set unique pile-up mixture identifier high bits.
const std::vector< SubEvent > & subEvents () const
 Get the pileup events that were used in the simulation.
void setSubEvents (const std::vector< SubEvent > &value)
 Set the pileup events that were used in the simulation.
void addSubEvent (const SubEvent &subEvent)
 Add one sub-event to the existing list.
void clearSubEvents ()
 Clear all the currently held sub-events.
static const std::string & PileUpType2Name (PileUpType typ)
 Convert PileUpType enum value to string.
static PileUpType PileUpInt2Type (unsigned short typ)
 Convert int to PileUpType enum value.

Detector information

enum  EventFlagSubDet {
  Pixel = 0 , SCT = 1 , TRT = 2 , LAr = 3 ,
  Tile = 4 , Muon = 5 , ForwardDet = 6 , Core = 7 ,
  Background = 8 , Lumi = 9 , nDets = 10
}
 Sub-detector types for which we store event-level flags. More...
enum  EventFlagErrorState { NotSet = 0 , Warning = 1 , Error = 2 }
 States that a given sub-detector could be in. More...
enum  BackgroundEventFlag {
  MBTSTimeDiffHalo = 0 , MBTSTimeDiffCol = 1 , LArECTimeDiffHalo = 2 , LArECTimeDiffCol = 3 ,
  PixMultiplicityHuge = 4 , PixSPNonEmpty = 5 , SCTMultiplicityHuge = 6 , SCTSPNonEmpty = 7 ,
  CSCTimeDiffHalo = 8 , CSCTimeDiffCol = 9 , BCMTimeDiffHalo = 10 , BCMTimeDiffCol = 11 ,
  MuonTimingCol = 12 , MuonTimingCosmic = 13 , MBTSBeamVeto = 14 , BCMBeamVeto = 15 ,
  LUCIDBeamVeto = 16 , HaloMuonSegment = 17 , HaloClusterShape = 18 , HaloMuonOneSided = 19 ,
  HaloMuonTwoSided = 20 , HaloTileClusterPattern = 21 , BeamGasPixel = 22 , CosmicStandAlone = 23 ,
  CosmicStandAloneTight = 24 , CosmicCombined = 25 , CosmicCombinedTight = 26 , BkgdResvBit1 = 27 ,
  BkgdResvBit2 = 28 , BkgdResvBit3 = 29 , BkgdResvBit4 = 30 , BkgdResvBit5 = 31 ,
  NBackgroundWords = 32
}
 Enum for bits in Background EventFlag word. More...
uint32_t eventFlags (EventFlagSubDet subDet) const
 Get the event flags for a particular sub-detector.
bool isEventFlagBitSet (EventFlagSubDet subDet, size_t bit) const
 Check one particular bit of one particular sub-detector.
bool setEventFlags (EventFlagSubDet subDet, uint32_t flags)
 Set the event flags for a particular sub-detector.
bool setEventFlagBit (EventFlagSubDet subDet, size_t bit) const
 Set one particular bit of one particular sub-detector.
bool resetEventFlagBit (EventFlagSubDet subDet, size_t bit)
 Reset one particular bit of one particular sub-detector.
EventFlagErrorState errorState (EventFlagSubDet subDet) const
 Get the error state for a particular sub-detector.
bool setErrorState (EventFlagSubDet subDet, EventFlagErrorState state)
 Set the error state for a particular sub-detector.
bool updateEventFlagBit (const EventFlagSubDet subDet, const size_t bit) const
 Change detector flags with update semantics.
bool updateEventFlags (const EventFlagSubDet subDet, const uint32_t flags_in) const
 Turn on a set of event flags for one particular sub-detector.
bool updateErrorState (const EventFlagSubDet subDet, const EventFlagErrorState state) const
 Update the error state for one particular sub-detector.

Detailed Description

Class describing the basic event information.

This is a replacement for the offline EventInfo class, to be used in xAOD files. It stores the same information as its parent, but in much simpler format. Practically in the same format in which we store(d) event information in D3PDs.

Author
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 43 of file EventInfo_v1.h.

Member Typedef Documentation

◆ DetDescrTags_t

typedef std::vector< std::pair< std::string, std::string > > xAOD::EventInfo_v1::DetDescrTags_t

Type of the detector description tags.

Definition at line 124 of file EventInfo_v1.h.

Member Enumeration Documentation

◆ BackgroundEventFlag

Enum for bits in Background EventFlag word.

Enumerator
MBTSTimeDiffHalo 
MBTSTimeDiffCol 
LArECTimeDiffHalo 
LArECTimeDiffCol 
PixMultiplicityHuge 
PixSPNonEmpty 
SCTMultiplicityHuge 
SCTSPNonEmpty 
CSCTimeDiffHalo 
CSCTimeDiffCol 
BCMTimeDiffHalo 
BCMTimeDiffCol 
MuonTimingCol 
MuonTimingCosmic 
MBTSBeamVeto 
BCMBeamVeto 
LUCIDBeamVeto 
HaloMuonSegment 
HaloClusterShape 
HaloMuonOneSided 
HaloMuonTwoSided 
HaloTileClusterPattern 
BeamGasPixel 
CosmicStandAlone 
CosmicStandAloneTight 
CosmicCombined 
CosmicCombinedTight 
BkgdResvBit1 
BkgdResvBit2 
BkgdResvBit3 
BkgdResvBit4 
BkgdResvBit5 
NBackgroundWords 

Definition at line 353 of file EventInfo_v1.h.

353 {
355 MBTSTimeDiffCol = 1,
359 PixSPNonEmpty = 5,
361 SCTSPNonEmpty = 7,
362 CSCTimeDiffHalo = 8,
363 CSCTimeDiffCol = 9,
364 BCMTimeDiffHalo = 10,
365 BCMTimeDiffCol = 11,
366 MuonTimingCol = 12,
367 MuonTimingCosmic = 13,
368 MBTSBeamVeto = 14,
369 BCMBeamVeto = 15,
370 LUCIDBeamVeto = 16,
371 HaloMuonSegment = 17,
372 HaloClusterShape = 18,
373 HaloMuonOneSided = 19,
374 HaloMuonTwoSided = 20,
376 BeamGasPixel = 22,
377 CosmicStandAlone = 23,
379 CosmicCombined = 25,
381 BkgdResvBit1 = 27,
382 BkgdResvBit2 = 28,
383 BkgdResvBit3 = 29,
384 BkgdResvBit4 = 30,
385 BkgdResvBit5 = 31,
387 };

◆ EventFlagErrorState

States that a given sub-detector could be in.

Enumerator
NotSet 

The flag was not set to anything.

Warning 

The sub-detector issued a warning.

Error 

The sub-detector issued an error.

Definition at line 346 of file EventInfo_v1.h.

346 {
347 NotSet = 0,
348 Warning = 1,
349 Error = 2
350 };
@ Warning
The sub-detector issued a warning.
@ NotSet
The flag was not set to anything.
@ Error
The sub-detector issued an error.

◆ EventFlagSubDet

Sub-detector types for which we store event-level flags.

Enumerator
Pixel 

The pixel tracker.

SCT 

The SCT.

TRT 

The TRT.

LAr 

The LAr calorimeter.

Tile 

The Tile calorimeter.

Muon 

The muon spectrometer.

ForwardDet 

The forward detectors.

Core 

Core flags describing the event.

Background 

The beam background detectors.

Lumi 

The luminosity detectors.

nDets 

Number of sub-detector type in this enumeration.

Definition at line 331 of file EventInfo_v1.h.

331 {
332 Pixel = 0,
333 SCT = 1,
334 TRT = 2,
335 LAr = 3,
336 Tile = 4,
337 Muon = 5,
338 ForwardDet = 6,
339 Core = 7,
340 Background = 8,
341 Lumi = 9,
342 nDets = 10
343 };
@ Background
The beam background detectors.
@ Tile
The Tile calorimeter.
@ Muon
The muon spectrometer.
@ Core
Core flags describing the event.
@ Pixel
The pixel tracker.
@ ForwardDet
The forward detectors.
@ LAr
The LAr calorimeter.
@ Lumi
The luminosity detectors.
@ nDets
Number of sub-detector type in this enumeration.

◆ EventType

Event type codes that can be set/checked in the bitmask.

Enumerator
IS_SIMULATION 

true: simulation, false: data

IS_TESTBEAM 

true: testbeam, false: full detector

IS_CALIBRATION 

true: calibration, false: physics

Definition at line 149 of file EventInfo_v1.h.

149 {
151 IS_SIMULATION = 1,
153 IS_TESTBEAM = 2,
156 };
@ IS_CALIBRATION
true: calibration, false: physics
@ IS_SIMULATION
true: simulation, false: data
@ IS_TESTBEAM
true: testbeam, false: full detector

◆ PileUpType

Enumerator describing the types of pileup events.

Enumerator
Unknown 

Type not known/specified.

Signal 

The signal event.

MinimumBias 

(Low pT) Minimum bias pileup event

Cavern 

Cavern background pileup event.

HaloGas 

Halo-gas non-collision background.

HighPtMinimumBias 

High pT Minimum bias pileup event.

ZeroBias 

Zero bias pileup event.

PileUp_NTYPES 

Definition at line 264 of file EventInfo_v1.h.

264 {
265 Unknown = 99,
266 Signal = 0,
267 MinimumBias = 1,
268 Cavern = 2,
269 HaloGas = 3,
271 ZeroBias = 5,
273 }; // enum PileUpType
@ HaloGas
Halo-gas non-collision background.
@ HighPtMinimumBias
High pT Minimum bias pileup event.
@ MinimumBias
(Low pT) Minimum bias pileup event
@ ZeroBias
Zero bias pileup event.
@ Signal
The signal event.
@ Cavern
Cavern background pileup event.
@ Unknown
Type not known/specified.

Constructor & Destructor Documentation

◆ EventInfo_v1() [1/2]

xAOD::EventInfo_v1::EventInfo_v1 ( )

Default constructor.

Definition at line 82 of file EventInfo_v1.cxx.

84 m_subEvents(), m_evtStore( nullptr ) {
85
86 }
CxxUtils::CachedValue< std::vector< StreamTag > > m_streamTags
Cached stream tag objects.
StoreGateSvc * m_evtStore
Transient pointer to the StoreGateSvc instance associated with the event (Needed for pile-up digitisa...
CxxUtils::CachedValue< std::vector< SubEvent > > m_subEvents
Cached sub-event objects.
AuxElement(SG::AuxVectorData *container, size_t index)
Base class for elements of a container that can have aux data.

◆ EventInfo_v1() [2/2]

xAOD::EventInfo_v1::EventInfo_v1 ( const EventInfo_v1 & parent)

Copy constructor.

Definition at line 88 of file EventInfo_v1.cxx.

89 : SG::AuxElement(parent), m_streamTags(),
91 m_evtStore( parent.m_evtStore ) {
92
93 makePrivateStore( parent );
94 }
void makePrivateStore()
Create a new (empty) private store for this object.

Member Function Documentation

◆ actualInteractionsPerCrossing()

float xAOD::EventInfo_v1::actualInteractionsPerCrossing ( ) const

Average interactions per crossing for the current BCID - for in-time pile-up.

Definition at line 380 of file EventInfo_v1.cxx.

380 {
381
382 // If the value is not available, then return 0.0, but allow users to
383 // find out about this issue.
384 if( ! accActualInteractionsPerCrossing.isAvailable( *this ) ) {
386 return 0.0f;
387 }
388 return accActualInteractionsPerCrossing( *this );
389 }
void pileupUnsetHook()
Function that would be possible to use to debug what client is trying to access pileup values from an...
static const SG::AuxElement::Accessor< float > accActualInteractionsPerCrossing("actualInteractionsPerCrossing")
Accessor for "actualInteractionsPerCrossing".

◆ addSubEvent()

void xAOD::EventInfo_v1::addSubEvent ( const SubEvent & subEvent)

Add one sub-event to the existing list.

Definition at line 629 of file EventInfo_v1.cxx.

629 {
630
631 // First, make sure that the persistent and transient variables are in
632 // sync:
633 subEvents();
634
635 // Now, add the new sub-event:
636 std::vector<SubEvent> subEvents = *m_subEvents.ptr();
637 subEvents.push_back( subEvent );
638 m_subEvents.store (std::move (subEvents));
639 timeAcc( *this ).push_back( subEvent.time() );
640 indexAcc( *this ).push_back( subEvent.index() );
641 typeAcc( *this ).push_back( static_cast< uint16_t >( subEvent.type() ) );
642 linkAcc( *this ).push_back( subEvent.link() );
643
644 return;
645 }
uint16_t index() const
Get the index of the sub-event.
const ElementLink< EventInfoContainer_v1 > & link() const
Get a link to the EventInfo object describing the pileup event.
int16_t time() const
Get the time wrt. the signal event (which has time() == 0).
PileUpType type() const
Get the type of the pileup event.
const std::vector< SubEvent > & subEvents() const
Get the pileup events that were used in the simulation.
static const SG::AuxElement::Accessor< std::vector< uint16_t > > indexAcc("subEventIndex")
static const SG::AuxElement::Accessor< std::vector< ElementLink< EventInfoContainer_v1 > > > linkAcc("subEventLink")
static const SG::AuxElement::Accessor< std::vector< int16_t > > timeAcc("subEventTime")
static const SG::AuxElement::Accessor< std::vector< uint16_t > > typeAcc("subEventType")
setWord1 uint16_t

◆ ATLAS_NOT_CONST_THREAD_SAFE()

StoreGateSvc *evtStore xAOD::EventInfo_v1::ATLAS_NOT_CONST_THREAD_SAFE ( ) const

Get the pointer to the event store associated with this event.

◆ averageInteractionsPerCrossing()

float xAOD::EventInfo_v1::averageInteractionsPerCrossing ( ) const

Average interactions per crossing for all BCIDs - for out-of-time pile-up.

Definition at line 397 of file EventInfo_v1.cxx.

397 {
398
399 // If the value is not available, then return 0.0, but allow users to
400 // find out about this issue.
401 if( ! accAverageInteractionsPerCrossing.isAvailable( *this ) ) {
403 return 0.0f;
404 }
405 return accAverageInteractionsPerCrossing( *this );
406 }
static const SG::AuxElement::Accessor< float > accAverageInteractionsPerCrossing("averageInteractionsPerCrossing")
Accessor for "averageInteractionsPerCrossing".

◆ bcid()

uint32_t xAOD::EventInfo_v1::bcid ( ) const

The bunch crossing ID of the event.

◆ beamPosSigmaX()

float xAOD::EventInfo_v1::beamPosSigmaX ( ) const

The width of the beam spot in the X direction.

◆ beamPosSigmaXY()

float xAOD::EventInfo_v1::beamPosSigmaXY ( ) const

The beam spot shape's X-Y correlation.

◆ beamPosSigmaY()

float xAOD::EventInfo_v1::beamPosSigmaY ( ) const

The width of the beam spot in the Y direction.

◆ beamPosSigmaZ()

float xAOD::EventInfo_v1::beamPosSigmaZ ( ) const

The length of the beam spot in the Z direction.

◆ beamPosX()

float xAOD::EventInfo_v1::beamPosX ( ) const

X coordinate of the beam spot position.

◆ beamPosY()

float xAOD::EventInfo_v1::beamPosY ( ) const

Y coordinate of the beam spot position.

◆ beamPosZ()

float xAOD::EventInfo_v1::beamPosZ ( ) const

Z coordinate of the beam spot position.

◆ beamSpotWeight()

float xAOD::EventInfo_v1::beamSpotWeight ( ) const

Weight for beam spot size reweighting.

Definition at line 970 of file EventInfo_v1.cxx.

970 {
971 // If the value is not available, then return 1.0
972 if( ! hasBeamSpotWeight() ) return 1.0f;
973 return accBeamSpotWeight( *this );
974 }
bool hasBeamSpotWeight() const
Check if weight for beam spot size reweighting exists.
setBeamTiltXZ static setBeamStatus const SG::AuxElement::Accessor< float > accBeamSpotWeight("beamSpotWeight")
Accessor for "BeamSpotWeight".

◆ beamStatus()

uint32_t xAOD::EventInfo_v1::beamStatus ( ) const

The beam spot's status word.

◆ beamTiltXZ()

float xAOD::EventInfo_v1::beamTiltXZ ( ) const

The beam's tilt in radians in XZ.

◆ beamTiltYZ()

float xAOD::EventInfo_v1::beamTiltYZ ( ) const

The beam's tilt in radians in YZ.

◆ clearSubEvents()

void xAOD::EventInfo_v1::clearSubEvents ( )

Clear all the currently held sub-events.

Definition at line 647 of file EventInfo_v1.cxx.

647 {
648
649 // Clear both the transient and persistent variables:
650 m_subEvents.store (std::vector<SubEvent>());
651 m_subEvents.reset();
652 timeAcc( *this ).clear(); indexAcc( *this ).clear();
653 typeAcc( *this ).clear(); linkAcc( *this ).clear();
654
655 return;
656 }

◆ detDescrTags()

const DetDescrTags_t & xAOD::EventInfo_v1::detDescrTags ( ) const

The detector description tags.

◆ detectorMask()

setEventNumber setTimeStamp setBCID setDetectorMask1 setDetectorMask3 uint64_t xAOD::EventInfo_v1::detectorMask ( ) const

Bit field indicating which TTC zones are present in the event.

Definition at line 143 of file EventInfo_v1.cxx.

143 {
144
145 return ( ( static_cast< uint64_t >( detectorMask1() ) << 32 ) |
146 detectorMask0() );
147 }
uint32_t detectorMask1() const
Bit field indicating which TTC zones are present in the event.
uint32_t detectorMask0() const
Bit field indicating which TTC zones are present in the event.

◆ detectorMask0()

uint32_t xAOD::EventInfo_v1::detectorMask0 ( ) const

Bit field indicating which TTC zones are present in the event.

◆ detectorMask1()

uint32_t xAOD::EventInfo_v1::detectorMask1 ( ) const

Bit field indicating which TTC zones are present in the event.

◆ detectorMask2()

uint32_t xAOD::EventInfo_v1::detectorMask2 ( ) const

Bit field indicating which TTC zones are present in the event.

◆ detectorMask3()

uint32_t xAOD::EventInfo_v1::detectorMask3 ( ) const

Bit field indicating which TTC zones are present in the event.

◆ detectorMaskExt()

uint64_t xAOD::EventInfo_v1::detectorMaskExt ( ) const

Bit field indicating which TTC zones are present in the event.

Definition at line 164 of file EventInfo_v1.cxx.

164 {
165
166 return ( ( static_cast< uint64_t >( detectorMask3() ) << 32 ) |
167 detectorMask2() );
168 }
uint32_t detectorMask3() const
Bit field indicating which TTC zones are present in the event.
uint32_t detectorMask2() const
Bit field indicating which TTC zones are present in the event.

◆ errorState()

EventInfo_v1::EventFlagErrorState xAOD::EventInfo_v1::errorState ( EventFlagSubDet subDet) const

Get the error state for a particular sub-detector.

Definition at line 817 of file EventInfo_v1.cxx.

817 {
818
819 // Get the value in one go:
820 return static_cast< EventFlagErrorState >(
821 ( ( *eventFlagsConstAccessorsV1( subDet ) )( *this ) >> EF_ERROR_SHIFT ) &
822 0xF );
823 }
EventFlagErrorState
States that a given sub-detector could be in.
static const uint32_t EF_ERROR_SHIFT
Shift used to store the sub-detector error states.
const SG::AtomicConstAccessor< uint32_t > * eventFlagsConstAccessorsV1(EventInfo_v1::EventFlagSubDet subDet)
Helper function for accessing event flag variables, for const access.

◆ eventFlags()

uint32_t xAOD::EventInfo_v1::eventFlags ( EventFlagSubDet subDet) const

Get the event flags for a particular sub-detector.

Definition at line 697 of file EventInfo_v1.cxx.

697 {
698
699 return ( ( *eventFlagsConstAccessorsV1( subDet ) )( *this ) &
700 EF_BITS );
701 }
static const uint32_t EF_BITS
Bits that store the "user defined" detector flags.

◆ eventNumber()

uint64_t xAOD::EventInfo_v1::eventNumber ( ) const

The current event's event number.

◆ eventType()

bool xAOD::EventInfo_v1::eventType ( EventType type) const

Check for one particular bitmask value.

◆ eventTypeBitmask()

uint32_t xAOD::EventInfo_v1::eventTypeBitmask ( ) const

The event type bitmask.

◆ extendedLevel1ID()

uint32_t xAOD::EventInfo_v1::extendedLevel1ID ( ) const

The extended Level-1 identifier.

◆ hasBeamSpotWeight()

bool xAOD::EventInfo_v1::hasBeamSpotWeight ( ) const

Check if weight for beam spot size reweighting exists.

Definition at line 966 of file EventInfo_v1.cxx.

966 {
967 return accBeamSpotWeight.isAvailable( *this );
968 }

◆ isEventFlagBitSet()

bool xAOD::EventInfo_v1::isEventFlagBitSet ( EventFlagSubDet subDet,
size_t bit ) const

Check one particular bit of one particular sub-detector.

Definition at line 703 of file EventInfo_v1.cxx.

704 {
705
706 // A little sanity check:
707 if( bit >= EF_ERROR_SHIFT ) {
708 throw std::runtime_error( "EventInfo_v1::isEventFlagBitSet: Asked for "
709 "non-existent bit" );
710 }
711
712 // Get the value of the flags:
713 uint32_t value = ( *eventFlagsConstAccessorsV1( subDet ) )( *this );
714
715 // Dig out the bit we are asking for:
716 return ( ( value >> bit ) & 0x1 );
717 }
setEventNumber uint32_t

◆ level1TriggerType()

uint16_t xAOD::EventInfo_v1::level1TriggerType ( ) const

The Level-1 trigger type.

◆ lumiBlock()

uint32_t xAOD::EventInfo_v1::lumiBlock ( ) const

The current event's luminosity block number.

◆ makeSubEvents()

std::vector< EventInfo_v1::SubEvent > xAOD::EventInfo_v1::makeSubEvents ( ) const
private

Definition at line 523 of file EventInfo_v1.cxx.

524 {
525 std::vector< SubEvent > subEvents;
526
527 // Check if any of the information is available:
528 if( ( ! timeAcc.isAvailable( *this ) ) &&
529 ( ! indexAcc.isAvailable( *this ) ) &&
530 ( ! linkAcc.isAvailable( *this ) ) &&
531 ( ! typeAcc.isAvailable( *this ) ) )
532 {
533 // If not, return right away:
534 return subEvents;
535 }
536 // A little sanity check:
537 size_t size = 0;
538 if( timeAcc.isAvailable( *this ) ) {
539 size = timeAcc( *this ).size();
540 } else if( indexAcc.isAvailable( *this ) ) {
541 size = indexAcc( *this ).size();
542 } else if( linkAcc.isAvailable( *this ) ) {
543 size = linkAcc( *this ).size();
544 } else if( typeAcc.isAvailable( *this ) ) {
545 size = typeAcc( *this ).size();
546 } else {
547 std::cerr << "xAOD::EventInfo_v1 ERROR Logic error in subEvents()"
548 << std::endl;
549 return subEvents;
550 }
551 if( ( timeAcc.isAvailable( *this ) &&
552 ( size != timeAcc( *this ).size() ) ) ||
553 ( indexAcc.isAvailable( *this ) &&
554 ( size != indexAcc( *this ).size() ) ) ||
555 ( linkAcc.isAvailable( *this ) &&
556 ( size != linkAcc( *this ).size() ) ) ||
557 ( typeAcc.isAvailable( *this ) &&
558 ( size != typeAcc( *this ).size() ) ) ) {
559 std::cerr << "xAOD::EventInfo_v1 ERROR Data corruption found in "
560 << "the sub-event information" << std::endl;
561 std::cerr << "subEventTime = "
562 << ( timeAcc.isAvailable( *this ) ? timeAcc( *this ) :
563 std::vector< int16_t >() ) << std::endl;
564 std::cerr << "subEventIndex = "
565 << ( indexAcc.isAvailable( *this ) ? indexAcc( *this ) :
566 std::vector< uint16_t >() ) << std::endl;
567 std::cerr << "subEventLink = "
568 << ( linkAcc.isAvailable( *this ) ? linkAcc( *this ) :
569 std::vector< ElementLink< EventInfoContainer_v1 > >() )
570 << std::endl;
571 std::cerr << "subEventType = "
572 << ( typeAcc.isAvailable( *this ) ? typeAcc( *this ) :
573 std::vector< uint16_t >() ) << std::endl;
574 return subEvents;
575 }
576 // Fill up the cache:
577 for( size_t i = 0; i < size; ++i ) {
578 const int16_t time =
579 timeAcc.isAvailable( *this ) ? timeAcc( *this )[ i ] : 0;
580 const uint16_t index =
581 indexAcc.isAvailable( *this ) ? indexAcc( *this )[ i ] : 0;
583 linkAcc.isAvailable( *this ) ? linkAcc( *this )[ i ] :
585 const PileUpType type =
586 ( typeAcc.isAvailable( *this ) ?
587 static_cast< PileUpType >( typeAcc( *this )[ i ] ) :
588 Unknown );
589 subEvents.emplace_back( time, index, type, link );
590 }
591
592 return subEvents;
593 }
size_t size() const
Number of registered mappings.
PileUpType
Enumerator describing the types of pileup events.
time(flags, cells_name, *args, **kw)
str index
Definition DeMoScan.py:362
pointer & link(pointer p) const
Return a reference to the link for an element.
setScaleOne setStatusOne setSaturated int16_t

◆ mcChannelNumber()

uint32_t xAOD::EventInfo_v1::mcChannelNumber ( ) const

The MC generator's channel number.

◆ mcEventNumber()

uint64_t xAOD::EventInfo_v1::mcEventNumber ( ) const

The MC generator's event number.

◆ mcEventWeight()

setMCChannelNumber setMCEventWeights float xAOD::EventInfo_v1::mcEventWeight ( size_t i = 0) const

The weight of one specific MC event used in the simulation.

Definition at line 203 of file EventInfo_v1.cxx.

203 {
204
205 // Throw an exception when asked for an impossible index:
206 return mcEventWeights().at( i );
207 }
const std::vector< float > & mcEventWeights() const
The weights of all the MC events used in the simulation.

◆ mcEventWeights()

const std::vector< float > & xAOD::EventInfo_v1::mcEventWeights ( ) const

The weights of all the MC events used in the simulation.

◆ operator=()

EventInfo_v1 & xAOD::EventInfo_v1::operator= ( const EventInfo_v1 & rhs)

Assignment operator.

Definition at line 96 of file EventInfo_v1.cxx.

96 {
97
98 if (&rhs != this) {
99 // Clear out the caches:
100 m_streamTags.store (std::vector< StreamTag >());
101 m_streamTags.reset();
102 m_subEvents.store (std::vector< SubEvent >());
103 m_subEvents.reset();
104
105 // Copy the event store pointer:
106 m_evtStore = rhs.m_evtStore;
107
108 // Copy the auxiliary variables:
109 SG::AuxElement::operator=( rhs );
110 }
111
112 // Return this object:
113 return *this;
114 }

◆ PileUpInt2Type()

EventInfo_v1::PileUpType xAOD::EventInfo_v1::PileUpInt2Type ( unsigned short typ)
static

Convert int to PileUpType enum value.

Definition at line 672 of file EventInfo_v1.cxx.

673 {
674 static const PileUpType typEnum[PileUp_NTYPES+1] = {
675 Unknown /*99*/, Signal /*0*/, MinimumBias /*1*/, Cavern /*2*/, HaloGas /*3*/, ZeroBias /*4*/
676 };
677 int t = (typ==99)? 0: (int)typ+1;
678 assert( t <= PileUp_NTYPES );
679 return typEnum[t];
680 }
setRawEt setRawPhi int

◆ pileUpMixtureID()

setPileUpMixtureIDHighBits EventInfo_v1::PileUpMixtureID xAOD::EventInfo_v1::pileUpMixtureID ( ) const

Unique pile-up mixture identifier.

Definition at line 421 of file EventInfo_v1.cxx.

421 {
422
423 PileUpMixtureID id{};
424
425 // We need to check if the values are actually stored
428 id.lowBits = pileUpMixtureIDLowBits();
429 id.highBits = pileUpMixtureIDHighBits();
430 }
431
432 return id;
433
434 }
uint64_t pileUpMixtureIDLowBits() const
Unique pile-up mixture identifier low bits.
uint64_t pileUpMixtureIDHighBits() const
Unique pile-up mixture identifier high bits.
XAOD_AUXDATA_DEPRECATED bool isAvailable(const std::string &name, const std::string &clsname="") const
Check if an aux variable is available for reading.
static const SG::AuxElement::Accessor< uint64_t > accHigh("pileUpMixtureIDHighBits")
static const SG::AuxElement::Accessor< uint64_t > accLow("pileUpMixtureIDLowBits")
Unique pile-up mixture identifier definition.

◆ pileUpMixtureIDHighBits()

uint64_t xAOD::EventInfo_v1::pileUpMixtureIDHighBits ( ) const

Unique pile-up mixture identifier high bits.

◆ pileUpMixtureIDLowBits()

uint64_t xAOD::EventInfo_v1::pileUpMixtureIDLowBits ( ) const

Unique pile-up mixture identifier low bits.

◆ PileUpType2Name()

const std::string & xAOD::EventInfo_v1::PileUpType2Name ( PileUpType typ)
static

Convert PileUpType enum value to string.

Definition at line 658 of file EventInfo_v1.cxx.

659 {
660 static const std::string typNam[PileUp_NTYPES+1] = {
661 "Unknown" /*99*/,
662 "Signal" /*0*/,
663 "MinimumBias" /*1*/,
664 "Cavern" /*2*/,
665 "HaloGas"/*3*/,
666 "ZeroBias"/*4*/ };
667 int t = (typ==Unknown)? 0: (int)typ+1;
668 assert( t <= PileUp_NTYPES );
669 return typNam[t];
670 }

◆ resetEventFlagBit()

bool xAOD::EventInfo_v1::resetEventFlagBit ( EventFlagSubDet subDet,
size_t bit )

Reset one particular bit of one particular sub-detector.

Definition at line 772 of file EventInfo_v1.cxx.

773 {
774 // Get the accessor:
775 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
776 if( ! acc ) {
777 return false;
778 }
779
780 // Check if the bit makes sense:
781 if( bit >= EF_ERROR_SHIFT ) {
782 return false;
783 }
784
785 // Set the new value:
786 ( *acc )( *this ) &= ~( 1u << bit );
787
788 // Tell the user that we were successful:
789 return true;
790 }
constexpr unsigned int bit(int n)
const SG::AtomicDecorator< uint32_t > * eventFlagsAccessorsV1(EventInfo_v1::EventFlagSubDet subDet)
Helper function for accessing event flag variables.
static const SG::AuxElement::Accessor< ElementLink< IParticleContainer > > acc("originalObjectLink")
Object used for setting/getting the dynamic decoration in question.

◆ runNumber()

uint32_t xAOD::EventInfo_v1::runNumber ( ) const

The current event's run number.

◆ setActualInteractionsPerCrossing()

void xAOD::EventInfo_v1::setActualInteractionsPerCrossing ( float value)

Set average interactions per crossing for the current BCID.

Definition at line 391 of file EventInfo_v1.cxx.

391 {
392
394 return;
395 }

◆ setAverageInteractionsPerCrossing()

void xAOD::EventInfo_v1::setAverageInteractionsPerCrossing ( float value)

Set average interactions per crossing for all BCIDs.

Definition at line 408 of file EventInfo_v1.cxx.

408 {
409
411 return;
412 }

◆ setBCID()

void xAOD::EventInfo_v1::setBCID ( uint32_t value)

Set the bunch crossing ID of the event.

◆ setBeamPos()

void xAOD::EventInfo_v1::setBeamPos ( float x,
float y,
float z )

Set the beam spot position.

Definition at line 916 of file EventInfo_v1.cxx.

916 {
917
918 // The accessor objects:
919 static const Accessor< float > accX( "beamPosX" );
920 static const Accessor< float > accY( "beamPosY" );
921 static const Accessor< float > accZ( "beamPosZ" );
922
923 // Set the variables:
924 accX( *this ) = x;
925 accY( *this ) = y;
926 accZ( *this ) = z;
927
928 return;
929 }
#define y
#define x
#define z

◆ setBeamPosSigma()

void xAOD::EventInfo_v1::setBeamPosSigma ( float x,
float y,
float z )

Set the size of the beam spot.

Definition at line 935 of file EventInfo_v1.cxx.

935 {
936
937 // The accessor objects:
938 static const Accessor< float > accX( "beamPosSigmaX" );
939 static const Accessor< float > accY( "beamPosSigmaY" );
940 static const Accessor< float > accZ( "beamPosSigmaZ" );
941
942 // Set the variables:
943 accX( *this ) = x;
944 accY( *this ) = y;
945 accZ( *this ) = z;
946
947 return;
948 }

◆ setBeamPosSigmaXY()

void xAOD::EventInfo_v1::setBeamPosSigmaXY ( float value)

Set the beam spot shape's X-Y correlation.

◆ setBeamSpotWeight()

void xAOD::EventInfo_v1::setBeamSpotWeight ( float value)

Set weight for beam spot size reweighting.

Definition at line 976 of file EventInfo_v1.cxx.

976 {
977 accBeamSpotWeight( *this ) = value;
978 return;
979 }

◆ setBeamStatus()

void xAOD::EventInfo_v1::setBeamStatus ( uint32_t value)

Set the beam spot's status word.

◆ setBeamTiltXZ()

void xAOD::EventInfo_v1::setBeamTiltXZ ( float value)

Set the beam's tilt in radians in XZ.

◆ setBeamTiltYZ()

void xAOD::EventInfo_v1::setBeamTiltYZ ( float value)

Set the beam's tilt in radians in YZ.

◆ setDetDescrTags()

void xAOD::EventInfo_v1::setDetDescrTags ( const DetDescrTags_t & value)

Set the detector description tags.

◆ setDetectorMask() [1/2]

void xAOD::EventInfo_v1::setDetectorMask ( uint32_t mask0,
uint32_t mask1 )

Set the bit fields indicating with TTC timezones were present.

Definition at line 149 of file EventInfo_v1.cxx.

149 {
150
151 setDetectorMask0( mask0 );
152 setDetectorMask1( mask1 );
153 return;
154 }
void setDetectorMask1(uint32_t value)
Set the bit field indicating with TTC timezones were present.
void setDetectorMask0(uint32_t value)
Set the bit field indicating with TTC timezones were present.

◆ setDetectorMask() [2/2]

void xAOD::EventInfo_v1::setDetectorMask ( uint64_t mask)

Set the bit fields indicating with TTC timezones were present.

Definition at line 156 of file EventInfo_v1.cxx.

156 {
157
158 setDetectorMask0( static_cast< uint32_t >( mask & 0xffffffff ) );
159 setDetectorMask1( static_cast< uint32_t >( ( mask >> 32 ) &
160 0xffffffff ) );
161 return;
162 }

◆ setDetectorMask0()

void xAOD::EventInfo_v1::setDetectorMask0 ( uint32_t value)

Set the bit field indicating with TTC timezones were present.

◆ setDetectorMask1()

void xAOD::EventInfo_v1::setDetectorMask1 ( uint32_t value)

Set the bit field indicating with TTC timezones were present.

◆ setDetectorMask2()

void xAOD::EventInfo_v1::setDetectorMask2 ( uint32_t value)

Set the bit field indicating with TTC timezones were present.

◆ setDetectorMask3()

void xAOD::EventInfo_v1::setDetectorMask3 ( uint32_t value)

Set the bit field indicating with TTC timezones were present.

◆ setDetectorMaskExt() [1/2]

void xAOD::EventInfo_v1::setDetectorMaskExt ( uint32_t mask2,
uint32_t mask3 )

Set the bit fields indicating with TTC timezones were present.

Definition at line 170 of file EventInfo_v1.cxx.

170 {
171
172 setDetectorMask2( mask2 );
174 return;
175 }
static const uint32_t mask3
void setDetectorMask2(uint32_t value)
Set the bit field indicating with TTC timezones were present.
void setDetectorMask3(uint32_t value)
Set the bit field indicating with TTC timezones were present.

◆ setDetectorMaskExt() [2/2]

void xAOD::EventInfo_v1::setDetectorMaskExt ( uint64_t mask)

Set the bit fields indicating with TTC timezones were present.

Definition at line 177 of file EventInfo_v1.cxx.

177 {
178
179 setDetectorMask2( static_cast< uint32_t >( mask & 0xffffffff ) );
180 setDetectorMask3( static_cast< uint32_t >( ( mask >> 32 ) &
181 0xffffffff ) );
182 return;
183 }

◆ setErrorState()

bool xAOD::EventInfo_v1::setErrorState ( EventFlagSubDet subDet,
EventFlagErrorState state )

Set the error state for a particular sub-detector.

Definition at line 825 of file EventInfo_v1.cxx.

826 {
827
828 // Get the accessor:
829 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
830 if( ! acc ) {
831 return false;
832 }
833
834 // Check its value:
835 if( ( state != NotSet ) && ( state != Warning ) && ( state != Error ) ) {
836 return false;
837 }
838
839 // Construct the new value:
840 std::atomic<uint32_t>& a = (*acc)(*this);
841 uint32_t orig = a;
842 uint32_t value = ( ( orig & EF_BITS ) |
843 ( static_cast< uint32_t >( state ) <<
844 EF_ERROR_SHIFT ) );
845 while (!a.compare_exchange_strong (orig, value)) {
846 CxxUtils::stall();
847 value = ( ( orig & EF_BITS ) |
848 ( static_cast< uint32_t >( state ) <<
849 EF_ERROR_SHIFT ) );
850 }
851
852 // Tell the user that we were successful:
853 return true;
854 }
static Double_t a

◆ setEventFlagBit()

bool xAOD::EventInfo_v1::setEventFlagBit ( EventFlagSubDet subDet,
size_t bit ) const

Set one particular bit of one particular sub-detector.

Definition at line 741 of file EventInfo_v1.cxx.

742 {
743 return updateEventFlagBit (subDet, bit);
744 }
bool updateEventFlagBit(const EventFlagSubDet subDet, const size_t bit) const
Change detector flags with update semantics.

◆ setEventFlags()

bool xAOD::EventInfo_v1::setEventFlags ( EventFlagSubDet subDet,
uint32_t flags )

Set the event flags for a particular sub-detector.

Definition at line 719 of file EventInfo_v1.cxx.

719 {
720
721 // Get the accessor:
722 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
723 if( ! acc ) {
724 return false;
725 }
726
727 // Construct the value that we want to store, taking the current error
728 // flags into account:
729 std::atomic<uint32_t>& a = (*acc)(*this);
730 uint32_t orig = a;
731 uint32_t value = ( ( orig & EF_ERROR_BITS ) | ( flags & EF_BITS ) );
732 while (!a.compare_exchange_strong (orig, value)) {
733 CxxUtils::stall();
734 value = ( ( orig & EF_ERROR_BITS ) | ( flags & EF_BITS ) );
735 }
736
737 // Tell the user that we were successful:
738 return true;
739 }
static const uint32_t EF_ERROR_BITS
Bits that store the error state of the sub-detectors.

◆ setEventNumber()

void xAOD::EventInfo_v1::setEventNumber ( uint64_t value)

Set the current event's event number.

◆ setEventTypeBitmask()

void xAOD::EventInfo_v1::setEventTypeBitmask ( uint32_t value)

Set the event type bitmask.

◆ setEvtStore()

void xAOD::EventInfo_v1::setEvtStore ( StoreGateSvc * svc)

Set the pointer to the event store associated with this event.

Definition at line 990 of file EventInfo_v1.cxx.

990 {
991
992 m_evtStore = svc;
993 return;
994 }
AthROOTErrorHandlerSvc * svc

◆ setExtendedLevel1ID()

void xAOD::EventInfo_v1::setExtendedLevel1ID ( uint32_t value)

Set the extended Level-1 identifier.

◆ setLevel1TriggerType()

void xAOD::EventInfo_v1::setLevel1TriggerType ( uint16_t value)

Set the Level-1 trigger type.

◆ setLumiBlock()

void xAOD::EventInfo_v1::setLumiBlock ( uint32_t value)

Set the current event's luminosity block number.

◆ setMCChannelNumber()

void xAOD::EventInfo_v1::setMCChannelNumber ( uint32_t value)

Set the MC generator's channel number.

◆ setMCEventNumber()

void xAOD::EventInfo_v1::setMCEventNumber ( uint64_t value)

Set the MC generator's event number.

◆ setMCEventWeights()

void xAOD::EventInfo_v1::setMCEventWeights ( const std::vector< float > & value)

Set the weights of all the MC events used in the simulation.

◆ setPileUpMixtureID()

void xAOD::EventInfo_v1::setPileUpMixtureID ( const PileUpMixtureID & value)

Set unique pile-up mixture identifier.

Definition at line 436 of file EventInfo_v1.cxx.

436 {
437
440
441 }
void setPileUpMixtureIDHighBits(uint64_t value)
Set unique pile-up mixture identifier high bits.
void setPileUpMixtureIDLowBits(uint64_t value)
Set unique pile-up mixture identifier low bits.

◆ setPileUpMixtureIDHighBits()

void xAOD::EventInfo_v1::setPileUpMixtureIDHighBits ( uint64_t value)

Set unique pile-up mixture identifier high bits.

◆ setPileUpMixtureIDLowBits()

void xAOD::EventInfo_v1::setPileUpMixtureIDLowBits ( uint64_t value)

Set unique pile-up mixture identifier low bits.

◆ setRunNumber()

void xAOD::EventInfo_v1::setRunNumber ( uint32_t value)

Set the current event's run number.

◆ setStatusElement()

void xAOD::EventInfo_v1::setStatusElement ( uint32_t value)

Set the trigger status element.

◆ setStreamTags()

void xAOD::EventInfo_v1::setStreamTags ( const std::vector< StreamTag > & value)

Set the streams that the event was put in.

Definition at line 342 of file EventInfo_v1.cxx.

342 {
343
344 // Update the cached information:
345 m_streamTags.store (value);
346
347 // Clear the persistent information:
348 names( *this ).clear(); types( *this ).clear(); olb( *this ).clear();
349 robsets( *this ).clear(); detsets( *this ).clear();
350
351 // Fill the persistent information:
352 std::vector< StreamTag >::const_iterator itr = value.begin();
353 std::vector< StreamTag >::const_iterator end = value.end();
354 for( ; itr != end; ++itr ) {
355 names( *this ).push_back( itr->name() );
356 types( *this ).push_back( itr->type() );
357 olb( *this ).push_back( itr->obeysLumiblock() );
358 robsets( *this ).push_back( itr->robs() );
359 detsets( *this ).push_back( itr->dets() );
360 }
361
362 return;
363 }
static const std::vector< std::string > types
static const EventInfo_v1::Accessor< std::vector< std::set< uint32_t > > > detsets("streamTagDets")
static const EventInfo_v1::Accessor< std::vector< std::set< uint32_t > > > robsets("streamTagRobs")
static const EventInfo_v1::Accessor< std::vector< char > > olb("streamTagObeysLumiblock")
static const EventInfo_v1::Accessor< std::vector< std::string > > names("streamTagNames")

◆ setSubEvents()

void xAOD::EventInfo_v1::setSubEvents ( const std::vector< SubEvent > & value)

Set the pileup events that were used in the simulation.

Definition at line 607 of file EventInfo_v1.cxx.

607 {
608
609 // Update the cached information:
610 m_subEvents.store (value);
611
612 // Clear the persistent information:
613 timeAcc( *this ).clear(); indexAcc( *this ).clear();
614 typeAcc( *this ).clear(); linkAcc( *this ).clear();
615
616 // Fill the persistent information:
617 std::vector< SubEvent >::const_iterator itr = value.begin();
618 std::vector< SubEvent >::const_iterator end = value.end();
619 for( ; itr != end; ++itr ) {
620 timeAcc( *this ).push_back( itr->time() );
621 indexAcc( *this ).push_back( itr->index() );
622 typeAcc( *this ).push_back( static_cast< uint16_t >( itr->type() ) );
623 linkAcc( *this ).push_back( itr->link() );
624 }
625
626 return;
627 }

◆ setTimeStamp()

void xAOD::EventInfo_v1::setTimeStamp ( uint32_t value)

Set the POSIX time of the event.

◆ setTimeStampNSOffset()

void xAOD::EventInfo_v1::setTimeStampNSOffset ( uint32_t value)

Set the nanosecond offset wrt. the time stamp.

◆ statusElement()

uint32_t xAOD::EventInfo_v1::statusElement ( ) const

Trigger status element.

◆ streamTags()

const std::vector< EventInfo_v1::StreamTag > & xAOD::EventInfo_v1::streamTags ( ) const

Get the streams that the event was put in.

Definition at line 283 of file EventInfo_v1.cxx.

283 {
284
285 // Cache the new information if necessary:
286 if( !m_streamTags.isValid() ) {
287 std::vector< StreamTag > tags;
288
289 // A little sanity check:
290 if( ( names( *this ).size() != types( *this ).size() ) ||
291 ( names( *this ).size() != olb( *this ).size() ) ||
292 ( robsets.isAvailable( *this ) &&
293 ( names( *this ).size() != robsets( *this ).size() ) ) ||
294 ( detsets.isAvailable( *this ) &&
295 ( names( *this ).size() != detsets( *this ).size() ) ) ) {
296 std::cerr << "<xAOD::EventInfo_v1::streamTags> ERROR "
297 << "Corrupt information found!" << std::endl;
298 std::cerr << " streamTagNames = " << names( *this )
299 << std::endl;
300 std::cerr << " streamTagTypes = " << types( *this )
301 << std::endl;
302 std::cerr << " streamTagObeysLumiblock = " << olb( *this )
303 << std::endl;
304 std::cerr << " streamTagRobs = ";
305 if( robsets.isAvailable( *this ) ) {
306 std::cerr << "N/A" << std::endl;
307 } else {
308 std::cerr << robsets( *this ) << std::endl;
309 }
310 std::cerr << " streamTagDets = ";
311 if( detsets.isAvailable( *this ) ) {
312 std::cerr << "N/A" << std::endl;
313 } else {
314 std::cerr << detsets( *this ) << std::endl;
315 }
316 }
317
318 else {
319 // Fill the tags.
320 for( size_t i = 0; i < names( *this ).size(); ++i ) {
321 static const std::set< uint32_t > dummySet;
322 tags.emplace_back( names( *this )[ i ],
323 types( *this )[ i ],
324 olb( *this )[ i ],
325 ( robsets.isAvailable( *this ) ?
326 robsets( *this )[ i ] :
327 dummySet ),
328 ( detsets.isAvailable( *this ) ?
329 detsets( *this )[ i ] :
330 dummySet ) );
331 }
332 }
333
334 // Set the cache.
335 m_streamTags.set (std::move (tags));
336 }
337
338 // Return the cached object:
339 return *m_streamTags.ptr();
340 }
std::vector< std::string > tags
Definition hcg.cxx:107

◆ subEvents()

const std::vector< EventInfo_v1::SubEvent > & xAOD::EventInfo_v1::subEvents ( ) const

Get the pileup events that were used in the simulation.

Definition at line 596 of file EventInfo_v1.cxx.

596 {
597
598 // Cache the new information if necessary:
599 if( !m_subEvents.isValid() ) {
601 }
602
603 // Return the cached vector:
604 return *m_subEvents.ptr();
605 }
std::vector< EventInfo_v1::SubEvent > makeSubEvents() const

◆ timeStamp()

uint32_t xAOD::EventInfo_v1::timeStamp ( ) const

POSIX time in seconds from 1970. January 1st.

◆ timeStampNSOffset()

uint32_t xAOD::EventInfo_v1::timeStampNSOffset ( ) const

Nanosecond time offset wrt. the time stamp.

◆ toPersistent()

void xAOD::EventInfo_v1::toPersistent ( )

Prepare the object for writing.

Definition at line 996 of file EventInfo_v1.cxx.

996 {
997
998 // Check if the ElementLink variable is available, and writable:
999 if( linkAcc.isAvailableWritable( *this ) ) {
1000 // Prepare the ElementLink objects for ROOT I/O:
1001 std::vector< ElementLink< EventInfoContainer_v1 > >::iterator
1002 el_itr = linkAcc( *this ).begin();
1003 std::vector< ElementLink< EventInfoContainer_v1 > >::iterator
1004 el_end = linkAcc( *this ).end();
1005 for( ; el_itr != el_end; ++el_itr ) {
1006 el_itr->toPersistent();
1007 }
1008 }
1009
1010 return;
1011 }
JetConstituentVector::iterator iterator

◆ toTransient()

void xAOD::EventInfo_v1::toTransient ( )

Cleanse the object after being read in.

As it is now fairly complicated to prepare an EventInfo object for usage after it's been read in from a branch, it seemed to make sense to put the code that's used to do this, into a separate function.

It tries to do the right thing in all situations...

Definition at line 1018 of file EventInfo_v1.cxx.

1018 {
1019
1020 m_streamTags.reset();
1021 m_subEvents.reset();
1022#ifdef XAOD_STANDALONE
1023 m_evtStore = nullptr;
1024#else
1025 m_evtStore = dynamic_cast<StoreGateSvc*> (SG::CurrentEventStore::store());
1026#endif
1027
1028 if( usingStandaloneStore() ) {
1029 setStore( ( SG::IAuxStore* ) nullptr );
1030 }
1031
1032 return;
1033 }
bool usingStandaloneStore() const
Test to see if this object is currently using a standalone store.
void setStore(const SG::IConstAuxStore *store)
Set the store associated with this object.

◆ updateErrorState()

bool xAOD::EventInfo_v1::updateErrorState ( const EventFlagSubDet subDet,
const EventFlagErrorState state ) const

Update the error state for one particular sub-detector.

The error state may only be increased by this method. If STATE is less than the current error state, then this method will return false and leave the current state unchanged.

Definition at line 856 of file EventInfo_v1.cxx.

858 {
859 // Check its value:
860 if( ( state != NotSet ) && ( state != Warning ) && ( state != Error ) ) {
861 return false;
862 }
863
864 // Return without trying to write if the desired state is
865 // already set.
866 if (errorState (subDet) == state) {
867 return true;
868 }
869
870 // Get the accessor:
871 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
872 if( ! acc ) {
873 return false;
874 }
875
876 // Construct the new value:
877 std::atomic<uint32_t>& a = (*acc)(*this);
878 uint32_t orig = a;
879
880 // Only allow increasing the error state in an update.
881 if (state < ((orig >> EF_ERROR_SHIFT) & 0xf)) {
882 return false;
883 }
884
885 uint32_t value = ( ( orig & EF_BITS ) |
886 ( static_cast< uint32_t >( state ) <<
887 EF_ERROR_SHIFT ) );
888 while (!a.compare_exchange_strong (orig, value)) {
889 if (state < ((orig >> EF_ERROR_SHIFT) & 0xf)) {
890 return false;
891 }
892
893 value = ( ( orig & EF_BITS ) |
894 ( static_cast< uint32_t >( state ) <<
895 EF_ERROR_SHIFT ) );
896
897 CxxUtils::stall();
898 }
899
900 // Tell the user that we were successful:
901 return true;
902 }
EventFlagErrorState errorState(EventFlagSubDet subDet) const
Get the error state for a particular sub-detector.

◆ updateEventFlagBit()

bool xAOD::EventInfo_v1::updateEventFlagBit ( const EventFlagSubDet subDet,
const size_t bit ) const

Change detector flags with update semantics.

This means that we can set bits but not reset them, and that the error state can move higher (NotSet -> Warning -> Error) but not the other way. These methods are const, so they can be called on an existing EventInfo, but will fail with an exception if the detector flag word has been locked. This will happen on input if the flag word has already been set to something; it could also happen if the flag word is written explicitly with a DecorationHandle.

Be aware that no dependency tracking is done for these flags, so something that is reading them should ensure that whatever writes them runs first. In most cases, setting event flags goes along with producing some data item; in those cases, it should suffice for the reader to have a dependency on this data item. In other cases, one might need to use explicit DecorationHandle's or produce a dummy data item. Set one particular bit of one particular sub-detector

Definition at line 746 of file EventInfo_v1.cxx.

747 {
748 // Check if the bit makes sense:
749 if( bit >= EF_ERROR_SHIFT ) {
750 return false;
751 }
752
753 // Don't try to write if the requested flag is already set.
754 uint32_t existingFlags = (*eventFlagsConstAccessorsV1( subDet ))( *this );
755 if (existingFlags & (1u << bit)) {
756 return true;
757 }
758
759 // Get the accessor:
760 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
761 if( ! acc ) {
762 return false;
763 }
764
765 // Set the new value:
766 ( *acc )( *this ) |= ( 1u << bit );
767
768 // Tell the user that we were successful:
769 return true;
770 }

◆ updateEventFlags()

bool xAOD::EventInfo_v1::updateEventFlags ( const EventFlagSubDet subDet,
const uint32_t flags_in ) const

Turn on a set of event flags for one particular sub-detector.

This does a logical OR of the exising flags and FLAGS.

Definition at line 792 of file EventInfo_v1.cxx.

794 {
795 uint32_t flags = flags_in & EF_BITS;
796
797 // Don't try to write if all requested flags are already set.
798 uint32_t existingFlags = (*eventFlagsConstAccessorsV1( subDet ))( *this );
799 if ((existingFlags | flags) == existingFlags) {
800 return true;
801 }
802
803 // Get the accessor:
804 const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
805 if( ! acc ) {
806 return false;
807 }
808
809 // Set the new value:
810 ( *acc )( *this ) |= ( flags & EF_BITS );
811
812 // Tell the user that we were successful:
813 return true;
814 }

Member Data Documentation

◆ m_evtStore

StoreGateSvc* xAOD::EventInfo_v1::m_evtStore
private

Transient pointer to the StoreGateSvc instance associated with the event (Needed for pile-up digitisation).

Definition at line 518 of file EventInfo_v1.h.

◆ m_streamTags

CxxUtils::CachedValue<std::vector< StreamTag > > xAOD::EventInfo_v1::m_streamTags
private

Cached stream tag objects.

Definition at line 511 of file EventInfo_v1.h.

◆ m_subEvents

CxxUtils::CachedValue<std::vector< SubEvent> > xAOD::EventInfo_v1::m_subEvents
private

Cached sub-event objects.

Definition at line 513 of file EventInfo_v1.h.


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