SCT_ConditionsSummaryTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
#include "SCT_ConditionsSummaryTool.h"
#include "SCT_ReadoutGeometry/SCT_DetectorElementStatus.h"
#include "SCT_ConditionsTools/ISCT_ConditionsTool.h"
 
#include "GaudiKernel/EventContext.h"
#include "InDetIdentifier/SCT_ID.h"
 
// Constructor
SCT_ConditionsSummaryTool::SCT_ConditionsSummaryTool(const std::string& type, const std::string& name, const IInterface* parent) :
  base_class(type, name, parent)
{
}
 
//Initialize
StatusCode 
SCT_ConditionsSummaryTool::initialize() {
  StatusCode sc{m_toolHandles.retrieve()};
  if (sc.isFailure()) {
    ATH_MSG_ERROR("Retrieval of ToolHandleArray<ISCT_ConditionsTool> failed.");
    return sc;
  }
  ATH_CHECK( m_SCTDetEleCollKey.initialize() );
  if (!m_SCTDetElStatusEventKey.empty() && !m_SCTDetElStatusCondKey.empty()) {
     ATH_MSG_FATAL("The event data (SCTDetElStatusEventDataBaseKey) and cond data (SCTDetElStatusCondDataBaseKey) keys cannot be set at the same time.");
  }
  ATH_CHECK(m_SCTDetElStatusEventKey.initialize( !m_SCTDetElStatusEventKey.empty()));
  ATH_CHECK(m_SCTDetElStatusCondKey.initialize( !m_SCTDetElStatusCondKey.empty()));
  // Get SCT helper
  ATH_CHECK(detStore()->retrieve(m_id_sct, "SCT_ID"));
  m_noReports = m_toolHandles.empty();
  return sc;
}
 
double
SCT_ConditionsSummaryTool::activeFraction(const IdentifierHash& elementHash, const Identifier& idStart, const Identifier& idEnd, const EventContext& ctx) const {
  return goodFraction(elementHash, idStart, idEnd, ctx);
}
 
bool 
SCT_ConditionsSummaryTool::isActive(const Identifier& elementId, const InDetConditions::Hierarchy h, const EventContext& ctx) const {
  return isGood(elementId, h, ctx);
}
 
bool 
SCT_ConditionsSummaryTool::isActive(const IdentifierHash& elementHash, const EventContext& ctx) const {
  return isGood(elementHash, ctx);
}
 
bool 
SCT_ConditionsSummaryTool::isActive(const IdentifierHash& elementHash, const Identifier& elementId, const EventContext& ctx) const {
  return isGood(elementHash, elementId, ctx);
}
 
bool 
SCT_ConditionsSummaryTool::isGood(const Identifier& elementId, const InDetConditions::Hierarchy h, const EventContext& ctx) const {
  if (not m_noReports) {
    for (const ToolHandle<ISCT_ConditionsTool>& tool: m_toolHandles) {
      if (tool->canReportAbout(h) and (not tool->isGood(elementId, ctx, h))) return false;
    }
  }
  return true;
}
 
bool 
SCT_ConditionsSummaryTool::isGood(const IdentifierHash& elementHash, const EventContext& ctx) const {
  if (not m_noReports) {
    for (const ToolHandle<ISCT_ConditionsTool>& tool: m_toolHandles) {
      if ((tool->canReportAbout(InDetConditions::SCT_SIDE) or
           tool->canReportAbout(InDetConditions::SCT_MODULE)) and
          (not tool->isGood(elementHash, ctx))) {
        return false;
      }
    }    
  }
  return true;
}
 
namespace {
   const InDet::SCT_DetectorElementStatus *castToDerived(const InDet::SiDetectorElementStatus *input) {
      const InDet::SCT_DetectorElementStatus *ret = dynamic_cast<const InDet::SCT_DetectorElementStatus *>(input);
      if (!ret) {
         throw std::runtime_error("Object is not of expected type InDet::SCT_DetectorElementStatus");
      }
      return ret;
   }
}
std::unique_ptr<InDet::SiDetectorElementStatus>
SCT_ConditionsSummaryTool::createDetectorElementStatus(const EventContext& ctx,
                                                       SG::WriteCondHandle<InDet::SiDetectorElementStatus>* whandle) const  {
      std::string tool_name (name());
      (void) tool_name;
   if (!m_SCTDetElStatusCondKey.empty()) {
      SG::ReadCondHandle<InDet::SiDetectorElementStatus> input_element_status{m_SCTDetElStatusCondKey, ctx};
      if (whandle) {
        whandle->addDependency (input_element_status);
      }
      return std::make_unique<InDet::SCT_DetectorElementStatus>(*castToDerived(input_element_status.cptr()));
   }
   else if (!m_SCTDetElStatusEventKey.empty()) {
      SG::ReadHandle<InDet::SiDetectorElementStatus> input_element_status{m_SCTDetElStatusEventKey, ctx};
      std::string key (m_SCTDetElStatusEventKey.key());
      (void) key;
      return std::make_unique<InDet::SCT_DetectorElementStatus>(*castToDerived(input_element_status.cptr()));
   }
   else {
      SG::ReadCondHandle<InDetDD::SiDetectorElementCollection> sctDetEleHandle(m_SCTDetEleCollKey, ctx);
      if (whandle) {
        whandle->addDependency (sctDetEleHandle);
      }
      const InDetDD::SiDetectorElementCollection* elements(*sctDetEleHandle);
      return std::make_unique<InDet::SCT_DetectorElementStatus>(*elements);
   }
}
 
