This class provides information about an overlaid event. It extends EventInfo with a list of sub-evts (the original and the bkg ones) More...

#include <PileUpEventInfo.h>

Inheritance diagram for PileUpEventInfo:

Collaboration diagram for PileUpEventInfo:

Classes
class	SubEvent
	a triple allowing access to a sub-event More...

Public Types
enum for event flags which indicate the subsystem
detector to which the flags belong
enum	EventFlagSubDet { Pixel, SCT, TRT, LAr, Tile, Muon, ForwardDet, Core, Background, Lumi, nDets }

enum for event errors states
enum	EventFlagErrorState { NotSet, Warning, Error }

enum for bits in Background EventFlag word
enum	BackgroundEventFlag { 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 }

enum for event flags which indicate the subsystem
detector to which the flags belong
enum	EventFlagSubDet { Pixel, SCT, TRT, LAr, Tile, Muon, ForwardDet, Core, Background, Lumi, nDets }

enum for event errors states
enum	EventFlagErrorState { NotSet, Warning, Error }

enum for bits in Background EventFlag word
enum	BackgroundEventFlag { 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 }

enum for event flags which indicate the subsystem
detector to which the flags belong
enum	EventFlagSubDet { Pixel, SCT, TRT, LAr, Tile, Muon, ForwardDet, Core, Background, Lumi, nDets }

enum for event errors states
enum	EventFlagErrorState { NotSet, Warning, Error }

enum for bits in Background EventFlag word
enum	BackgroundEventFlag { 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 }

Public Member Functions
Event information accessors
EventID *	event_ID ()
	the unique identification of the event. More...

const EventID *	event_ID () const

EventType *	event_type ()
	the type of the event, e.g. simulation, testbeam, etc More...

const EventType *	event_type () const

TriggerInfo *	trigger_info ()
	trigger information (ptr may be NULL) More...

const TriggerInfo *	trigger_info () const

unsigned int	eventFlags (EventFlagSubDet subDet) const
	event flags for a particular sub-detector More...

bool	isEventFlagBitSet (EventFlagSubDet subDet, unsigned char bit) const
	check for a event flag bit for a particular sub-detector More...

const std::vector< unsigned int > &	eventFlags () const
	All event flags. More...

EventFlagErrorState	errorState (EventFlagSubDet subDet) const
	return error state for a particular sub-detector More...

bool	setEventFlags (EventFlagSubDet subDet, unsigned int flags)
	Set event flag for a particular sub detector - maximun size is 28 bits. More...

bool	setEventFlagBit (EventFlagSubDet subDet, unsigned char bit, bool set=true)
	Set a bit for an event flag of a particular sub detector. More...

bool	setErrorState (EventFlagSubDet subDet, EventFlagErrorState errorState)
	Set error state flag for a particular sub detector. More...

float	actualInteractionsPerCrossing () const
	Access to number of interactions per crossing: More...

float	averageInteractionsPerCrossing () const
	average interactions per crossing for all BCIDs - for out-of-time pile-up More...

Event information accessors
EventID *	event_ID ()
	the unique identification of the event. More...

EventType *	event_type ()
	the type of the event, e.g. simulation, testbeam, etc More...

const EventType *	event_type () const

TriggerInfo *	trigger_info ()
	trigger information (ptr may be NULL) More...

const TriggerInfo *	trigger_info () const

unsigned int	eventFlags (EventFlagSubDet subDet) const
	event flags for a particular sub-detector More...

const std::vector< unsigned int > &	eventFlags () const
	All event flags. More...

bool	isEventFlagBitSet (EventFlagSubDet subDet, unsigned char bit) const
	check for a event flag bit for a particular sub-detector More...

EventFlagErrorState	errorState (EventFlagSubDet subDet) const
	return error state for a particular sub-detector More...

bool	setEventFlags (EventFlagSubDet subDet, unsigned int flags)
	Set event flag for a particular sub detector - maximun size is 28 bits. More...

bool	setEventFlagBit (EventFlagSubDet subDet, unsigned char bit, bool set=true)
	Set a bit for an event flag of a particular sub detector. More...

