EventInfo Class Reference

This class provides general information about an event. Event information is provided by the accessors: EventID* event_ID() const; EventType* event_type() const; TriggerInfo* trigger_info() const;. More...

#include <EventInfo.h>

Inheritance diagram for EventInfo:

Collaboration diagram for EventInfo:

Public Member Functions
structors
	EventInfo ()
	EventInfo (EventID *id, EventType *type)
	EventInfo (EventID *id, EventType *type, TriggerInfo *trig_info)
	EventInfo (const EventInfo &e)
EventInfo &	operator= (const EventInfo &e)
	EventInfo (EventInfo &&e)
EventInfo &	operator= (EventInfo &&e)
virtual	~EventInfo ()

Friends
class	EventInfoByteStreamCnv
class	xAODMaker::EventInfoCnvTool
class	G4AtlasAlg
class	LooperKiller
class	CopyMcEventCollection

DataObject-like clid accessors
const CLID &	clID () const
static const CLID &	classID ()

Event information setting
enum	{   EF_BITS = 0x0FFFFFFF, EF_ERROR_BITS = 0xF0000000, EF_ERROR_SHIFT = 28, ACTUAL_INTERACTS_BITS = 0x0000FFFF,   AVE_INTERACTS_BITS = 0xFFFF0000, AVE_INTERACTS_SHIFT = 16 }
class	MixingEventSelector
class	TagInfoMgr
class	EventInfoCnv_p1
class	EventInfoCnv_p2
class	EventInfoCnv_p3
class	EventInfoCnv_p4
EventID *	m_event_ID
EventType *	m_event_type
TriggerInfo *	m_trigger_info
std::vector< unsigned int >	m_event_flags
void	setTriggerInfo (TriggerInfo *)
	Add TriggerInfo to existing object. More...
void	setActualInteractionsPerCrossing (float interactions)
	Setting the number of interactions per crossing: More...
void	setAverageInteractionsPerCrossing (float interactions)
	average interactions per crossing for all BCIDs - for out-of-time pile-up More...
void	setEventID (EventID *pid)
void	setEventType (EventType *)

Detailed Description

This class provides general information about an event. Event information is provided by the accessors: EventID* event_ID() const; EventType* event_type() const; TriggerInfo* trigger_info() const;.

Definition at line 42 of file EventInfo/EventInfo/EventInfo.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
EF_BITS
EF_ERROR_BITS
EF_ERROR_SHIFT
ACTUAL_INTERACTS_BITS
AVE_INTERACTS_BITS
AVE_INTERACTS_SHIFT

Definition at line 193 of file EventInfo/EventInfo/EventInfo.h.

       {
    EF_BITS                = 0x0FFFFFFF,
    EF_ERROR_BITS          = 0xF0000000,
    EF_ERROR_SHIFT         = 28,
    ACTUAL_INTERACTS_BITS  = 0x0000FFFF,
    AVE_INTERACTS_BITS     = 0xFFFF0000,
    AVE_INTERACTS_SHIFT    = 16
  };

BackgroundEventFlag

enum EventInfo::BackgroundEventFlag

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 69 of file EventInfo/EventInfo/EventInfo.h.

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

EventFlagErrorState

enum EventInfo::EventFlagErrorState

Enumerator
NotSet
Warning
Error

Definition at line 59 of file EventInfo/EventInfo/EventInfo.h.

                           {
    NotSet, Warning, Error
  };

EventFlagSubDet

enum EventInfo::EventFlagSubDet

Enumerator
Pixel
SCT
TRT
LAr
Tile
Muon
ForwardDet
Core
Background
Lumi
nDets

Definition at line 53 of file EventInfo/EventInfo/EventInfo.h.

                       {
    Pixel, SCT, TRT, LAr, Tile, Muon, ForwardDet, Core, Background, Lumi, nDets
  };

Constructor & Destructor Documentation

EventInfo() [1/5]

EventInfo::EventInfo

(

)

