#include <EventInfoPixelModuleStatusMonitoring.h>

Inheritance diagram for DerivationFramework::EventInfoPixelModuleStatusMonitoring:

Collaboration diagram for DerivationFramework::EventInfoPixelModuleStatusMonitoring:

Public Member Functions
	EventInfoPixelModuleStatusMonitoring (const std::string &type, const std::string &name, const IInterface *parent)

StatusCode	initialize ()

StatusCode	finalize ()

virtual StatusCode	addBranches (const EventContext &ctx) const

Protected Member Functions
SG::ReadHandle< InDet::SiDetectorElementStatus >	getPixelDetElStatus (const SG::ReadHandleKey< InDet::SiDetectorElementStatus > &key, const EventContext &ctx) const

Protected Attributes
SG::ReadHandleKey< InDet::SiDetectorElementStatus >	m_pixelDetElStatusActiveOnly {this, "PixelDetElStatusActiveOnly", "", "Key of SiDetectorElementStatus for Pixel which reflects only whether modules or chips are active rather than delivering good data"}

Private Attributes
Gaudi::Property< std::string >	m_prefix { this,"DecorationPrefix", "", "" }

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey { this, "ContainerName", "EventInfo", ""}

SG::ReadCondHandleKey< PixelDCSTempData >	m_readKeyTemp {this, "ReadKeyeTemp", "PixelDCSTempCondData", "Key of input sensor temperature conditions folder"}

SG::ReadCondHandleKey< PixelDCSHVData >	m_readKeyHV {this, "ReadKeyHV", "PixelDCSHVCondData", "Key of input bias voltage conditions folder"}

SG::ReadCondHandleKey< PixelDCSStateData >	m_condDCSStateKey {this, "PixelDCSStateCondData", "PixelDCSStateCondData", "Pixel FSM state key"}

SG::ReadCondHandleKey< PixelDCSStatusData >	m_condDCSStatusKey {this, "PixelDCSStatusCondData", "PixelDCSStatusCondData", "Pixel FSM status key"}

SG::ReadCondHandleKey< PixelDeadMapCondData >	m_condDeadMapKey {this, "PixelDeadMapCondData", "PixelDeadMapCondData", "Pixel deadmap conditions key"}

ToolHandle< IInDetConditionsTool >	m_pixelSummary {this, "PixelConditionsSummaryTool", "PixelConditionsSummaryTool", "Tool for PixelConditionsSummaryTool"}

SG::ReadHandleKey< IDCInDetBSErrContainer >	m_idcErrContKey {this, "PixelByteStreamErrs", "PixelByteStreamErrs", "PixelByteStreamErrs container key"}

Gaudi::Property< bool >	m_useByteStreamFEI4 {this, "UseByteStreamFEI4", true, "Switch of the ByteStream error for FEI4"}

Gaudi::Property< bool >	m_useByteStreamFEI3 {this, "UseByteStreamFEI3", true, "Switch of the ByteStream error for FEI3"}

Gaudi::Property< bool >	m_useByteStreamRD53 {this, "UseByteStreamRD53", false, "Switch of the ByteStream error for RD53"}

const PixelID *	m_pixelID

std::atomic_uint	m_lbCounter {0}

unsigned int	m_readoutTechnologyMask {}

std::vector< SG::WriteDecorHandleKey< xAOD::EventInfo > >	m_moduleConditionKeys

std::vector< SG::WriteDecorHandleKey< xAOD::EventInfo > >	m_moduleFEmaskKeys

std::vector< SG::WriteDecorHandleKey< xAOD::EventInfo > >	m_moduleBSErrKeys

Detailed Description

Definition at line 38 of file EventInfoPixelModuleStatusMonitoring.h.

Constructor & Destructor Documentation

◆ EventInfoPixelModuleStatusMonitoring()

DerivationFramework::EventInfoPixelModuleStatusMonitoring::EventInfoPixelModuleStatusMonitoring	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 13 of file EventInfoPixelModuleStatusMonitoring.cxx.

                                                                                                                                                   :
     base_class(type,name,parent),
     m_pixelID(nullptr) {
   }

Member Function Documentation

◆ addBranches()

StatusCode DerivationFramework::EventInfoPixelModuleStatusMonitoring::addBranches ( const EventContext & ctx ) const

virtual

