Interface class for tool providing summary of status of an SCT detector element. More...

#include <SCT_ConditionsSummaryTool.h>

Inheritance diagram for SCT_ConditionsSummaryTool:

Collaboration diagram for SCT_ConditionsSummaryTool:

Public Member Functions
	SCT_ConditionsSummaryTool (const std::string &type, const std::string &name, const IInterface *parent)
	Tool constructor.
virtual	~SCT_ConditionsSummaryTool ()=default
virtual StatusCode	initialize () override
	Tool init.
virtual bool	isActive (const Identifier &elementId, const InDetConditions::Hierarchy h, const EventContext &ctx) const override
virtual bool	isActive (const IdentifierHash &elementHash, const EventContext &ctx) const override
virtual bool	isActive (const IdentifierHash &elementHash, const Identifier &elementId, const EventContext &ctx) const override
virtual double	activeFraction (const IdentifierHash &elementHash, const Identifier &idStart, const Identifier &idEnd, const EventContext &ctx) const override
virtual bool	isGood (const Identifier &elementId, const InDetConditions::Hierarchy h, const EventContext &ctx) const override
virtual bool	isGood (const IdentifierHash &elementHash, const EventContext &ctx) const override
virtual bool	isGood (const IdentifierHash &elementHash, const Identifier &elementId, const EventContext &ctx, const IDCCacheEntry *cacheEntry=nullptr) const override
virtual double	goodFraction (const IdentifierHash &elementHash, const Identifier &idStart, const Identifier &idEnd, const EventContext &ctx) const override
virtual std::unique_ptr< InDet::SiDetectorElementStatus >	getDetectorElementStatus (const EventContext &ctx, SG::WriteCondHandle< InDet::SiDetectorElementStatus > *whandle) const override
virtual bool	hasBSError (const IdentifierHash &elementHash, const EventContext &ctx, const IDCCacheEntry *cacheEntry=nullptr) const override
virtual bool	hasBSError (const IdentifierHash &elementHash, Identifier elementId, const EventContext &ctx, const IDCCacheEntry *cacheEntry=nullptr) const override
virtual uint64_t	getBSErrorWord (const IdentifierHash &moduleHash, const EventContext &ctx, const IDCCacheEntry *cacheEntry=nullptr) const override
virtual uint64_t	getBSErrorWord (const IdentifierHash &moduleHash, const int index, const EventContext &ctx, const IDCCacheEntry *cacheEntry=nullptr) const override
virtual IDCCacheEntry *	getCacheEntryOut (const EventContext &ctx) const override

Private Member Functions
std::unique_ptr< InDet::SiDetectorElementStatus >	createDetectorElementStatus (const EventContext &ctx, SG::WriteCondHandle< InDet::SiDetectorElementStatus > *whandle) const