std::unique_ptr<InDet::SiDetectorElementStatus>
SCT_ConditionsSummaryTool::getDetectorElementStatus(const EventContext& ctx,
                                                    SG::WriteCondHandle<InDet::SiDetectorElementStatus>* whandle) const {
   std::unique_ptr<InDet::SiDetectorElementStatus>
      element_status( createDetectorElementStatus(ctx, whandle) );
   if (not m_noReports) {
      for (const ToolHandle<ISCT_ConditionsTool>& tool: m_toolHandles) {
         // @TODO also check if it can report about chips ?
         if ((tool->canReportAbout(InDetConditions::SCT_SIDE) or
              tool->canReportAbout(InDetConditions::SCT_MODULE) or
              tool->canReportAbout(InDetConditions::SCT_STRIP))) {
            tool->getDetectorElementStatus(ctx,*element_status,whandle);
         }
      }
   }
   if (element_status->getElementStatus().empty()) {
      element_status->getElementStatus().resize( element_status->getDetectorElements().size(), true);
   }
   if (element_status->getElementChipStatus().empty()) {
      element_status->getElementChipStatus().resize( element_status->getDetectorElements().size(), 0xffff);
   }
   if (element_status->getBadCells().empty()) {
      element_status->getBadCells().resize( element_status->getDetectorElements().size());
   }
   return element_status;
}
 
bool 
SCT_ConditionsSummaryTool::isGood(const IdentifierHash& /*elementHash*/, const Identifier& elementId, const EventContext& ctx, const IInDetConditionsTool::IDCCacheEntry* /*cacheEntry*/) const {
  if (not m_noReports) {
    for (const ToolHandle<ISCT_ConditionsTool>& tool: m_toolHandles) {
      if (tool->canReportAbout(InDetConditions::SCT_STRIP) and (not tool->isGood(elementId, ctx))) return false;
    } 
  }
  return true;
}
 
IInDetConditionsTool::IDCCacheEntry* SCT_ConditionsSummaryTool::getCacheEntryOut(const EventContext& /*ctx*/) const{
  IDCCacheEntry* vector{nullptr};
  return vector;
}
 
double 
SCT_ConditionsSummaryTool::goodFraction(const IdentifierHash& /*elementHash*/, const Identifier& /*idStart*/, const Identifier& /*idEnd*/, const EventContext& /*ctx*/) const {
  double result{1.0};
  ATH_MSG_WARNING("goodFraction is a deprecated function always returning 1.0 ");
  return result;
}
 
bool
SCT_ConditionsSummaryTool::hasBSError(const IdentifierHash& /*elementHash*/, const EventContext& /*ctx*/, const IInDetConditionsTool::IDCCacheEntry* /*cacheEntry*/) const {
  ATH_MSG_WARNING("hasBSError() is not implemented for SCT_ConditionsSummaryTool");
  return true;
}
 
bool
SCT_ConditionsSummaryTool::hasBSError(const IdentifierHash& /*elementHash*/, Identifier /*elementId*/, const EventContext& /*ctx*/, const IInDetConditionsTool::IDCCacheEntry* /*cacheEntry*/) const {
  ATH_MSG_WARNING("hasBSError() is not implemented for SCT_ConditionsSummaryTool");
  return true;
}
 
uint64_t
SCT_ConditionsSummaryTool::getBSErrorWord(const IdentifierHash& /*moduleHash*/, const EventContext& /*ctx*/, const IInDetConditionsTool::IDCCacheEntry* /*cacheEntry*/) const {
  ATH_MSG_WARNING("getBSErrorWord() is not implemented for SCT_ConditionsSummaryTool");
  return 0;
}
 
uint64_t
SCT_ConditionsSummaryTool::getBSErrorWord(const IdentifierHash& /*moduleHash*/, const int /*index*/, const EventContext& /*ctx*/, const IInDetConditionsTool::IDCCacheEntry* /*cacheEntry*/) const {
  ATH_MSG_WARNING("getBSErrorWord() is not implemented for SCT_ConditionsSummaryTool");
  return 0;
}