Mask LAr cells in Febs with decoding errors or listed in the bad feb database. More...

#include <LArBadFebMaskingTool.h>

Inheritance diagram for LArBadFebMaskingTool:

Public Member Functions
virtual StatusCode	initialize () override
	initialize the tool
virtual StatusCode	finalize () override
	finalize the tool
virtual StatusCode	process (CaloCellContainer *theCellContainer, const EventContext &ctx) const override
	update theCellContainer, masking Feb with errors

Private Attributes
SG::ReadCondHandleKey< LArBadFebCont >	m_badFebKey {this,"BadFebKey","LArBadFeb","Key of Bad-Feb object"}
	handle to get bad febs
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
	handle to LAr cabling
Gaudi::Property< bool >	m_maskParity {this,"maskParity",true}
	flags to select which errors to mask
Gaudi::Property< bool >	m_maskSampleHeader {this,"maskSampleHeader",true}
Gaudi::Property< bool >	m_maskEVTID {this,"maskEVTID",true}
Gaudi::Property< bool >	m_maskScacStatus {this,"maskScacStatus",true}
Gaudi::Property< bool >	m_maskScaOutOfRange {this,"maskScaOutOfRange",true}
Gaudi::Property< bool >	m_maskGainMismatch {this,"maskGainMismatch",true}
Gaudi::Property< bool >	m_maskTypeMismatch {this,"maskTypeMismatch",true}
Gaudi::Property< bool >	m_maskNumOfSamples {this,"maskNumOfSamples",true}
Gaudi::Property< bool >	m_maskEmptyDataBlock {this,"maskEmptyDataBlock",true}
Gaudi::Property< bool >	m_maskDspBlockSize {this,"maskDspBlockSize",true}
Gaudi::Property< bool >	m_maskCheckSum {this,"maskCheckSum",true}
Gaudi::Property< bool >	m_maskMissingHeader {this,"maskMissingHeader",true}
Gaudi::Property< bool >	m_maskBadGain {this,"maskBadGain",true}
Gaudi::Property< bool >	m_noFebErrors {this,"noFebErrors",false,"do not read LArFebErrorSummary (MC case)"}
SG::ReadHandleKey< LArFebErrorSummary >	m_larFebErrorSummaryKey {this,"FebErrorSummaryKey","LArFebErrorSummary"}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this,"EventInfoKey","EventInfo"}
SG::WriteDecorHandleKey< xAOD::EventInfo >	m_eventInfoDecorKey {this,"EventInfoDecorKey",m_eventInfoKey, "larFlags"}
uint16_t	m_errorToMask =0
	compute bit mask of errors to mask
const CaloCell_ID *	m_calo_id =nullptr
	pointers to identifier helpers
const LArOnlineID *	m_onlineID =nullptr
std::atomic< int >	m_evt {0}
	Number of events processed.
std::atomic< int >	m_mask {0}
	Number of Feb masked.
const std::map< unsigned int, uint16_t >	m_dummyFebMap {}
	Empty dummy map for MC case.

Detailed Description

Mask LAr cells in Febs with decoding errors or listed in the bad feb database.

AlgTool properties (name defined in cxx file): Handle for bad channel tool name Switches to decide which Feb errors to mask Removed setting LAr errors bit in EventInfo, moved to LArFebErrorSummaryMaker

Created April 23, 2009 G.Unal

Definition at line 38 of file LArBadFebMaskingTool.h.

Member Function Documentation

◆ finalize()

StatusCode LArBadFebMaskingTool::finalize ( )

overridevirtual

finalize the tool

Definition at line 73 of file LArBadFebMaskingTool.cxx.