Definition at line 20 of file EventInfo.cxx.

  :
  m_event_ID(new EventID(0, 0)),
  m_event_type(new EventType()),
  m_trigger_info(new TriggerInfo()),
  m_event_flags(std::vector<unsigned int>(nDets, 0))
{}

EventInfo() [2/5]

EventInfo::EventInfo	(	EventID *	id,
		EventType *	type
	)

Definition at line 28 of file EventInfo.cxx.

  :
  m_event_ID(id),
  m_event_type(type),
  m_trigger_info(new TriggerInfo()),
  m_event_flags(std::vector<unsigned int>(nDets, 0))
{}

EventInfo() [3/5]

EventInfo::EventInfo	(	EventID *	id,
		EventType *	type,
		TriggerInfo *	trig_info
	)

Definition at line 36 of file EventInfo.cxx.

  :
  m_event_ID(id),
  m_event_type(type),
  m_trigger_info(trig_info),
  m_event_flags(std::vector<unsigned int>(nDets, 0))
{}

EventInfo() [4/5]

EventInfo::EventInfo

(

const EventInfo &

e

)

Definition at line 44 of file EventInfo.cxx.

  :
  m_event_ID(e.m_event_ID ?
             new EventID(*(e.m_event_ID)) :
             new EventID(0, 0)),
  m_event_type(e.m_event_type ?
               new EventType(*(e.m_event_type)) :
               new EventType()),
  m_trigger_info(e.m_trigger_info ?
                 new TriggerInfo(*(e.m_trigger_info)) :
                 new TriggerInfo()),
  m_event_flags(e.m_event_flags)
{}

EventInfo() [5/5]

EventInfo::EventInfo

(

EventInfo &&

e

)

Definition at line 81 of file EventInfo.cxx.

  : m_event_ID(e.m_event_ID),
  m_event_type(e.m_event_type),
  m_trigger_info(e.m_trigger_info),
  m_event_flags(std::move(e.m_event_flags)) {
  e.m_event_ID = 0;
  e.m_event_type = 0;
  e.m_trigger_info = 0;
}

~EventInfo()

EventInfo::~EventInfo ( )

virtual

Definition at line 111 of file EventInfo.cxx.

                      {
  delete m_event_ID;
  delete m_event_type;
  delete m_trigger_info;
}

Member Function Documentation

actualInteractionsPerCrossing()

float EventInfo::actualInteractionsPerCrossing ( ) const

inline

Access to number of interactions per crossing:

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

average interactions per crossing for the current (or actual) BCID - for in-time pile-up

Definition at line 269 of file EventInfo/EventInfo/EventInfo.h.

                                               {
  float result = -999.99f;
 
  if (Lumi < m_event_flags.size()) {
    unsigned int interactions = m_event_flags[Lumi];
    result = (float) (interactions & ACTUAL_INTERACTS_BITS);
    result *= 0.01;
  }
  return result;
}

averageInteractionsPerCrossing()

float EventInfo::averageInteractionsPerCrossing ( ) const

inline

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

Definition at line 282 of file EventInfo/EventInfo/EventInfo.h.

                                                {
  float result = -999.99f;
 
  if (Lumi < m_event_flags.size()) {
    unsigned int interactions = m_event_flags[Lumi];
    result = (float) ((interactions & AVE_INTERACTS_BITS) >> AVE_INTERACTS_SHIFT);
    result *= 0.01;
  }
  return result;
}

classID()

const CLID & EventInfo::classID ( )

inlinestatic

Definition at line 302 of file EventInfo/EventInfo/EventInfo.h.

                   {
  return ClassID_traits<EventInfo>::ID();
}

clID()

const CLID & EventInfo::clID ( ) const

inline

Definition at line 294 of file EventInfo/EventInfo/EventInfo.h.

                      {
  return classID();
}

errorState()

EventInfo::EventFlagErrorState EventInfo::errorState ( EventFlagSubDet  subDet ) const

inline

return error state for a particular sub-detector

test for error state for a particular sub-detector

Definition at line 260 of file EventInfo/EventInfo/EventInfo.h.

                                                  {
  if ((unsigned) subDet < m_event_flags.size()) {
    return(EventFlagErrorState((EF_ERROR_BITS & m_event_flags[subDet]) >> EF_ERROR_SHIFT));
  }
  return NotSet;
}