bool	setErrorState (EventFlagSubDet subDet, EventFlagErrorState errorState)
	Set error state flag for a particular sub detector. More...

float	actualInteractionsPerCrossing () const
	Access to number of interactions per crossing: More...

float	averageInteractionsPerCrossing () const
	average interactions per crossing for all BCIDs - for out-of-time pile-up More...

Event information accessors
EventID *	event_ID ()
	the unique identification of the event. More...

const EventID *	event_ID () const

EventType *	event_type ()
	the type of the event, e.g. simulation, testbeam, etc More...

const EventType *	event_type () const

TriggerInfo *	trigger_info ()
	trigger information (ptr may be NULL) More...

const TriggerInfo *	trigger_info () const

unsigned int	eventFlags (EventFlagSubDet subDet) const
	event flags for a particular sub-detector More...

const std::vector< unsigned int > &	eventFlags () const
	All event flags. More...

bool	isEventFlagBitSet (EventFlagSubDet subDet, unsigned char bit) const
	check for a event flag bit for a particular sub-detector More...

EventFlagErrorState	errorState (EventFlagSubDet subDet) const
	return error state for a particular sub-detector More...

bool	setEventFlags (EventFlagSubDet subDet, unsigned int flags)
	Set event flag for a particular sub detector - maximun size is 28 bits. More...

bool	setEventFlagBit (EventFlagSubDet subDet, unsigned char bit, bool set=true)
	Set a bit for an event flag of a particular sub detector. More...

bool	setErrorState (EventFlagSubDet subDet, EventFlagErrorState errorState)
	Set error state flag for a particular sub detector. More...

float	actualInteractionsPerCrossing () const
	Access to number of interactions per crossing: More...

float	averageInteractionsPerCrossing () const
	average interactions per crossing for all BCIDs - for out-of-time pile-up More...

Private Types
template<class T >
using	owner = T

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

static const CLID &	classID ()

Event information setting
std::unique_ptr< EventID >	m_event_ID

std::unique_ptr< EventType >	m_event_type

std::unique_ptr< TriggerInfo >	m_trigger_info

std::vector< unsigned int >	m_event_flags {std::vector<unsigned int>(nDets, 0)}

void	setTriggerInfo (owner< TriggerInfo * > pTrig)
	Add TriggerInfo to existing object. More...

void	setTriggerInfo (std::unique_ptr< TriggerInfo > pTrig)

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

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

void	setEventID (owner< EventID * > pid)

void	setEventID (std::unique_ptr< EventID > pid)

void	setEventType (owner< EventType * >)

void	setEventType (std::unique_ptr< EventType > pType)

structors (same as EventInfo)
typedef SubEvent::time_type	time_type

typedef SubEvent::index_type	index_type

	PileUpEventInfo ()

	PileUpEventInfo (EventID id, EventType type)

	PileUpEventInfo (EventID id, EventType type, TriggerInfo *trig_info)

virtual	~PileUpEventInfo ()

	PileUpEventInfo (const PileUpEventInfo &)=default

	PileUpEventInfo (PileUpEventInfo &&)=default

PileUpEventInfo &	operator= (const PileUpEventInfo &)=default

PileUpEventInfo &	operator= (PileUpEventInfo &&)=default

void	addSubEvt (time_type t, PileUpTimeEventIndex::PileUpType puType, const EventInfo pse, StoreGateSvc psg)
	setter for the subEvt collection t=0(ns) for the original event More...

void	addSubEvt (time_type t, PileUpTimeEventIndex::PileUpType puType, std::unique_ptr< EventInfo > pse, StoreGateSvc *psg)

void	addSubEvt (time_type t, unsigned int BCID, PileUpTimeEventIndex::PileUpType puType, const EventInfo &rse, StoreGateSvc *psg)
	setter for the subEvt collection t=0(ns) for the original event More...

void	addSubEvt (time_type t, unsigned int BCID, PileUpTimeEventIndex::PileUpType puType, std::unique_ptr< EventInfo > &pse, StoreGateSvc *psg)