Definition at line 70 of file EventInfoPixelModuleStatusMonitoring.cxx.

                                                                                             {
  
     ATH_MSG_DEBUG("Adding Pixel module status in EventInfo");
  
     SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfoKey,ctx);
     ATH_CHECK(eventInfo.isValid() ? StatusCode::SUCCESS : StatusCode::FAILURE);
  
     const xAOD::EventInfo *eventInfoLB = nullptr;
     ATH_CHECK(evtStore()->retrieve(eventInfoLB, "EventInfo"));
     int LB = eventInfoLB->lumiBlock();
     int chkLB = m_lbCounter;
     if (chkLB==0) { chkLB=-1; }
  
     bool isMC = false;
     if (eventInfo->eventType(xAOD::EventInfo::IS_SIMULATION)) { isMC=true; }
  
     SG::ReadCondHandle<PixelDCSHVData> dcsHV(m_readKeyHV,ctx);
     SG::ReadCondHandle<PixelDCSTempData> dcsTemp(m_readKeyTemp,ctx);
     SG::ReadCondHandle<PixelDCSStateData> dcsState(m_condDCSStateKey,ctx);
     SG::ReadCondHandle<PixelDCSStatusData> dcsStatus(m_condDCSStatusKey, ctx);
     SG::ReadCondHandle<PixelDeadMapCondData> deadMap(m_condDeadMapKey,ctx);
  
     int maxHash = m_pixelID->wafer_hash_max();
     std::vector<float> biasVoltage;
     std::vector<float> temperature;
     std::vector<int> activeState;
     std::vector<int> activeStatus;
     std::vector<int> feMaskIndex;
     std::vector<int> feMaskStatus;
     bool storeLB = false;
     if (!isMC) {
       if (chkLB!=LB) {
         storeLB = true;
         m_lbCounter = LB;
       }
     }
     else {
       if (chkLB==-1) {
         storeLB = true;
         m_lbCounter = 1;
       }
     }
  
     if (storeLB) {
       for (int ihash=0; ihash<maxHash; ihash++) {
         biasVoltage.push_back(dcsHV->getBiasVoltage(ihash));
         temperature.push_back(dcsTemp->getTemperature(ihash));
         activeState.push_back(dcsState->getModuleStatus(ihash));
         activeStatus.push_back(dcsStatus->getModuleStatus(ihash));
  
         int moduleStatus = deadMap->getModuleStatus(ihash);
         int chipStatus   = deadMap->getChipStatus(ihash);
         if (moduleStatus || chipStatus) {
           feMaskIndex.push_back(ihash);
           if (moduleStatus) {
             feMaskStatus.push_back(0);
           }
           else {
             feMaskStatus.push_back(chipStatus);
           }
         }
       }
     }
  
     //====================================================================================
     // This is an example how to read the Error informaiton.
     //
     // The Error word is defined in
     //    InDetConditions/PixelConditionsData/PixelConditionsData/PixelByteStreamErrors.h
     //
     // The IDCInDetBSErrContainer can be accessed through
     //    m_pixelCondSummaryTool->getBSErrorWord(i,ctx)
     // where
     //    i= [    0,  2047] : module error
     //        ( [0, 11] - DBMC, [12, 155] - ECC, [156, 435] - IBL,
     //         [436, 721] - B0, [722, 1215] - B1, [1216, 1891] - B2,
     //         [1892, 2035] - ECA, [2036, 2047] - DBMA )
     //
     //  for PIXEL(FEI3):
     //     = [ 2048,  4095] :   FE-0 error
     //     = [ 4096,  6143] :   FE-1 error
     //     = [ 6144,  8191] :   FE-2 error
     //          ...    ...      ...
     //          ...    ...      ...
     //     = [30720, 32767] :  FE-14 error
     //     = [32768, 34815] :  FE-15 error
     //
     //  for IBL(FEI4):
     //     = [ 2048,  4095] :   FE-0 error
     //     = [ 4096,  6143] :   FE-1 error
     //     = [34816, 35375] :  Error counter in bit#=0 from ServiceRecords (shift: modHash*nFE+iFE)
     //     = [35376, 35935] :  Error counter in bit#=1 from ServiceRecords
     //          ...    ...      ...
     //          ...    ...      ...
     //     = [52176, 52735] :  Error counter in bit#=31 from ServiceRecords
     //
     //====================================================================================
     std::vector<uint64_t> bsErrIndex;
     std::vector<uint64_t> bsErrWord;
     if (!isMC) {
       SG::ReadHandle<InDet::SiDetectorElementStatus> pixel_active = getPixelDetElStatus(m_pixelDetElStatusActiveOnly, ctx);
       SG::ReadHandle<IDCInDetBSErrContainer> idcErrCont;
       if (m_readoutTechnologyMask) {
         idcErrCont = SG::ReadHandle<IDCInDetBSErrContainer>(m_idcErrContKey,ctx);
         if (!idcErrCont.isValid()) {
           ATH_MSG_FATAL("Faled to get BS error container" << m_idcErrContKey.key());
         }
       }
  
       if (maxHash==2048) { // only valid for RUN2/3
         // First, access BS error for each FE chip
         for (int ihash=0; ihash<maxHash; ihash++) {
           for (int chFE=0; chFE<16; chFE++) {
             int indexFE = (1+chFE)*maxHash+ihash;    // (FE_channel+1)*2048 + moduleHash
             uint64_t word = (!m_pixelDetElStatusActiveOnly.empty() && m_readoutTechnologyMask
                 ? InDet::getBSErrorWord(*pixel_active,*idcErrCont,ihash,indexFE,m_readoutTechnologyMask) 
                 : m_pixelSummary->getBSErrorWord(ihash,indexFE,ctx));
             VALIDATE_STATUS_ARRAY(!m_pixelDetElStatusActiveOnly.empty() && m_readoutTechnologyMask, 
                 InDet::getBSErrorWord(*pixel_active,*idcErrCont,ihash,indexFE,m_readoutTechnologyMask),
                 m_pixelSummary->getBSErrorWord(ihash,indexFE,ctx));
  
             if (word>0) {
               bsErrIndex.push_back(indexFE);
               bsErrWord.push_back(word);
             }
           }
         }
         // Next, access IBL service record
         int indexOffset = 17*maxHash;
         for (int ihash=156; ihash<436; ihash++) {
           for (int chFE=0; chFE<2; chFE++) {
             for (int serviceCode=0; serviceCode<32; serviceCode++) {
               int indexSvcCounter = indexOffset+serviceCode*280*2+2*(ihash-156)+chFE;
               uint64_t word = (!m_pixelDetElStatusActiveOnly.empty() && m_readoutTechnologyMask
                   ? InDet::getBSErrorWord(*pixel_active,*idcErrCont,ihash,indexSvcCounter,m_readoutTechnologyMask) 
                   : m_pixelSummary->getBSErrorWord(ihash,indexSvcCounter,ctx));
               VALIDATE_STATUS_ARRAY(!m_pixelDetElStatusActiveOnly.empty() && m_readoutTechnologyMask, 
                   InDet::getBSErrorWord(*pixel_active,*idcErrCont,ihash,indexSvcCounter,m_readoutTechnologyMask),
                   m_pixelSummary->getBSErrorWord(ihash,indexSvcCounter,ctx));
  
               if (word>0) {
                 bsErrIndex.push_back(indexSvcCounter);
                 bsErrWord.push_back(word);
               }
             }
           }
         }
       }
     }
     std::vector<SG::WriteDecorHandle<xAOD::EventInfo,std::vector<float>>> decorModuleCondition(createDecorators<xAOD::EventInfo,std::vector<float>>(m_moduleConditionKeys,ctx));
     assert(decorModuleCondition.size()==2);
     decorModuleCondition[0](*eventInfo) = std::move(biasVoltage);
     decorModuleCondition[1](*eventInfo) = std::move(temperature);
  
     std::vector<SG::WriteDecorHandle<xAOD::EventInfo,std::vector<int>>> decorModuleFEmask(createDecorators<xAOD::EventInfo,std::vector<int>>(m_moduleFEmaskKeys,ctx));
     assert(decorModuleFEmask.size()==2);
     decorModuleFEmask[0](*eventInfo) = std::move(feMaskIndex);
     decorModuleFEmask[1](*eventInfo) = std::move(feMaskStatus);
     decorModuleFEmask[2](*eventInfo) = std::move(activeState);
     decorModuleFEmask[3](*eventInfo) = std::move(activeStatus);
  
     std::vector<SG::WriteDecorHandle<xAOD::EventInfo,std::vector<uint64_t>>> decorModuleBSErr(createDecorators<xAOD::EventInfo,std::vector<uint64_t>>(m_moduleBSErrKeys,ctx));
     assert(decorModuleBSErr.size()==2);
     decorModuleBSErr[0](*eventInfo) = std::move(bsErrIndex);
     decorModuleBSErr[1](*eventInfo) = std::move(bsErrWord);
  
     return StatusCode::SUCCESS;
   }  