{
   ATH_MSG_INFO ("  ---- Summary from LArBadFebMaskingTool ");
   ATH_MSG_INFO ("   Number of events processed    " << m_evt);
   ATH_MSG_INFO ("   Number of masked Feb total    " << m_mask);
   float ratio=0.;
   if (m_evt>0) ratio=((float)(m_mask))/((float)(m_evt));
   ATH_MSG_INFO ("   Number of masked Feb per event " << ratio);
 
   return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode LArBadFebMaskingTool::initialize ( )

overridevirtual

initialize the tool

Definition at line 36 of file LArBadFebMaskingTool.cxx.

{
  m_evt=0;
  m_mask=0;
 
  m_errorToMask = 0;
  if (m_maskParity)         m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::Parity);
  if (m_maskSampleHeader)   m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::SampleHeader);
  if (m_maskEVTID)          m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::EVTID);
  if (m_maskScacStatus)     m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::ScacStatus);
  if (m_maskScaOutOfRange)  m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::ScaOutOfRange);
  if (m_maskGainMismatch)   m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::GainMismatch);
  if (m_maskTypeMismatch)   m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::TypeMismatch);
  if (m_maskNumOfSamples)   m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::NumOfSamples);
  if (m_maskEmptyDataBlock) m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::EmptyDataBlock);
  if (m_maskDspBlockSize)   m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::DspBlockSize);
  if (m_maskCheckSum)       m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::CheckSum);
  if (m_maskMissingHeader)  m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::MissingHeader);
  if (m_maskBadGain)        m_errorToMask = m_errorToMask | (1 <<LArFebErrorSummary::BadGain);
 
  ATH_MSG_INFO (" bit mask for errors to mask " << m_errorToMask);
 
  // initialize read handle keys
  ATH_CHECK(m_larFebErrorSummaryKey.initialize(!m_noFebErrors));
  ATH_CHECK( m_badFebKey.initialize());
  ATH_CHECK( m_cablingKey.initialize());
  ATH_CHECK(m_eventInfoKey.initialize());
  ATH_CHECK(m_eventInfoDecorKey.initialize());
 
  // retrieve identifier helpers
  ATH_CHECK( detStore()->retrieve(m_onlineID, "LArOnlineID") );
  ATH_CHECK( detStore()->retrieve(m_calo_id,"CaloCell_ID") );
 
  return StatusCode::SUCCESS;
 
}

◆ process()

StatusCode LArBadFebMaskingTool::process	(	CaloCellContainer *	theCellContainer,
		const EventContext &	ctx ) const

overridevirtual

update theCellContainer, masking Feb with errors

Definition at line 85 of file LArBadFebMaskingTool.cxx.

{
  m_evt++;
 
  const std::map<unsigned int,uint16_t>* febMap = &m_dummyFebMap; //empty dummy map for MC case
  if (!m_noFebErrors) {
    ATH_MSG_DEBUG (" in LArBadFebMaskingTool::process ");
    SG::ReadHandle<LArFebErrorSummary>larFebErrorSummary(m_larFebErrorSummaryKey, ctx);
    if (!larFebErrorSummary.isValid()) {
      ATH_MSG_WARNING ("Cannot retrieve Feb error summary with key " << m_larFebErrorSummaryKey.key() <<". Skip LArBadFebMaskingTool::process ");
      return StatusCode::SUCCESS;
    }
 
    // retrieve map of Feb-errors
    febMap = &larFebErrorSummary->get_all_febs();
    ATH_MSG_DEBUG (" Number of Febs " << febMap->size());
  }//end if m_noFebErrors
  
  // catch cases of empty LAR container  => severe problem in decoding => flag event as in ERROR
  unsigned int nLar = theCont->nCellsCalo(CaloCell_ID::LAREM)+theCont->nCellsCalo(CaloCell_ID::LARHEC)+theCont->nCellsCalo(CaloCell_ID::LARFCAL);
  if (nLar==0) {
     ATH_MSG_DEBUG (" empty lar cell container ");
     SG::ReadHandle<xAOD::EventInfo> eventInfo (m_eventInfoKey, ctx);
     ATH_MSG_DEBUG (" set error bit for LAr for this event ");
     if (!eventInfo->updateErrorState(xAOD::EventInfo::LAr,xAOD::EventInfo::Error)) {
        ATH_MSG_WARNING (" cannot set error state for LAr ");
     }
     if (!eventInfo->updateEventFlagBit(xAOD::EventInfo::LAr,LArEventBitInfo::DATACORRUPTED)) {
      ATH_MSG_WARNING (" cannot set event bit info for LAr ");
     }
  }
 
 
  SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey,ctx};
  const LArOnOffIdMapping* cabling=*cablingHdl;
 
  SG::ReadCondHandle<LArBadFebCont> badFebHdl{m_badFebKey,ctx};
  const LArBadFebCont* badFebs=*badFebHdl;
 
