SCT_FlaggedConditionTool Class Reference

#include <SCT_FlaggedConditionTool.h>

Inheritance diagram for SCT_FlaggedConditionTool:

Collaboration diagram for SCT_FlaggedConditionTool:

Public Member Functions
	SCT_FlaggedConditionTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~SCT_FlaggedConditionTool ()=default
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual bool	canReportAbout (InDetConditions::Hierarchy h) const override
	Can the tool report about the given component?
virtual bool	isGood (const Identifier &elementId, const EventContext &ctx, InDetConditions::Hierarchy h=InDetConditions::DEFAULT) const override
	Is the detector element good?
virtual bool	isGood (const IdentifierHash &hashId, const EventContext &ctx) const override
virtual void	getDetectorElementStatus (const EventContext &ctx, InDet::SiDetectorElementStatus &element_status, SG::WriteCondHandle< InDet::SiDetectorElementStatus > *whandle) const override
virtual const std::string &	details (const Identifier &id, const EventContext &ctx) const override
	Get the reason why the wafer is bad (by Identifier).
virtual const std::string &	details (const IdentifierHash &id, const EventContext &ctx) const override
	Get the reason why the wafer is bad (by IdentifierHash).
virtual int	numBadIds (const EventContext &ctx) const override
	Get number flagged as bad (per event).
virtual const IDCInDetBSErrContainer *	getBadIds (const EventContext &ctx) const override
	Get IdentifierHashs ofwafers flagged as bad + reason (per event).

Private Member Functions
const IDCInDetBSErrContainer *	getCondData (const EventContext &ctx) const