◆ finalize()

StatusCode DerivationFramework::EventInfoPixelModuleStatusMonitoring::finalize ( )

Definition at line 66 of file EventInfoPixelModuleStatusMonitoring.cxx.

                                                             {
     return StatusCode::SUCCESS;
   }

◆ getPixelDetElStatus()

SG::ReadHandle<InDet::SiDetectorElementStatus> DerivationFramework::EventInfoPixelModuleStatusMonitoring::getPixelDetElStatus	(	const SG::ReadHandleKey< InDet::SiDetectorElementStatus > &	key,
		const EventContext &	ctx
	)		const

inlineprotected

Definition at line 95 of file EventInfoPixelModuleStatusMonitoring.h.

                                                                                                                                                               {
         SG::ReadHandle<InDet::SiDetectorElementStatus> pixelDetElStatus;
         if (!key.empty()) {
           pixelDetElStatus = SG::ReadHandle<InDet::SiDetectorElementStatus>(key, ctx);
           if (!pixelDetElStatus.isValid()) {
             std::stringstream msg;
             msg << "Failed to get " << key.key() << " from StoreGate in " << name();
             throw std::runtime_error(msg.str());
           }
         }
         return pixelDetElStatus;
       };

◆ initialize()

StatusCode DerivationFramework::EventInfoPixelModuleStatusMonitoring::initialize ( )