// loop over all Febs
 
  for (HWIdentifier febId : m_onlineID->feb_range()) {
      bool toMask1 = false;   // mask because of bad error
      bool inError = false;   // mask because Feb listed in database as being to mask
 
// for debug
      unsigned int ifeb = febId.get_identifier32().get_compact();
      ATH_MSG_DEBUG (" process Feb: " << ifeb);
 
      std::map<unsigned int,uint16_t>::const_iterator it1 = febMap->find(ifeb);
      if (it1 != febMap->end()) {
        uint16_t ierror = (*it1).second;
        if (ierror & m_errorToMask) toMask1=true;
        ATH_MSG_DEBUG (" ierror,toMask " << ierror << " " << toMask1 << " ");
      }
 
 
      LArBadFeb febstatus = badFebs->status(febId);
      inError = febstatus.inError() || febstatus.deadAll();
 
      if (toMask1 || inError) {
         m_mask++;
         const int nChanPerFeb=m_onlineID->channelInSlotMax(febId);
         for (int ch=0; ch<nChanPerFeb; ++ch) {
           HWIdentifier hwid = m_onlineID->channel_Id(febId, ch);
           if (cabling->isOnlineConnected(hwid)) {
              Identifier id = cabling->cnvToIdentifier( hwid);
              IdentifierHash theCellHashID = m_calo_id->calo_cell_hash(id);
              int index = theCont->findIndex(theCellHashID);
              if (index<0) {
                 ATH_MSG_DEBUG (" cell " << hwid.get_compact() << " " << id.get_compact() << " is not in the container ");
                 continue;
              }
              CaloCell* aCell = theCont->at(index);
 
              if (aCell) {
                ATH_MSG_DEBUG ("  mask cell hwid= " << hwid.get_compact() << " offlineid = " << id.get_compact()
                               << " " << aCell->ID().get_compact());
                aCell->setEnergy(0.);
                aCell->setTime(0.);
                uint16_t qua=0;
                aCell->setQuality(qua);
                const uint16_t provenance = (aCell->provenance() | LArProv::MASKED | LArProv::DEADFEB);// 0x0800 | 0x4000 
                aCell->setProvenance(provenance);
              }
 
           }  // isConnected
         }    // loop over channels in Feb
      }       // toMask
 
  }       // loop over Febs in error
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_badFebKey

SG::ReadCondHandleKey<LArBadFebCont> LArBadFebMaskingTool::m_badFebKey {this,"BadFebKey","LArBadFeb","Key of Bad-Feb object"}

private

handle to get bad febs

Definition at line 66 of file LArBadFebMaskingTool.h.

66{this,"BadFebKey","LArBadFeb","Key of Bad-Feb object"};

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArBadFebMaskingTool::m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}

private

handle to LAr cabling

Definition at line 69 of file LArBadFebMaskingTool.h.