event_ID() [1/2]

EventID * EventInfo::event_ID ( )

inline

the unique identification of the event.

Definition at line 210 of file EventInfo/EventInfo/EventInfo.h.

                    {
  return(m_event_ID);
}

event_ID() [2/2]

const EventID * EventInfo::event_ID ( ) const

inline

Definition at line 215 of file EventInfo/EventInfo/EventInfo.h.

                          {
  return(m_event_ID);
}

event_type() [1/2]

EventType * EventInfo::event_type ( )

inline

the type of the event, e.g. simulation, testbeam, etc

Definition at line 220 of file EventInfo/EventInfo/EventInfo.h.

                      {
  return(m_event_type);
}

event_type() [2/2]

const EventType * EventInfo::event_type ( ) const

inline

Definition at line 225 of file EventInfo/EventInfo/EventInfo.h.

                            {
  return(m_event_type);
}

eventFlags() [1/2]

const std::vector< unsigned int > & EventInfo::eventFlags ( ) const

inline

All event flags.

Definition at line 254 of file EventInfo/EventInfo/EventInfo.h.

                            {
  return m_event_flags;
}

eventFlags() [2/2]

unsigned int EventInfo::eventFlags ( EventFlagSubDet  subDet ) const

inline

event flags for a particular sub-detector

Definition at line 240 of file EventInfo/EventInfo/EventInfo.h.

                                                  {
  if ((unsigned) subDet < m_event_flags.size()) return(EF_BITS & m_event_flags[subDet]);
 
  return(0xFFFFFFFF);
}

isEventFlagBitSet()

bool EventInfo::isEventFlagBitSet ( EventFlagSubDet  subDet, unsigned char  bit  ) const

inline

check for a event flag bit for a particular sub-detector

Definition at line 247 of file EventInfo/EventInfo/EventInfo.h.

                                                                            {
  if (subDet < m_event_flags.size() && bit < EF_ERROR_SHIFT) return((1u << bit) & m_event_flags[subDet]);
 
  return(false);
}

operator=() [1/2]

EventInfo & EventInfo::operator=

(

const EventInfo &

e

)

Definition at line 59 of file EventInfo.cxx.

                                                    {
  if (this != &e) {
    delete m_event_ID;
    m_event_ID = (e.m_event_ID ?
                  new EventID(*(e.m_event_ID)) :
                  new EventID(0, 0));
 
    delete m_event_type;
    m_event_type = (e.m_event_type ?
                    new EventType(*(e.m_event_type)) :
                    new EventType());
 
    delete m_trigger_info;
    m_trigger_info = (e.m_trigger_info ?
                      new TriggerInfo(*(e.m_trigger_info)) :
                      new TriggerInfo());
 
    m_event_flags = e.m_event_flags;
  }
  return *this;
}

operator=() [2/2]

EventInfo & EventInfo::operator=

(

EventInfo &&

e

)

Definition at line 91 of file EventInfo.cxx.

                                               {
  if (this != &e) {
    delete m_event_ID;
    m_event_ID = e.m_event_ID;
    e.m_event_ID = 0;
 
    delete m_event_type;
    m_event_type = e.m_event_type;
    e.m_event_type = 0;
 
    delete m_trigger_info;
    m_trigger_info = e.m_trigger_info;
    e.m_trigger_info = 0;
 
    m_event_flags = std::move(e.m_event_flags);
  }
  return *this;
}

setActualInteractionsPerCrossing()

void EventInfo::setActualInteractionsPerCrossing

(

float

interactions

)

Setting the number of interactions per crossing:

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