Definition at line 18 of file EventInfoPixelModuleStatusMonitoring.cxx.

                                                               {
  
     if (m_prefix.empty()) {
       ATH_MSG_WARNING("No decoration prefix name provided for the output of EventInfoPixelModuleStatusMonitoring!");
     }
  
     ATH_CHECK(m_eventInfoKey.initialize());
     ATH_CHECK(detStore()->retrieve(m_pixelID,"PixelID"));
  
     ATH_CHECK(m_readKeyTemp.initialize());
     ATH_CHECK(m_readKeyHV.initialize());
     ATH_CHECK(m_condDCSStateKey.initialize());
     ATH_CHECK(m_condDCSStatusKey.initialize());
     ATH_CHECK(m_condDeadMapKey.initialize());
     ATH_CHECK(m_pixelSummary.retrieve());
  
     m_readoutTechnologyMask =   Pixel::makeReadoutTechnologyBit( InDetDD::PixelReadoutTechnology::FEI4, m_useByteStreamFEI4)
                               | Pixel::makeReadoutTechnologyBit( InDetDD::PixelReadoutTechnology::FEI3, m_useByteStreamFEI3)
                               | Pixel::makeReadoutTechnologyBit( InDetDD::PixelReadoutTechnology::RD53, m_useByteStreamRD53);
     ATH_CHECK(m_idcErrContKey.initialize(m_readoutTechnologyMask));
  
  
     {
       std::vector<std::string> moduleConditionList;
       moduleConditionList.emplace_back("PixelBiasVoltagePerLB");
       moduleConditionList.emplace_back("PixelTemperaturePerLB");
       createDecoratorKeys(*this,m_eventInfoKey,m_prefix.value(),moduleConditionList,m_moduleConditionKeys);
     }
  
     {
       std::vector<std::string> moduleFEmaskList;
       moduleFEmaskList.emplace_back("PixelFEmaskIndex");
       moduleFEmaskList.emplace_back("PixelFEmaskPerLB");
       moduleFEmaskList.emplace_back("PixelDCSStatePerLB");
       moduleFEmaskList.emplace_back("PixelDCSStatusPerLB");
       createDecoratorKeys(*this,m_eventInfoKey,m_prefix.value(),moduleFEmaskList,m_moduleFEmaskKeys);
     }
  
     {
       std::vector<std::string> moduleBSErrList;
       moduleBSErrList.emplace_back("PixelBSErrIndex");
       moduleBSErrList.emplace_back("PixelBSErrWord");
       createDecoratorKeys(*this,m_eventInfoKey,m_prefix.value(),moduleBSErrList,m_moduleBSErrKeys);
     }
  
     return StatusCode::SUCCESS;
   }

Member Data Documentation

◆ m_condDCSStateKey

SG::ReadCondHandleKey<PixelDCSStateData> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_condDCSStateKey {this, "PixelDCSStateCondData", "PixelDCSStateCondData", "Pixel FSM state key"}

private

Definition at line 60 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_condDCSStatusKey

SG::ReadCondHandleKey<PixelDCSStatusData> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_condDCSStatusKey {this, "PixelDCSStatusCondData", "PixelDCSStatusCondData", "Pixel FSM status key"}

