MergedEventInfo Class Reference

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

#include <MergedEventInfo.h>

Inheritance diagram for MergedEventInfo:

Collaboration diagram for MergedEventInfo:

Public Member Functions
structors
	MergedEventInfo ()
	POOL required. More...
	MergedEventInfo (const EventInfo &origEvent, EventID::number_type newRunNo, EventID::number_type newEvtNo, EventID::number_type newTimeStamp=0)
	the constructor to be used More...
virtual	~MergedEventInfo ()
	MergedEventInfo (const MergedEventInfo &)=default
	MergedEventInfo (MergedEventInfo &&)=default
MergedEventInfo &	operator= (const MergedEventInfo &)=default
MergedEventInfo &	operator= (MergedEventInfo &&)=default

Private Types
template<class T >
using	owner = T

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)

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

Event information accessors
EventID	m_newEventID
const EventID *	event_ID () const
	the new identification of the event. More...
const EventID *	origEvent_ID () const
	the original identification of the event. More...

Detailed Description

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

Definition at line 34 of file MergedEventInfo.h.

Member Typedef Documentation

owner

template<class T >

using EventInfo::owner = T

privateinherited

Definition at line 54 of file EventInfo/EventInfo/EventInfo.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

MergedEventInfo() [1/4]

MergedEventInfo::MergedEventInfo

(

)

POOL required.

Definition at line 14 of file MergedEventInfo.cxx.

                                 :
  EventInfo(), m_newEventID() {}

MergedEventInfo() [2/4]

MergedEventInfo::MergedEventInfo	(	const EventInfo &	origEvent,
		EventID::number_type	newRunNo,
		EventID::number_type	newEvtNo,
		EventID::number_type	newTimeStamp = 0
	)

the constructor to be used

Definition at line 17 of file MergedEventInfo.cxx.

                                                                  :
  EventInfo(origEvent), m_newEventID(newRunNo, newEvtNo, newTimeStamp) {}

~MergedEventInfo()

MergedEventInfo::~MergedEventInfo ( )

virtual

Definition at line 23 of file MergedEventInfo.cxx.

{}

MergedEventInfo() [3/4]

MergedEventInfo::MergedEventInfo ( const MergedEventInfo &  )

default

MergedEventInfo() [4/4]

MergedEventInfo::MergedEventInfo ( MergedEventInfo &&  )

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

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

classID()

const CLID & MergedEventInfo::classID ( )

inlinestatic

Definition at line 93 of file MergedEventInfo.h.

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

clID()

const CLID & MergedEventInfo::clID ( ) const

inline

Definition at line 85 of file MergedEventInfo.h.

                            {
  return classID();
}

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 * MergedEventInfo::event_ID ( ) const

inline

the new identification of the event.

Definition at line 75 of file MergedEventInfo.h.

                                {
  return &m_newEventID;
}

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]

MergedEventInfo& MergedEventInfo::operator= ( const MergedEventInfo &  )

default

operator=() [2/2]

MergedEventInfo& MergedEventInfo::operator= ( MergedEventInfo &&  )

default

origEvent_ID()

const EventID * MergedEventInfo::origEvent_ID ( ) const

inline

the original identification of the event.

Definition at line 80 of file MergedEventInfo.h.

                                    {
  return EventInfo::event_ID();
}

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_newEventID

EventID MergedEventInfo::m_newEventID

private

Definition at line 69 of file MergedEventInfo.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:

• MergedEventInfo.h
• MergedEventInfo.cxx