Definition at line 185 of file EventInfo.cxx.

                                                              {
  // pack interaction into 16 bits saving the precision to the 0.01
  // level
  unsigned int ivalue = (unsigned int) (interactions * 100.f);
 
  if (ivalue > ACTUAL_INTERACTS_BITS) {
    std::cout <<
    "EventInfo::setActualInteractionsPerCrossing ***  ERROR ***: trying to store too large of value: interactions/ivalue/max value: "
              << interactions << " " << ivalue << " " << ACTUAL_INTERACTS_BITS << std::endl;
  }
  ivalue &= ACTUAL_INTERACTS_BITS;
  // If event_flags has been cleared on input, reset size AND INCLUDE lumi
  if (m_event_flags.size() < nDets) m_event_flags.resize(nDets, 0);
  m_event_flags[Lumi] |= ivalue; // store lower 16 bits
}

setAverageInteractionsPerCrossing()

void EventInfo::setAverageInteractionsPerCrossing

(

float

interactions

)

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

Definition at line 202 of file EventInfo.cxx.

                                                               {
  // pack interaction into 16 bits saving the precision to the 0.01
  // level
  unsigned int ivalue = (unsigned int) (interactions * 100.f);
 
  if (ivalue > ACTUAL_INTERACTS_BITS) {
    std::cout <<
    "EventInfo::setAverageInteractionsPerCrossing ***  ERROR ***: trying to store too large of value: interactions/ivalue/max value: "
              << interactions << " " << ivalue << " " << ACTUAL_INTERACTS_BITS << std::endl;
  }
  ivalue = (ivalue << AVE_INTERACTS_SHIFT) & AVE_INTERACTS_BITS;
  // If event_flags has been cleared on input, reset size AND INCLUDE lumi
  if (m_event_flags.size() < nDets) m_event_flags.resize(nDets, 0);
  m_event_flags[Lumi] |= ivalue; // store upper 16 bits
}

setErrorState()

bool EventInfo::setErrorState	(	EventFlagSubDet	subDet,
		EventFlagErrorState	errorState
	)

Set error state flag for a particular sub detector.

Returns true is successfully inserted (i.e. valid subDet).

Definition at line 168 of file EventInfo.cxx.

                                                                               {
  // If event_flags has been cleared on input, reset size to just
  // before lumi
  if (m_event_flags.size() < (unsigned int) Lumi) m_event_flags.resize(Lumi, 0);
  // check that subdet index is in range and that we have a valid error state
  if ((unsigned) subDet < m_event_flags.size() &&
      (errorState == NotSet || errorState == Warning || errorState == Error)) {
    // Combine potentially-existing flags with new error states
    m_event_flags[subDet] =
      (unsigned int) ((EF_BITS & m_event_flags[subDet]) | ((unsigned int) errorState << EF_ERROR_SHIFT));
    return(true);
  }
  return(false);
}

setEventFlagBit()

bool EventInfo::setEventFlagBit	(	EventFlagSubDet	subDet,
		unsigned char	bit,
		bool	set = true
	)

Set a bit for an event flag of a particular sub detector.

bit range is 0 - 27. Returns true is successfully inserted (i.e. valid subDet and bit value). Use 'set = false' to unset the bit, default it true.

Definition at line 149 of file EventInfo.cxx.

                                                                              {
  // If event_flags has been cleared on input, reset size to just
  // before lumi
  if (m_event_flags.size() < (unsigned int) Lumi) m_event_flags.resize(Lumi, 0);
  if ((unsigned) subDet < m_event_flags.size() && bit < EF_ERROR_SHIFT) {
    if (set) {
      m_event_flags[subDet] = (EF_ERROR_BITS & m_event_flags[subDet]) |
                              ((1u << bit) | m_event_flags[subDet]);
    } else {
      unsigned int mask = EF_BITS ^ (1u << bit);
      m_event_flags[subDet] = (EF_ERROR_BITS & m_event_flags[subDet]) |
                              (mask & m_event_flags[subDet]);
    }
    return(true);
  }
  return(false);
}

setEventFlags()

bool EventInfo::setEventFlags	(	EventFlagSubDet	subDet,
		unsigned int	flags
	)

Set event flag for a particular sub detector - maximun size is 28 bits.

The bits beyond this will be ignored. Returns true is successfully inserted (i.e. valid subDet).