private

Definition at line 63 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_condDeadMapKey

SG::ReadCondHandleKey<PixelDeadMapCondData> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_condDeadMapKey {this, "PixelDeadMapCondData", "PixelDeadMapCondData", "Pixel deadmap conditions key"}

private

Definition at line 66 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_eventInfoKey { this, "ContainerName", "EventInfo", ""}

private

Definition at line 51 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_idcErrContKey

SG::ReadHandleKey<IDCInDetBSErrContainer> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_idcErrContKey {this, "PixelByteStreamErrs", "PixelByteStreamErrs", "PixelByteStreamErrs container key"}

private

Definition at line 72 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_lbCounter

std::atomic_uint DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_lbCounter {0}

mutableprivate

Definition at line 83 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_moduleBSErrKeys

std::vector<SG::WriteDecorHandleKey<xAOD::EventInfo> > DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_moduleBSErrKeys

private

Definition at line 88 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_moduleConditionKeys

std::vector<SG::WriteDecorHandleKey<xAOD::EventInfo> > DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_moduleConditionKeys

private

Definition at line 86 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_moduleFEmaskKeys

std::vector<SG::WriteDecorHandleKey<xAOD::EventInfo> > DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_moduleFEmaskKeys

private

Definition at line 87 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_pixelDetElStatusActiveOnly

SG::ReadHandleKey<InDet::SiDetectorElementStatus> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_pixelDetElStatusActiveOnly {this, "PixelDetElStatusActiveOnly", "", "Key of SiDetectorElementStatus for Pixel which reflects only whether modules or chips are active rather than delivering good data"}

protected

Definition at line 92 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_pixelID

const PixelID* DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_pixelID

private

Definition at line 82 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_pixelSummary

ToolHandle<IInDetConditionsTool> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_pixelSummary {this, "PixelConditionsSummaryTool", "PixelConditionsSummaryTool", "Tool for PixelConditionsSummaryTool"}

private

Definition at line 69 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_prefix

Gaudi::Property<std::string> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_prefix { this,"DecorationPrefix", "", "" }

private

Definition at line 48 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_readKeyHV

SG::ReadCondHandleKey<PixelDCSHVData> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_readKeyHV {this, "ReadKeyHV", "PixelDCSHVCondData", "Key of input bias voltage conditions folder"}

private

Definition at line 57 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_readKeyTemp

SG::ReadCondHandleKey<PixelDCSTempData> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_readKeyTemp {this, "ReadKeyeTemp", "PixelDCSTempCondData", "Key of input sensor temperature conditions folder"}

private

Definition at line 54 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_readoutTechnologyMask

unsigned int DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_readoutTechnologyMask {}

private

Definition at line 84 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_useByteStreamFEI3

Gaudi::Property<bool> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_useByteStreamFEI3 {this, "UseByteStreamFEI3", true, "Switch of the ByteStream error for FEI3"}

private

Definition at line 77 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_useByteStreamFEI4

Gaudi::Property<bool> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_useByteStreamFEI4 {this, "UseByteStreamFEI4", true, "Switch of the ByteStream error for FEI4"}

private

Definition at line 75 of file EventInfoPixelModuleStatusMonitoring.h.

◆ m_useByteStreamRD53

Gaudi::Property<bool> DerivationFramework::EventInfoPixelModuleStatusMonitoring::m_useByteStreamRD53 {this, "UseByteStreamRD53", false, "Switch of the ByteStream error for RD53"}

private

Definition at line 79 of file EventInfoPixelModuleStatusMonitoring.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EventInfoPixelModuleStatusMonitoring()

Member Function Documentation

◆ addBranches()

◆ finalize()

◆ getPixelDetElStatus()

◆ initialize()

Member Data Documentation

◆ m_condDCSStateKey

◆ m_condDCSStatusKey

◆ m_condDeadMapKey

◆ m_eventInfoKey

◆ m_idcErrContKey

◆ m_lbCounter

◆ m_moduleBSErrKeys

◆ m_moduleConditionKeys

◆ m_moduleFEmaskKeys

◆ m_pixelDetElStatusActiveOnly

◆ m_pixelID

◆ m_pixelSummary

◆ m_prefix

◆ m_readKeyHV

◆ m_readKeyTemp

◆ m_readoutTechnologyMask

◆ m_useByteStreamFEI3

◆ m_useByteStreamFEI4

◆ m_useByteStreamRD53