Private Attributes
SG::ReadHandleKey< IDCInDetBSErrContainer >	m_badIds {this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"}
UnsignedIntegerProperty	m_maxNumWarnForFailures {this, "MaxNumWarnForFailures", 5}
std::atomic_uint	m_numWarnForFailures {0}
const SCT_ID *	m_sctID {nullptr}
	ID helper for SCT.

Detailed Description

Definition at line 33 of file SCT_FlaggedConditionTool.h.

Constructor & Destructor Documentation

SCT_FlaggedConditionTool()

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

Definition at line 14 of file SCT_FlaggedConditionTool.cxx.

                                                                                                                        :
  base_class(type, name, parent)
{
}

~SCT_FlaggedConditionTool()

virtual SCT_FlaggedConditionTool::~SCT_FlaggedConditionTool ( )

virtualdefault

Member Function Documentation

canReportAbout()

bool SCT_FlaggedConditionTool::canReportAbout ( InDetConditions::Hierarchy h ) const

overridevirtual

Can the tool report about the given component?

(chip, module...)

Definition at line 40 of file SCT_FlaggedConditionTool.cxx.

                                                                              {
  return (h == InDetConditions::SCT_SIDE or h == InDetConditions::DEFAULT);
}

details() [1/2]

const std::string & SCT_FlaggedConditionTool::details ( const Identifier & id, const EventContext & ctx ) const

overridevirtual

Get the reason why the wafer is bad (by Identifier).

Definition at line 127 of file SCT_FlaggedConditionTool.cxx.

                                                                                                      {
  const IdentifierHash hashId{m_sctID->wafer_hash(Id)};
  return details(hashId, ctx);
}

details() [2/2]

const std::string & SCT_FlaggedConditionTool::details ( const IdentifierHash & id, const EventContext & ctx ) const

overridevirtual

Get the reason why the wafer is bad (by IdentifierHash).

Definition at line 99 of file SCT_FlaggedConditionTool.cxx.

                                                                                                              {
  static const std::string nullString;
 
  const IDCInDetBSErrContainer* badIds{getCondData(ctx)};
  if (badIds==nullptr) {
    if (m_numWarnForFailures<m_maxNumWarnForFailures) {
      ATH_MSG_WARNING(m_badIds.key() << " cannot be retrieved. (details)");
      m_numWarnForFailures++;
      if (m_numWarnForFailures==m_maxNumWarnForFailures) {
        ATH_MSG_WARNING("Disabling this type of messages from " << name());
      }
    }
    return nullString;
  }
 
  if (badIds->present(hashId)) {
    const IDCInDetBSErrContainer::ErrorCode value{badIds->retrieve(hashId)};
    if (value>0) {
      for (size_t error{0}; error<SCT_FlaggedCondEnum::NUM_ERROR_TYPES; error++) {
        if (value & (1 << error)) return SCT_FlaggedCondEnum::ErrorTypeDescription[error];
      }
    }
  }
  return nullString;
}

finalize()

StatusCode SCT_FlaggedConditionTool::finalize ( )

overridevirtual

Definition at line 35 of file SCT_FlaggedConditionTool.cxx.

                                              {
  return StatusCode::SUCCESS;
}

getBadIds()

const IDCInDetBSErrContainer * SCT_FlaggedConditionTool::getBadIds ( const EventContext & ctx ) const

overridevirtual

Get IdentifierHashs ofwafers flagged as bad + reason (per event).

Definition at line 148 of file SCT_FlaggedConditionTool.cxx.

                                                                                               {
  return getCondData(ctx);
}

getCondData()

const IDCInDetBSErrContainer * SCT_FlaggedConditionTool::getCondData ( const EventContext & ctx ) const

private

Definition at line 152 of file SCT_FlaggedConditionTool.cxx.

                                                                                                 {
  SG::ReadHandle<IDCInDetBSErrContainer> condData{m_badIds, ctx};
  if (not condData.isValid()) {
    if (m_numWarnForFailures<m_maxNumWarnForFailures) {
      ATH_MSG_WARNING("Failed to get " << m_badIds.key());
      m_numWarnForFailures++;
      if (m_numWarnForFailures==m_maxNumWarnForFailures) {
        ATH_MSG_WARNING("Disabling this type of messages from " << name());
      }
    }
    return nullptr;
  }
  return condData.cptr();
}

getDetectorElementStatus()

void SCT_FlaggedConditionTool::getDetectorElementStatus ( const EventContext & ctx, InDet::SiDetectorElementStatus & element_status, SG::WriteCondHandle< InDet::SiDetectorElementStatus > * whandle ) const

overridevirtual

Definition at line 68 of file SCT_FlaggedConditionTool.cxx.

                                                                                                                        {
   const IDCInDetBSErrContainer* badIds{getCondData(ctx)};
   if (whandle) {
     ATH_MSG_ERROR("SCT_FlaggedConditionTool is not for conditions objects");
     whandle->addDependency (IDetectorElementStatusTool::getInvalidRange());
   }
   std::vector<bool> &status = element_status.getElementStatus();
   if (badIds==nullptr) {
      if (m_numWarnForFailures<m_maxNumWarnForFailures) {
         ATH_MSG_WARNING(m_badIds.key() << " cannot be retrieved. (isGood)");
         m_numWarnForFailures++;
         if (m_numWarnForFailures==m_maxNumWarnForFailures) {
            ATH_MSG_WARNING("Disabling this type of messages from " << name());
         }
      }
      status.clear();
      status.resize(m_sctID->wafer_hash_max(),false);
      return;
   }
   if (status.empty()) {
      status.resize(m_sctID->wafer_hash_max(),true);
   }
 
   for (size_t hash : badIds->getMask()) {
      status.at(hash)=false;
   }
}

initialize()

StatusCode SCT_FlaggedConditionTool::initialize ( )

overridevirtual

Definition at line 20 of file SCT_FlaggedConditionTool.cxx.

                                                {
  ATH_MSG_INFO("SCT_FlaggedConditionTool::initialize()");
 
  // Retrieve SCT helper
  if (detStore()->retrieve(m_sctID, "SCT_ID").isFailure()) {
    ATH_MSG_ERROR("SCT helper failed to retrieve");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_badIds.initialize());
 
  return StatusCode::SUCCESS;
}

isGood() [1/2]

bool SCT_FlaggedConditionTool::isGood ( const Identifier & elementId, const EventContext & ctx, InDetConditions::Hierarchy h = InDetConditions::DEFAULT ) const

overridevirtual

Is the detector element good?

Definition at line 45 of file SCT_FlaggedConditionTool.cxx.

                                                                                                                            {
  if (not canReportAbout(h)) return true;
  const IdentifierHash hashId{m_sctID->wafer_hash(elementId)};
  return isGood(hashId, ctx);
}

isGood() [2/2]

bool SCT_FlaggedConditionTool::isGood ( const IdentifierHash & hashId, const EventContext & ctx ) const

overridevirtual

Definition at line 52 of file SCT_FlaggedConditionTool.cxx.

                                                                                                 {
  const IDCInDetBSErrContainer* badIds{getCondData(ctx)};
  if (badIds==nullptr) {
    if (m_numWarnForFailures<m_maxNumWarnForFailures) {
      ATH_MSG_WARNING(m_badIds.key() << " cannot be retrieved. (isGood)");
      m_numWarnForFailures++;
      if (m_numWarnForFailures==m_maxNumWarnForFailures) {
        ATH_MSG_WARNING("Disabling this type of messages from " << name());
      }
    }
    return false;
  }
 
  return (not badIds->present(hashId));
}

numBadIds()

int SCT_FlaggedConditionTool::numBadIds ( const EventContext & ctx ) const

overridevirtual

Get number flagged as bad (per event).

Definition at line 132 of file SCT_FlaggedConditionTool.cxx.

                                                                     {
  const IDCInDetBSErrContainer* badIds{getCondData(ctx)};
  if (badIds==nullptr) {
    if (m_numWarnForFailures<m_maxNumWarnForFailures) {
      ATH_MSG_WARNING(m_badIds.key() << " cannot be retrieved. (numBadIds)");
      m_numWarnForFailures++;
      if (m_numWarnForFailures==m_maxNumWarnForFailures) {
        ATH_MSG_WARNING("Disabling this type of messages from " << name());
      }
    }
    return -1;
  }
 
  return static_cast<int>(badIds->numberSet());
}

Member Data Documentation

m_badIds

SG::ReadHandleKey<IDCInDetBSErrContainer> SCT_FlaggedConditionTool::m_badIds {this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"}

private

Definition at line 67 of file SCT_FlaggedConditionTool.h.

{this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"};

m_maxNumWarnForFailures

UnsignedIntegerProperty SCT_FlaggedConditionTool::m_maxNumWarnForFailures {this, "MaxNumWarnForFailures", 5}

private

Definition at line 69 of file SCT_FlaggedConditionTool.h.

{this, "MaxNumWarnForFailures", 5};

m_numWarnForFailures

std::atomic_uint SCT_FlaggedConditionTool::m_numWarnForFailures {0}

mutableprivate

Definition at line 70 of file SCT_FlaggedConditionTool.h.

{0};

m_sctID

const SCT_ID* SCT_FlaggedConditionTool::m_sctID {nullptr}

private

ID helper for SCT.

Definition at line 72 of file SCT_FlaggedConditionTool.h.

{nullptr}; 

---

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

• SCT_FlaggedConditionTool.h
• SCT_FlaggedConditionTool.cxx