accessors to the subEvt collection
std::list< SubEvent >	m_subEvents

SubEvent::iterator	beginSubEvt ()

SubEvent::iterator	endSubEvt ()

SubEvent::const_iterator	beginSubEvt () const

SubEvent::const_iterator	endSubEvt () const

Detailed Description

This class provides information about an overlaid event. It extends EventInfo with a list of sub-evts (the original and the bkg ones)

Definition at line 37 of file PileUpEventInfo.h.

Member Typedef Documentation

◆ index_type

typedef SubEvent::index_type PileUpEventInfo::index_type

Definition at line 107 of file PileUpEventInfo.h.

◆ owner

template<class T >

using EventInfo::owner = T

privateinherited

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

◆ time_type

typedef SubEvent::time_type PileUpEventInfo::time_type

Definition at line 106 of file PileUpEventInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

privateinherited

Enumerator
EF_BITS
EF_ERROR_BITS
EF_ERROR_SHIFT
ACTUAL_INTERACTS_BITS
AVE_INTERACTS_BITS
AVE_INTERACTS_SHIFT

Definition at line 207 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

inherited

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 76 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

inherited

Enumerator
NotSet
Warning
Error

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

                            {
     NotSet, Warning, Error
   };

◆ EventFlagSubDet

enum EventInfo::EventFlagSubDet

inherited

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

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

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

Constructor & Destructor Documentation

◆ PileUpEventInfo() [1/5]

PileUpEventInfo::PileUpEventInfo ( )

Definition at line 18 of file PileUpEventInfo.cxx.

                                  :
   EventInfo()
 {}

◆ PileUpEventInfo() [2/5]

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

Definition at line 22 of file PileUpEventInfo.cxx.

                                                              :
   EventInfo(id, type)
 {}

◆ PileUpEventInfo() [3/5]

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

Definition at line 26 of file PileUpEventInfo.cxx.

                                                          :
   EventInfo(id, type, trig_info)
 {}

◆ ~PileUpEventInfo()

PileUpEventInfo::~PileUpEventInfo ( )

virtual

Definition at line 31 of file PileUpEventInfo.cxx.

32 {}

◆ PileUpEventInfo() [4/5]

PileUpEventInfo::PileUpEventInfo ( const PileUpEventInfo & )

default

◆ PileUpEventInfo() [5/5]

PileUpEventInfo::PileUpEventInfo ( PileUpEventInfo && )

default

Member Function Documentation

◆ actualInteractionsPerCrossing()

float EventInfo::actualInteractionsPerCrossing ( ) const

inlineinherited

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

◆ addSubEvt() [1/4]

void PileUpEventInfo::addSubEvt	(	time_type	t,
		PileUpTimeEventIndex::PileUpType	puType,
		const EventInfo *	pse,
		StoreGateSvc *	psg
	)

inline

setter for the subEvt collection t=0(ns) for the original event

Definition at line 109 of file PileUpEventInfo.h.

                                                           {
     m_subEvents.emplace_back(t, m_subEvents.size(), puType, pse, psg);
   }

◆ addSubEvt() [2/4]

void PileUpEventInfo::addSubEvt	(	time_type	t,
		PileUpTimeEventIndex::PileUpType	puType,
		std::unique_ptr< EventInfo >	pse,
		StoreGateSvc *	psg
	)

inline

Definition at line 114 of file PileUpEventInfo.h.

                                                                   {
     m_subEvents.emplace_back(t, m_subEvents.size(), puType, std::move(pse), psg);
   }

◆ addSubEvt() [3/4]

void PileUpEventInfo::addSubEvt	(	time_type	t,
		unsigned int	BCID,
		PileUpTimeEventIndex::PileUpType	puType,
		const EventInfo &	rse,
		StoreGateSvc *	psg
	)

inline

setter for the subEvt collection t=0(ns) for the original event

Definition at line 120 of file PileUpEventInfo.h.

                                                           {
     m_subEvents.emplace_back(t, BCID, m_subEvents.size(), puType, rse, psg);
   }

◆ addSubEvt() [4/4]