Definition at line 136 of file EventInfo.cxx.

                                                                   {
  // If event_flags has been cleared on input, reset size to just
  // before lumi
  if (m_event_flags.size() < (unsigned int) Lumi) m_event_flags.resize(Lumi, 0);
  if ((unsigned) subDet < m_event_flags.size()) {
    // Combine potentially-existing error states with new flags
    m_event_flags[subDet] = (EF_ERROR_BITS & m_event_flags[subDet]) | (EF_BITS & flags);
    return(true);
  }
  return(false);
}

setEventID()

void EventInfo::setEventID ( EventID *  pid )

protected

Definition at line 118 of file EventInfo.cxx.

                                  {
  delete m_event_ID;
  m_event_ID = pid;
}

setEventType()

void EventInfo::setEventType ( EventType *  pType )

protected

Definition at line 124 of file EventInfo.cxx.

                                        {
  delete m_event_type;
  m_event_type = pType;
}

setTriggerInfo()

void EventInfo::setTriggerInfo

(

TriggerInfo *

pTrig

)

Add TriggerInfo to existing object.

Definition at line 130 of file EventInfo.cxx.

                                            {
  delete m_trigger_info;
  m_trigger_info = pTrig;
}

trigger_info() [1/2]

TriggerInfo * EventInfo::trigger_info ( )

inline

trigger information (ptr may be NULL)

Definition at line 230 of file EventInfo/EventInfo/EventInfo.h.

                        {
  return(m_trigger_info);
}

trigger_info() [2/2]

const TriggerInfo * EventInfo::trigger_info ( ) const

inline

Definition at line 235 of file EventInfo/EventInfo/EventInfo.h.

                              {
  return(m_trigger_info);
}

Friends And Related Function Documentation

CopyMcEventCollection

friend class CopyMcEventCollection

friend

Definition at line 48 of file EventInfo/EventInfo/EventInfo.h.

EventInfoByteStreamCnv

friend class EventInfoByteStreamCnv

friend

Definition at line 44 of file EventInfo/EventInfo/EventInfo.h.

EventInfoCnv_p1

friend class EventInfoCnv_p1

friend

Definition at line 188 of file EventInfo/EventInfo/EventInfo.h.

EventInfoCnv_p2

friend class EventInfoCnv_p2

friend

Definition at line 189 of file EventInfo/EventInfo/EventInfo.h.

EventInfoCnv_p3

friend class EventInfoCnv_p3

friend

Definition at line 190 of file EventInfo/EventInfo/EventInfo.h.

EventInfoCnv_p4

friend class EventInfoCnv_p4

friend

Definition at line 191 of file EventInfo/EventInfo/EventInfo.h.

G4AtlasAlg

friend class G4AtlasAlg

friend

Definition at line 46 of file EventInfo/EventInfo/EventInfo.h.

LooperKiller

friend class LooperKiller

friend

Definition at line 47 of file EventInfo/EventInfo/EventInfo.h.

MixingEventSelector

friend class MixingEventSelector

friend

Definition at line 182 of file EventInfo/EventInfo/EventInfo.h.

TagInfoMgr

friend class TagInfoMgr

friend

Definition at line 185 of file EventInfo/EventInfo/EventInfo.h.

xAODMaker::EventInfoCnvTool

friend class xAODMaker::EventInfoCnvTool

friend

Definition at line 45 of file EventInfo/EventInfo/EventInfo.h.

Member Data Documentation

m_event_flags

std::vector<unsigned int> EventInfo::m_event_flags

private

Definition at line 204 of file EventInfo/EventInfo/EventInfo.h.

m_event_ID

EventID* EventInfo::m_event_ID

private

Definition at line 201 of file EventInfo/EventInfo/EventInfo.h.

m_event_type

EventType* EventInfo::m_event_type

private

Definition at line 202 of file EventInfo/EventInfo/EventInfo.h.

m_trigger_info

TriggerInfo* EventInfo::m_trigger_info

private

Definition at line 203 of file EventInfo/EventInfo/EventInfo.h.

---

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

• EventInfo/EventInfo/EventInfo.h
• EventInfo.cxx