69{this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"};

◆ m_calo_id

const CaloCell_ID* LArBadFebMaskingTool::m_calo_id =nullptr

private

pointers to identifier helpers

Definition at line 98 of file LArBadFebMaskingTool.h.

◆ m_dummyFebMap

const std::map<unsigned int,uint16_t> LArBadFebMaskingTool::m_dummyFebMap {}

private

Empty dummy map for MC case.

Definition at line 111 of file LArBadFebMaskingTool.h.

111{};

◆ m_errorToMask

uint16_t LArBadFebMaskingTool::m_errorToMask =0

private

compute bit mask of errors to mask

Definition at line 94 of file LArBadFebMaskingTool.h.

◆ m_eventInfoDecorKey

SG::WriteDecorHandleKey<xAOD::EventInfo> LArBadFebMaskingTool::m_eventInfoDecorKey {this,"EventInfoDecorKey",m_eventInfoKey, "larFlags"}

private

Definition at line 91 of file LArBadFebMaskingTool.h.

91{this,"EventInfoDecorKey",m_eventInfoKey, "larFlags"};

◆ m_eventInfoKey

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

private

Definition at line 90 of file LArBadFebMaskingTool.h.

90{this,"EventInfoKey","EventInfo"};

◆ m_evt

std::atomic<int> LArBadFebMaskingTool::m_evt {0}

mutableprivate

Number of events processed.

Definition at line 103 of file LArBadFebMaskingTool.h.

103{0};

◆ m_larFebErrorSummaryKey

SG::ReadHandleKey<LArFebErrorSummary> LArBadFebMaskingTool::m_larFebErrorSummaryKey {this,"FebErrorSummaryKey","LArFebErrorSummary"}

private

Definition at line 89 of file LArBadFebMaskingTool.h.

89{this,"FebErrorSummaryKey","LArFebErrorSummary"};

◆ m_mask

std::atomic<int> LArBadFebMaskingTool::m_mask {0}

mutableprivate

Number of Feb masked.

Definition at line 107 of file LArBadFebMaskingTool.h.

107{0};

◆ m_maskBadGain

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskBadGain {this,"maskBadGain",true}

private

Definition at line 85 of file LArBadFebMaskingTool.h.

85{this,"maskBadGain",true};

◆ m_maskCheckSum

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskCheckSum {this,"maskCheckSum",true}

private

Definition at line 83 of file LArBadFebMaskingTool.h.

83{this,"maskCheckSum",true};

◆ m_maskDspBlockSize

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskDspBlockSize {this,"maskDspBlockSize",true}

private

Definition at line 82 of file LArBadFebMaskingTool.h.

82{this,"maskDspBlockSize",true};

◆ m_maskEmptyDataBlock

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskEmptyDataBlock {this,"maskEmptyDataBlock",true}

private

Definition at line 81 of file LArBadFebMaskingTool.h.

81{this,"maskEmptyDataBlock",true};

◆ m_maskEVTID

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskEVTID {this,"maskEVTID",true}

private

Definition at line 75 of file LArBadFebMaskingTool.h.

75{this,"maskEVTID",true};

◆ m_maskGainMismatch

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskGainMismatch {this,"maskGainMismatch",true}

private

Definition at line 78 of file LArBadFebMaskingTool.h.

78{this,"maskGainMismatch",true};

◆ m_maskMissingHeader

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskMissingHeader {this,"maskMissingHeader",true}

private

Definition at line 84 of file LArBadFebMaskingTool.h.

84{this,"maskMissingHeader",true};

◆ m_maskNumOfSamples

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskNumOfSamples {this,"maskNumOfSamples",true}

private

Definition at line 80 of file LArBadFebMaskingTool.h.

80{this,"maskNumOfSamples",true};

◆ m_maskParity

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskParity {this,"maskParity",true}

private

flags to select which errors to mask

Definition at line 73 of file LArBadFebMaskingTool.h.

73{this,"maskParity",true};

◆ m_maskSampleHeader

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskSampleHeader {this,"maskSampleHeader",true}

private

Definition at line 74 of file LArBadFebMaskingTool.h.

74{this,"maskSampleHeader",true};

◆ m_maskScacStatus

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskScacStatus {this,"maskScacStatus",true}

private

Definition at line 76 of file LArBadFebMaskingTool.h.

76{this,"maskScacStatus",true};

◆ m_maskScaOutOfRange

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskScaOutOfRange {this,"maskScaOutOfRange",true}

private

Definition at line 77 of file LArBadFebMaskingTool.h.

77{this,"maskScaOutOfRange",true};

◆ m_maskTypeMismatch

Gaudi::Property<bool> LArBadFebMaskingTool::m_maskTypeMismatch {this,"maskTypeMismatch",true}

private

Definition at line 79 of file LArBadFebMaskingTool.h.

79{this,"maskTypeMismatch",true};

◆ m_noFebErrors

Gaudi::Property<bool> LArBadFebMaskingTool::m_noFebErrors {this,"noFebErrors",false,"do not read LArFebErrorSummary (MC case)"}

private

Definition at line 87 of file LArBadFebMaskingTool.h.

87{this,"noFebErrors",false,"do not read LArFebErrorSummary (MC case)"};

◆ m_onlineID

const LArOnlineID* LArBadFebMaskingTool::m_onlineID =nullptr

private

Definition at line 99 of file LArBadFebMaskingTool.h.

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

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ finalize()

◆ initialize()

◆ process()

Member Data Documentation

◆ m_badFebKey

◆ m_cablingKey

◆ m_calo_id

◆ m_dummyFebMap

◆ m_errorToMask

◆ m_eventInfoDecorKey

◆ m_eventInfoKey

◆ m_evt

◆ m_larFebErrorSummaryKey

◆ m_mask

◆ m_maskBadGain

◆ m_maskCheckSum

◆ m_maskDspBlockSize

◆ m_maskEmptyDataBlock

◆ m_maskEVTID

◆ m_maskGainMismatch

◆ m_maskMissingHeader

◆ m_maskNumOfSamples

◆ m_maskParity

◆ m_maskSampleHeader

◆ m_maskScacStatus

◆ m_maskScaOutOfRange

◆ m_maskTypeMismatch

◆ m_noFebErrors

◆ m_onlineID