void PileUpEventInfo::addSubEvt	(	time_type	t,
		unsigned int	BCID,
		PileUpTimeEventIndex::PileUpType	puType,
		std::unique_ptr< EventInfo > &	pse,
		StoreGateSvc *	psg
	)

inline

Definition at line 126 of file PileUpEventInfo.h.

                                                                    {
     m_subEvents.emplace_back(t, BCID, m_subEvents.size(), puType, std::move(pse), psg);
   }

◆ averageInteractionsPerCrossing()

float EventInfo::averageInteractionsPerCrossing ( ) const

inlineinherited

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

Definition at line 296 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;
 }

◆ beginSubEvt() [1/2]

SubEvent::iterator PileUpEventInfo::beginSubEvt ( )

inline

Definition at line 136 of file PileUpEventInfo.h.

136 {return m_subEvents.begin();}

◆ beginSubEvt() [2/2]

SubEvent::const_iterator PileUpEventInfo::beginSubEvt ( ) const

inline

Definition at line 138 of file PileUpEventInfo.h.

138 {return m_subEvents.begin();}

◆ classID()

const CLID & EventInfo::classID ( )

inlinestaticinherited

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

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

◆ clID()

const CLID & EventInfo::clID ( ) const

inlineinherited

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

                       {
   return classID();
 }

◆ endSubEvt() [1/2]

SubEvent::iterator PileUpEventInfo::endSubEvt ( )

inline

Definition at line 137 of file PileUpEventInfo.h.

137 {return m_subEvents.end();}

◆ endSubEvt() [2/2]

SubEvent::const_iterator PileUpEventInfo::endSubEvt ( ) const

inline

Definition at line 139 of file PileUpEventInfo.h.

139 {return m_subEvents.end();}

◆ errorState()

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

inlineinherited

return error state for a particular sub-detector

test for error state for a particular sub-detector

Definition at line 274 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 ( )

inlineinherited

the unique identification of the event.

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

                     {
   return m_event_ID.get();
 }

◆ event_ID() [2/2]

const EventID * EventInfo::event_ID ( ) const

inlineinherited

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

                           {
   return m_event_ID.get();
 }

◆ event_type() [1/2]

EventType * EventInfo::event_type ( )

inlineinherited

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

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

                       {
   return m_event_type.get();
 }

◆ event_type() [2/2]

const EventType * EventInfo::event_type ( ) const

inlineinherited

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

                             {
   return m_event_type.get();
 }

◆ eventFlags() [1/2]

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

inlineinherited

All event flags.

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

                             {
   return m_event_flags;
 }

◆ eventFlags() [2/2]

unsigned int EventInfo::eventFlags ( EventFlagSubDet subDet ) const

inlineinherited

event flags for a particular sub-detector

Definition at line 254 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

inlineinherited

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

Definition at line 261 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]

PileUpEventInfo& PileUpEventInfo::operator= ( const PileUpEventInfo & )

default

◆ operator=() [2/2]

PileUpEventInfo& PileUpEventInfo::operator= ( PileUpEventInfo && )

default

◆ setActualInteractionsPerCrossing()

void EventInfo::setActualInteractionsPerCrossing ( float interactions )

inherited

Setting the number of interactions per crossing:

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

Definition at line 156 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 )

inherited

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

Definition at line 173 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
	)

inherited

Set error state flag for a particular sub detector.

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