Private Attributes
ToolHandleArray< ISCT_ConditionsTool >	m_toolHandles {this, "ConditionsTools", {},""}
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_SCTDetEleCollKey {this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"}
SG::ReadHandleKey< InDet::SiDetectorElementStatus >	m_SCTDetElStatusEventKey {this, "SCTDetElStatusEventDataBaseKey", "", "Optional event data key of an input SiDetectorElementStatus on which the newly created object will be based."}
SG::ReadCondHandleKey< InDet::SiDetectorElementStatus >	m_SCTDetElStatusCondKey {this, "SCTDetElStatusCondDataBaseKey", "" , "Optional conditions data key of an input SiDetectorElementStatus on which the newly created object will be based."}
const SCT_ID *	m_id_sct {nullptr}
	Handle to SCT ID helper.
bool	m_noReports {true}

Detailed Description

Interface class for tool providing summary of status of an SCT detector element.

Definition at line 38 of file SCT_ConditionsSummaryTool.h.

Constructor & Destructor Documentation

◆ SCT_ConditionsSummaryTool()

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

Tool constructor.

Definition at line 19 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                                           :
  base_class(type, name, parent)
{
}

◆ ~SCT_ConditionsSummaryTool()

virtual SCT_ConditionsSummaryTool::~SCT_ConditionsSummaryTool ( )

virtualdefault

Member Function Documentation

◆ activeFraction()

double SCT_ConditionsSummaryTool::activeFraction	(	const IdentifierHash &	elementHash,
		const Identifier &	idStart,
		const Identifier &	idEnd,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 45 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                                                                              {
  return goodFraction(elementHash, idStart, idEnd, ctx);
}

◆ createDetectorElementStatus()

std::unique_ptr< InDet::SiDetectorElementStatus > SCT_ConditionsSummaryTool::createDetectorElementStatus	(	const EventContext &	ctx,
		SG::WriteCondHandle< InDet::SiDetectorElementStatus > *	whandle ) const

private

Definition at line 98 of file SCT_ConditionsSummaryTool.cxx.

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

◆ getBSErrorWord() [1/2]

virtual uint64_t SCT_ConditionsSummaryTool::getBSErrorWord	(	const IdentifierHash &	moduleHash,
		const EventContext &	ctx,
		const IDCCacheEntry *	cacheEntry = nullptr ) const

overridevirtual

◆ getBSErrorWord() [2/2]

virtual uint64_t SCT_ConditionsSummaryTool::getBSErrorWord	(	const IdentifierHash &	moduleHash,
		const int	index,
		const EventContext &	ctx,
		const IDCCacheEntry *	cacheEntry = nullptr ) const

overridevirtual

◆ getCacheEntryOut()

IInDetConditionsTool::IDCCacheEntry * SCT_ConditionsSummaryTool::getCacheEntryOut ( const EventContext & ctx ) const

overridevirtual

Definition at line 162 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                         {
  IDCCacheEntry* vector{nullptr};
  return vector;
}

◆ getDetectorElementStatus()

std::unique_ptr< InDet::SiDetectorElementStatus > SCT_ConditionsSummaryTool::getDetectorElementStatus	(	const EventContext &	ctx,
		SG::WriteCondHandle< InDet::SiDetectorElementStatus > *	whandle ) const

overridevirtual

Definition at line 126 of file SCT_ConditionsSummaryTool.cxx.

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

◆ goodFraction()

double SCT_ConditionsSummaryTool::goodFraction	(	const IdentifierHash &	elementHash,
		const Identifier &	idStart,
		const Identifier &	idEnd,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 168 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                                                      {
  double result{1.0};
  ATH_MSG_WARNING("goodFraction is a deprecated function always returning 1.0 ");
  return result;
}

◆ hasBSError() [1/2]

virtual bool SCT_ConditionsSummaryTool::hasBSError	(	const IdentifierHash &	elementHash,
		const EventContext &	ctx,
		const IDCCacheEntry *	cacheEntry = nullptr ) const

overridevirtual

◆ hasBSError() [2/2]

virtual bool SCT_ConditionsSummaryTool::hasBSError	(	const IdentifierHash &	elementHash,
		Identifier	elementId,
		const EventContext &	ctx,
		const IDCCacheEntry *	cacheEntry = nullptr ) const

overridevirtual

◆ initialize()

StatusCode SCT_ConditionsSummaryTool::initialize ( )

overridevirtual

Tool init.

Definition at line 26 of file SCT_ConditionsSummaryTool.cxx.

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

◆ isActive() [1/3]

bool SCT_ConditionsSummaryTool::isActive	(	const Identifier &	elementId,
		const InDetConditions::Hierarchy	h,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 50 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                                                {
  return isGood(elementId, h, ctx);
}

◆ isActive() [2/3]

bool SCT_ConditionsSummaryTool::isActive	(	const IdentifierHash &	elementHash,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 55 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                    {
  return isGood(elementHash, ctx);
}

◆ isActive() [3/3]

bool SCT_ConditionsSummaryTool::isActive	(	const IdentifierHash &	elementHash,
		const Identifier &	elementId,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 60 of file SCT_ConditionsSummaryTool.cxx.

                                                                                                                                 {
  return isGood(elementHash, elementId, ctx);
}

◆ isGood() [1/3]

bool SCT_ConditionsSummaryTool::isGood	(	const Identifier &	elementId,
		const InDetConditions::Hierarchy	h,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 65 of file SCT_ConditionsSummaryTool.cxx.

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

◆ isGood() [2/3]

bool SCT_ConditionsSummaryTool::isGood	(	const IdentifierHash &	elementHash,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 75 of file SCT_ConditionsSummaryTool.cxx.

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

◆ isGood() [3/3]

virtual bool SCT_ConditionsSummaryTool::isGood	(	const IdentifierHash &	elementHash,
		const Identifier &	elementId,
		const EventContext &	ctx,
		const IDCCacheEntry *	cacheEntry = nullptr ) const

overridevirtual

Member Data Documentation

◆ m_id_sct

const SCT_ID* SCT_ConditionsSummaryTool::m_id_sct {nullptr}

private

Handle to SCT ID helper.

Definition at line 83 of file SCT_ConditionsSummaryTool.h.

83{nullptr};

◆ m_noReports

bool SCT_ConditionsSummaryTool::m_noReports {true}

private

Definition at line 86 of file SCT_ConditionsSummaryTool.h.

86{true};

◆ m_SCTDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> SCT_ConditionsSummaryTool::m_SCTDetEleCollKey {this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"}

private

Definition at line 77 of file SCT_ConditionsSummaryTool.h.

78{this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"};

◆ m_SCTDetElStatusCondKey

SG::ReadCondHandleKey<InDet::SiDetectorElementStatus> SCT_ConditionsSummaryTool::m_SCTDetElStatusCondKey {this, "SCTDetElStatusCondDataBaseKey", "" , "Optional conditions data key of an input SiDetectorElementStatus on which the newly created object will be based."}

private

Definition at line 81 of file SCT_ConditionsSummaryTool.h.

82{this, "SCTDetElStatusCondDataBaseKey", "" , "Optional conditions data key of an input SiDetectorElementStatus on which the newly created object will be based."};

◆ m_SCTDetElStatusEventKey

SG::ReadHandleKey<InDet::SiDetectorElementStatus> SCT_ConditionsSummaryTool::m_SCTDetElStatusEventKey {this, "SCTDetElStatusEventDataBaseKey", "", "Optional event data key of an input SiDetectorElementStatus on which the newly created object will be based."}

private

Definition at line 79 of file SCT_ConditionsSummaryTool.h.

80{this, "SCTDetElStatusEventDataBaseKey", "", "Optional event data key of an input SiDetectorElementStatus on which the newly created object will be based."};

◆ m_toolHandles

ToolHandleArray<ISCT_ConditionsTool> SCT_ConditionsSummaryTool::m_toolHandles {this, "ConditionsTools", {},""}

private

Definition at line 75 of file SCT_ConditionsSummaryTool.h.

76{this, "ConditionsTools", {},""};

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCT_ConditionsSummaryTool()

◆ ~SCT_ConditionsSummaryTool()

Member Function Documentation

◆ activeFraction()

◆ createDetectorElementStatus()

◆ getBSErrorWord() [1/2]

◆ getBSErrorWord() [2/2]

◆ getCacheEntryOut()

◆ getDetectorElementStatus()

◆ goodFraction()

◆ hasBSError() [1/2]

◆ hasBSError() [2/2]

◆ initialize()

◆ isActive() [1/3]

◆ isActive() [2/3]

◆ isActive() [3/3]

◆ isGood() [1/3]

◆ isGood() [2/3]

◆ isGood() [3/3]

Member Data Documentation

◆ m_id_sct

◆ m_noReports

◆ m_SCTDetEleCollKey

◆ m_SCTDetElStatusCondKey

◆ m_SCTDetElStatusEventKey

◆ m_toolHandles