Definition at line 139 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`
	)

inherited

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 120 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
	)

inherited

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

void EventInfo::setEventID ( owner< EventID * > pid )

protectedinherited

Definition at line 82 of file EventInfo.cxx.

                                               {
   m_event_ID.reset(pid);
 }

◆ setEventID() [2/2]

void EventInfo::setEventID ( std::unique_ptr< EventID > pid )

protectedinherited

Definition at line 86 of file EventInfo.cxx.

                                                      {
   m_event_ID = std::move(pid);
 }

◆ setEventType() [1/2]

void EventInfo::setEventType ( owner< EventType * > pType )

protectedinherited

Definition at line 90 of file EventInfo.cxx.

                                                     {
   m_event_type.reset(pType);
 }

◆ setEventType() [2/2]

void EventInfo::setEventType ( std::unique_ptr< EventType > pType )

protectedinherited

Definition at line 94 of file EventInfo.cxx.

                                                            {
   m_event_type = std::move(pType);
 }

◆ setTriggerInfo() [1/2]

void EventInfo::setTriggerInfo ( owner< TriggerInfo * > pTrig )

inherited

Add TriggerInfo to existing object.

Definition at line 98 of file EventInfo.cxx.

                                                         {
   m_trigger_info.reset(pTrig);
 }

◆ setTriggerInfo() [2/2]

void EventInfo::setTriggerInfo ( std::unique_ptr< TriggerInfo > pTrig )

inherited

Definition at line 102 of file EventInfo.cxx.

                                                                {
   m_trigger_info = std::move(pTrig);
 }

◆ trigger_info() [1/2]

TriggerInfo * EventInfo::trigger_info ( )

inlineinherited

trigger information (ptr may be NULL)

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

                         {
   return m_trigger_info.get();
 }

◆ trigger_info() [2/2]

const TriggerInfo * EventInfo::trigger_info ( ) const

inlineinherited

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

                               {
   return m_trigger_info.get();
 }

Member Data Documentation

◆ m_event_flags

std::vector<unsigned int> EventInfo::m_event_flags {std::vector<unsigned int>(nDets, 0)}

privateinherited

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

◆ m_event_ID

std::unique_ptr<EventID> EventInfo::m_event_ID

privateinherited

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

◆ m_event_type

std::unique_ptr<EventType> EventInfo::m_event_type

privateinherited

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

◆ m_subEvents

std::list<SubEvent> PileUpEventInfo::m_subEvents

private

Definition at line 142 of file PileUpEventInfo.h.

◆ m_trigger_info

std::unique_ptr<TriggerInfo> EventInfo::m_trigger_info

privateinherited

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

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

Classes

Public Types

Public Member Functions

Private Types

DataObject-like clid accessors

Event information setting

structors (same as EventInfo)

accessors to the subEvt collection

Detailed Description

Member Typedef Documentation

◆ index_type

◆ owner

◆ time_type

Member Enumeration Documentation

◆ anonymous enum

◆ BackgroundEventFlag

◆ EventFlagErrorState

◆ EventFlagSubDet

Constructor & Destructor Documentation

◆ PileUpEventInfo() [1/5]

◆ PileUpEventInfo() [2/5]

◆ PileUpEventInfo() [3/5]

◆ ~PileUpEventInfo()

◆ PileUpEventInfo() [4/5]

◆ PileUpEventInfo() [5/5]

Member Function Documentation

◆ actualInteractionsPerCrossing()

◆ addSubEvt() [1/4]

◆ addSubEvt() [2/4]

◆ addSubEvt() [3/4]

◆ addSubEvt() [4/4]

◆ averageInteractionsPerCrossing()

◆ beginSubEvt() [1/2]

◆ beginSubEvt() [2/2]

◆ classID()

◆ clID()

◆ endSubEvt() [1/2]

◆ endSubEvt() [2/2]

◆ errorState()

◆ event_ID() [1/2]

◆ event_ID() [2/2]

◆ event_type() [1/2]

◆ event_type() [2/2]

◆ eventFlags() [1/2]

◆ eventFlags() [2/2]

◆ isEventFlagBitSet()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setActualInteractionsPerCrossing()

◆ setAverageInteractionsPerCrossing()

◆ setErrorState()

◆ setEventFlagBit()

◆ setEventFlags()

◆ setEventID() [1/2]

◆ setEventID() [2/2]

◆ setEventType() [1/2]

◆ setEventType() [2/2]

◆ setTriggerInfo() [1/2]

◆ setTriggerInfo() [2/2]

◆ trigger_info() [1/2]

◆ trigger_info() [2/2]

Member Data Documentation

◆ m_event_flags

◆ m_event_ID

◆ m_event_type

◆ m_subEvents

◆ m_trigger_info