Form clusters from SCT Raw Data Objects. The class loops over an RDO grouping strips and creating collections of clusters, subsequently recorded in StoreGate using WriteHandle(Key). Uses SCT_ConditionsTools to determine which strips to include. More...

#include <SCT_Clusterization.h>

Inheritance diagram for InDet::SCT_Clusterization:

Collaboration diagram for InDet::SCT_Clusterization:

Public Member Functions
	SCT_Clusterization (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Usual algorithm methods
virtual StatusCode	initialize () override
	Retrieve the tools used and initialize handle keys. More...

virtual StatusCode	execute (const EventContext &ctx) const override
	Form clusters and record them in StoreGate by WriteHandle. More...

virtual StatusCode	finalize () override
	Finalize (nothing done actually) More...

virtual bool	isClonable () const override
	Make this algorithm clonable. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Disallow default instantiation, copy, assignment
	SCT_Clusterization ()=delete

	SCT_Clusterization (const SCT_Clusterization &)=delete

SCT_Clusterization &	operator= (const SCT_Clusterization &)=delete

Private Attributes
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Service and Tool Handles and ID helper
ToolHandle< IRegSelTool >	m_regionSelector {this, "RegSelTool", "RegSelTool/RegSel_SCT", "region selector tool for HLT"}

ToolHandle< ISCT_ClusteringTool >	m_clusteringTool {this, "clusteringTool", "InDet::SCT_ClusteringTool"}

ToolHandle< IInDetConditionsTool >	m_pSummaryTool {this, "conditionsTool", "SCT_ConditionsSummaryTool/InDetSCT_ConditionsSummaryTool", "Tool to retrieve SCT conditions summary"}

ToolHandle< GenericMonitoringTool >	m_monTool { this, "MonTool", "", "Monitoring tool" }

const SCT_ID *	m_idHelper {nullptr}

Read, Write and Update HandleKeys
StoreGate accesses in AthenaMT way
SG::ReadHandleKey< TrigRoiDescriptorCollection >	m_roiCollectionKey {this, "RoIs", "", "RoIs to read in"}

SG::ReadHandleKey< SCT_RDO_Container >	m_rdoContainerKey {this, "DataObjectName", "SCT_RDOs", "SCT RDOs"}

SG::WriteHandleKey< SCT_ClusterContainer >	m_clusterContainerKey {this, "ClustersName", "SCT_Clusters", "SCT cluster container"}

SG::WriteHandleKey< SiClusterContainer >	m_clusterContainerLinkKey {this, "ClustersLinkName_", "SCT_Clusters", "SCT cluster container link name (don't set this)"}

SG::WriteHandleKey< IDCInDetBSErrContainer >	m_flaggedCondDataKey {this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"}

SG::UpdateHandleKey< SCT_ClusterContainerCache >	m_clusterContainerCacheKey
	For HLT cache. More...

SG::UpdateHandleKey< IDCInDetBSErrContainer_Cache >	m_flaggedCondCacheKey
	For HLT cache. More...

SG::ReadHandleKey< InDet::SiDetectorElementStatus >	m_sctDetElStatus {this, "SCTDetElStatus", "", "Key of SiDetectorElementStatus for SCT"}
	Optional read handle to get status data to test whether a SCT detector element is good. More...

Flags to configure SCT_Clusterization
UnsignedIntegerProperty	m_maxFiredStrips {this, "maxFiredStrips", 384, "Threshold of number of fired strips per wafer, to mask noisy modules. 0 disables the per-wafer cut."}

UnsignedIntegerProperty	m_maxTotalOccupancyPercent {this, "maxTotalOccupancyInPercent", 100, "Threshold of percentage of fired strips for the whole SCT. 100 disables the whole SCT cut."}

BooleanProperty	m_roiSeeded {this, "isRoI_Seeded", false, "Use RoI"}

BooleanProperty	m_checkBadModules {this, "checkBadModules", true, "Flag to check bad modules using InDetSCT_ConditionsSummaryTool"}

Gaudi::Property< bool >	m_useDataPoolWithCache

Detailed Description

Form clusters from SCT Raw Data Objects. The class loops over an RDO grouping strips and creating collections of clusters, subsequently recorded in StoreGate using WriteHandle(Key). Uses SCT_ConditionsTools to determine which strips to include.

Definition at line 53 of file SCT_Clusterization.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SCT_Clusterization() [1/3]

InDet::SCT_Clusterization::SCT_Clusterization	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor with parameters:

Definition at line 30 of file SCT_Clusterization.cxx.

                                                                                         :
     AthReentrantAlgorithm(name, pSvcLocator)
   {
     // Get parameter values from jobOptions file
     declareProperty("ClusterContainerCacheKey", m_clusterContainerCacheKey="");
     declareProperty("FlaggedCondCacheKey", m_flaggedCondCacheKey="");
   }

◆ SCT_Clusterization() [2/3]

InDet::SCT_Clusterization::SCT_Clusterization ( )

privatedelete

◆ SCT_Clusterization() [3/3]

InDet::SCT_Clusterization::SCT_Clusterization ( const SCT_Clusterization & )

privatedelete

Member Function Documentation

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode InDet::SCT_Clusterization::execute ( const EventContext & ctx ) const

overridevirtual

Form clusters and record them in StoreGate by WriteHandle.

Definition at line 82 of file SCT_Clusterization.cxx.

                                                                       {
     //Monitoring Tool Configuration
     auto mnt_timer_Total                 = Monitored::Timer<std::chrono::milliseconds>("TIME_Total");
     auto mnt_timer_SummaryTool           = Monitored::Timer<std::chrono::milliseconds>("TIME_SummaryTool");
     auto mnt_timer_Clusterize            = Monitored::Timer<std::chrono::milliseconds>("TIME_Clusterize");
     // Register the IdentifiableContainer into StoreGate
     SG::WriteHandle<SCT_ClusterContainer> clusterContainer{m_clusterContainerKey, ctx};
     if (m_clusterContainerCacheKey.key().empty()) {
       ATH_CHECK(clusterContainer.record(std::make_unique<SCT_ClusterContainer>(m_idHelper->wafer_hash_max(), EventContainers::Mode::OfflineFast)));
     } else {
       SG::UpdateHandle<SCT_ClusterContainerCache> clusterContainercache{m_clusterContainerCacheKey, ctx};
       ATH_CHECK(clusterContainer.record(std::make_unique<SCT_ClusterContainer>(clusterContainercache.ptr())));
     }
     ATH_MSG_DEBUG("Container '" << clusterContainer.name() << "' initialised");
  
     ATH_CHECK(clusterContainer.symLink(m_clusterContainerLinkKey));
     ATH_CHECK(clusterContainer.isValid());
     ATH_MSG_DEBUG("SCT clusters '" << clusterContainer.name() << "' symlinked in StoreGate");
  
     SG::WriteHandle<IDCInDetBSErrContainer> flaggedCondData{m_flaggedCondDataKey, ctx};
     if (m_flaggedCondCacheKey.key().empty()) {
       ATH_CHECK(flaggedCondData.record( std::make_unique<IDCInDetBSErrContainer>(m_idHelper->wafer_hash_max(), std::numeric_limits<IDCInDetBSErrContainer::ErrorCode>::min())));
       ATH_MSG_DEBUG("Created IDCInDetBSErrContainer w/o using external cache");
     } else {
       SG::UpdateHandle<IDCInDetBSErrContainer_Cache> flaggedCondCacheHandle(m_flaggedCondCacheKey, ctx);
       ATH_CHECK(flaggedCondCacheHandle.isValid() );
       ATH_CHECK(flaggedCondData.record( std::make_unique<IDCInDetBSErrContainer>(flaggedCondCacheHandle.ptr())) );
       ATH_MSG_DEBUG("Created SCT IDCInDetBSErrContainer using external cache");
     }
     std::unordered_map<IdentifierHash, IDCInDetBSErrContainer::ErrorCode> flaggedCondMap; // temporary store of flagged condition error
  
     // First, we have to retrieve and access the container, not because we want to
     // use it, but in order to generate the proxies for the collections, if they
     // are being provided by a container converter.
     SG::ReadHandle<SCT_RDO_Container> rdoContainer{m_rdoContainerKey, ctx};
     ATH_CHECK(rdoContainer.isValid());
  
     // Anything to dereference the DataHandle will trigger the converter
     SCT_RDO_Container::const_iterator rdoCollections{rdoContainer->begin()};
     SCT_RDO_Container::const_iterator rdoCollectionsEnd{rdoContainer->end()};
     bool dontDoClusterization{false};
     //new code to remove large numbers of hits (what is large?)
     if (m_maxTotalOccupancyPercent.value()!=100) {
       constexpr unsigned int totalNumberOfChannels{6279168};
       const unsigned int maxAllowableStrips{(totalNumberOfChannels*m_maxTotalOccupancyPercent.value())/100};//integer arithmetic, should be ok
       unsigned int totalFiredStrips{0};
       for (; rdoCollections != rdoCollectionsEnd; ++rdoCollections) {
         for (const SCT_RDORawData* rdo: **rdoCollections) {
           totalFiredStrips += rdo->getGroupSize();
         }
       } //iterator is now at the end
       //reset the iterator
       rdoCollections = rdoContainer->begin();
       if (totalFiredStrips > maxAllowableStrips) {
         ATH_MSG_WARNING("This event has too many hits in the SCT: " << totalFiredStrips << " > " << maxAllowableStrips);
         dontDoClusterization = true;
       }
     }
     SG::ReadHandle<InDet::SiDetectorElementStatus> sctDetElStatus;
     if (!m_sctDetElStatus.empty()) {
        sctDetElStatus=SG::ReadHandle<InDet::SiDetectorElementStatus>(m_sctDetElStatus, ctx);
        ATH_CHECK( sctDetElStatus.isValid() ? StatusCode::SUCCESS : StatusCode::FAILURE);
     }
  
     if (not dontDoClusterization) {
        std::unique_ptr<DataPool<SCT_Cluster>> dataItemsPool = nullptr;
        const bool hasExternalCache = rdoContainer->hasExternalCache();
        if (!hasExternalCache) {
         dataItemsPool = std::make_unique<DataPool<SCT_Cluster>>(ctx);
         dataItemsPool->reserve(20000);  // Some large default size
        } else if (m_useDataPoolWithCache) {
         dataItemsPool = std::make_unique<DataPool<SCT_Cluster>>(ctx);
         // this is  per view so let it expand on its own in blocks
        }
        // cache to avoid re-allocation inside the loop.
        // Trying to re-use the vector capacities.
        // we clear them inside the methods we call
  
        SCTClusteringCache cache;
        cache.currentVector.reserve(32);
        cache.idGroups.reserve(16);
        cache.tbinGroups.reserve(16);
        if (not m_roiSeeded.value()) {  // Full-scan mode
  
         for (; rdoCollections != rdoCollectionsEnd; ++rdoCollections) {
           const InDetRawDataCollection<SCT_RDORawData>* rd{*rdoCollections};
           ATH_MSG_DEBUG("RDO collection size=" << rd->size() << ", Hash="
                                                << rd->identifyHash());
           SCT_ClusterContainer::IDC_WriteHandle lock{
               clusterContainer->getWriteHandle(rdoCollections.hashId())};
           if (lock.OnlineAndPresentInAnotherView()) {
             ATH_MSG_DEBUG(
                 "Item already in cache , Hash=" << rd->identifyHash());
             continue;
           }
           bool goodModule{
               m_checkBadModules.value()
                   ? (!m_sctDetElStatus.empty()
                          ? sctDetElStatus->isGood(rd->identifyHash())
                          : m_pSummaryTool->isGood(rd->identifyHash(), ctx))
                   : true};
           VALIDATE_STATUS_ARRAY(
               m_checkBadModules.value() && !m_sctDetElStatus.empty(),
               sctDetElStatus->isGood(rd->identifyHash()),
               m_pSummaryTool->isGood(rd->identifyHash(), ctx));
  
           if (!goodModule) {
             ATH_MSG_DEBUG(" module status is bad");
           }
           // Check the RDO is not empty and that the wafer is good according to
           // the conditions
           if ((not rd->empty()) and goodModule) {
             // If more than a certain number of RDOs set module to bad
             if (m_maxFiredStrips.value()) {
               unsigned int nFiredStrips{0};
               for (const SCT_RDORawData* rdo : *rd) {
                 nFiredStrips += rdo->getGroupSize();
               }
               if (nFiredStrips > m_maxFiredStrips.value()) {
                 // This should work in the case of a new code or existing, since
                 // the default init is 0
                 constexpr int value =
                     (1 << SCT_FlaggedCondEnum::ExceedMaxFiredStrips);
                 auto [pPair, inserted] =
                     flaggedCondMap.insert({rd->identifyHash(), value});
                 if (not inserted) {
                   pPair->second |= value;
                 }
                 continue;
               }
             }
             // Use one of the specific clustering AlgTools to make clusters
             std::unique_ptr<SCT_ClusterCollection> clusterCollection{
                 m_clusteringTool->clusterize(
                     *rd, *m_idHelper,
                     !m_sctDetElStatus.empty() ? sctDetElStatus.cptr() : nullptr,
                     cache, dataItemsPool.get(), ctx)};
             if (clusterCollection) {
               if (not clusterCollection->empty()) {
                 const IdentifierHash hash{clusterCollection->identifyHash()};
                 ATH_CHECK(lock.addOrDelete(std::move(clusterCollection)));
                 ATH_MSG_DEBUG("Clusters with key '"
                               << hash << "' added to Container\n");
               } else {
                 ATH_MSG_DEBUG("Don't write empty collections\n");
               }
             } else {
               ATH_MSG_DEBUG("Clustering algorithm found no clusters\n");
             }
           }
         }
        } else {  // enter RoI-seeded mode
         SG::ReadHandle<TrigRoiDescriptorCollection> roiCollection{
             m_roiCollectionKey, ctx};
         ATH_CHECK(roiCollection.isValid());
         TrigRoiDescriptorCollection::const_iterator roi{roiCollection->begin()};
         TrigRoiDescriptorCollection::const_iterator roiE{roiCollection->end()};
         std::vector<IdentifierHash> listOfSCTIds;
         for (; roi != roiE; ++roi) {
           listOfSCTIds.clear();  // Prevents needless memory reallocations
           m_regionSelector->HashIDList(**roi, listOfSCTIds);
           ATH_MSG_VERBOSE(**roi);
           ATH_MSG_VERBOSE("REGTEST: SCT : Roi contains " << listOfSCTIds.size()
                                                          << " det. Elements");
           for (size_t i{0}; i < listOfSCTIds.size(); i++) {
             IdentifierHash id = listOfSCTIds[i];
             const InDetRawDataCollection<SCT_RDORawData>* RDO_Collection{
                 rdoContainer->indexFindPtr(id)};
             if (RDO_Collection == nullptr){
               continue;
             }
             bool goodModule;
             {
               Monitored::ScopedTimer time_SummaryTool(mnt_timer_SummaryTool);
               goodModule = {m_checkBadModules.value()
                                 ? (!m_sctDetElStatus.empty()
                                        ? sctDetElStatus->isGood(id)
                                        : m_pSummaryTool->isGood(id, ctx))
                                 : true};
               VALIDATE_STATUS_ARRAY(
                   m_checkBadModules.value() && !m_sctDetElStatus.empty(),
                   sctDetElStatus->isGood(id), m_pSummaryTool->isGood(id));
               if (!goodModule){
                 ATH_MSG_VERBOSE("module status flagged as BAD");
               }
             }
             // Check the RDO is not empty and that the wafer is good according
             // to the conditions
             if ((not RDO_Collection->empty()) and goodModule) {
               // If more than a certain number of RDOs set module to bad
               if (m_maxFiredStrips.value()) {
                 unsigned int nFiredStrips{0};
                 for (const SCT_RDORawData* rdo : *RDO_Collection){
                   nFiredStrips += rdo->getGroupSize();
                 }
                 if (nFiredStrips > m_maxFiredStrips.value()) {
                   // This should work in the case of a new code or existing,
                   // since the default init is 0
                   constexpr int value =
                       (1 << SCT_FlaggedCondEnum::ExceedMaxFiredStrips);
                   auto [pPair, inserted] = flaggedCondMap.insert({id, value});
                   if (not inserted) {
                     pPair->second |= value;
                   }
                   continue;
                 }
               }
             }
  
             SCT_ClusterContainer::IDC_WriteHandle lock{
                 clusterContainer->getWriteHandle(listOfSCTIds[i])};
             if (lock.OnlineAndPresentInAnotherView()) {
               ATH_MSG_DEBUG("Item already in cache , Hash=" << listOfSCTIds[i]);
               continue;
             }
  
             // Use one of the specific clustering AlgTools to make clusters
             {
               Monitored::ScopedTimer time_Clusterize(mnt_timer_Clusterize);
               std::unique_ptr<SCT_ClusterCollection> clusterCollection{
                   m_clusteringTool->clusterize(
                       *RDO_Collection, *m_idHelper,
                       !m_sctDetElStatus.empty() ? sctDetElStatus.cptr()
                                                 : nullptr,
                       cache, dataItemsPool.get(), ctx)};
               if (clusterCollection and (not clusterCollection->empty())) {
                 ATH_MSG_VERBOSE("REGTEST: SCT : clusterCollection contains " << clusterCollection->size() << " clusters");
                 ATH_CHECK(lock.addOrDelete(std::move(clusterCollection)));
               } else {
                 ATH_MSG_DEBUG("No SCTClusterCollection to write");
               }
             }
           }
         }
        }
     }
     // Set container to const
     ATH_CHECK(clusterContainer.setConst());
  
     // Fill flaggedCondData
     for (auto [hash, error] : flaggedCondMap) {
       flaggedCondData->setOrDrop(hash, error);
     }
     auto monTime = Monitored::Group(m_monTool, mnt_timer_Total, mnt_timer_Clusterize, mnt_timer_SummaryTool);
     return StatusCode::SUCCESS;
   }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 79 of file AthReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ finalize()

StatusCode InDet::SCT_Clusterization::finalize ( )

overridevirtual

Finalize (nothing done actually)

Definition at line 330 of file SCT_Clusterization.cxx.

   {
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode InDet::SCT_Clusterization::initialize ( )

overridevirtual

Retrieve the tools used and initialize handle keys.

Definition at line 39 of file SCT_Clusterization.cxx.

                                             {
     ATH_MSG_INFO("SCT_Clusterization::initialize()!");
  
     // Get the conditions summary service (continue anyway, just check the pointer
     // later and declare everything to be 'good' if it is nullptr)
     ATH_CHECK( m_pSummaryTool.retrieve( DisableTool{!m_checkBadModules.value() || (!m_sctDetElStatus.empty() && !VALIDATE_STATUS_ARRAY_ACTIVATED)} ) );
  
     m_clusterContainerLinkKey = m_clusterContainerKey.key();
  
     ATH_CHECK(m_rdoContainerKey.initialize());
     ATH_CHECK(m_clusterContainerKey.initialize());
     ATH_CHECK(m_clusterContainerLinkKey.initialize());
     ATH_CHECK(m_clusterContainerCacheKey.initialize(not m_clusterContainerCacheKey.key().empty()));
     ATH_CHECK(m_flaggedCondDataKey.initialize());
     ATH_CHECK(m_flaggedCondCacheKey.initialize(not m_flaggedCondCacheKey.key().empty()));
  
     ATH_CHECK(m_sctDetElStatus.initialize( !m_sctDetElStatus.empty() ));
  
     // Get the clustering tool
     ATH_CHECK(m_clusteringTool.retrieve());
  
     // Get the SCT ID helper
     ATH_CHECK(detStore()->retrieve(m_idHelper, "SCT_ID"));
  
     if (m_roiSeeded.value()) {
       ATH_CHECK(m_roiCollectionKey.initialize());
       ATH_CHECK(m_regionSelector.retrieve());
     } else {
       ATH_CHECK(m_roiCollectionKey.initialize(false));
       m_regionSelector.disable();
     }
  
     if ( !m_monTool.empty() ) {
        ATH_CHECK(m_monTool.retrieve() );
     }
     else {
        ATH_MSG_INFO("Monitoring tool is empty");
     }
  
     return StatusCode::SUCCESS;
   }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

virtual bool InDet::SCT_Clusterization::isClonable ( ) const

inlineoverridevirtual

Make this algorithm clonable.

Reimplemented from AthReentrantAlgorithm.

Definition at line 69 of file SCT_Clusterization.h.

69 { return true; };

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ operator=()

SCT_Clusterization& InDet::SCT_Clusterization::operator= ( const SCT_Clusterization & )

privatedelete

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

 {
   return Gaudi::Algorithm::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                 {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_checkBadModules

BooleanProperty InDet::SCT_Clusterization::m_checkBadModules {this, "checkBadModules", true, "Flag to check bad modules using InDetSCT_ConditionsSummaryTool"}

private

Definition at line 120 of file SCT_Clusterization.h.

◆ m_clusterContainerCacheKey

SG::UpdateHandleKey<SCT_ClusterContainerCache> InDet::SCT_Clusterization::m_clusterContainerCacheKey

private

For HLT cache.

Definition at line 103 of file SCT_Clusterization.h.

◆ m_clusterContainerKey

SG::WriteHandleKey<SCT_ClusterContainer> InDet::SCT_Clusterization::m_clusterContainerKey {this, "ClustersName", "SCT_Clusters", "SCT cluster container"}

private

Definition at line 100 of file SCT_Clusterization.h.

◆ m_clusterContainerLinkKey

SG::WriteHandleKey<SiClusterContainer> InDet::SCT_Clusterization::m_clusterContainerLinkKey {this, "ClustersLinkName_", "SCT_Clusters", "SCT cluster container link name (don't set this)"}

private

Definition at line 101 of file SCT_Clusterization.h.

◆ m_clusteringTool

ToolHandle<ISCT_ClusteringTool> InDet::SCT_Clusterization::m_clusteringTool {this, "clusteringTool", "InDet::SCT_ClusteringTool"}

private

Definition at line 87 of file SCT_Clusterization.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_flaggedCondCacheKey

SG::UpdateHandleKey<IDCInDetBSErrContainer_Cache> InDet::SCT_Clusterization::m_flaggedCondCacheKey

private

For HLT cache.

Definition at line 104 of file SCT_Clusterization.h.

◆ m_flaggedCondDataKey

SG::WriteHandleKey<IDCInDetBSErrContainer> InDet::SCT_Clusterization::m_flaggedCondDataKey {this, "SCT_FlaggedCondData", "SCT_FlaggedCondData", "SCT flagged conditions data"}

private

Definition at line 102 of file SCT_Clusterization.h.

◆ m_idHelper

const SCT_ID* InDet::SCT_Clusterization::m_idHelper {nullptr}

private

Definition at line 90 of file SCT_Clusterization.h.

◆ m_maxFiredStrips

UnsignedIntegerProperty InDet::SCT_Clusterization::m_maxFiredStrips {this, "maxFiredStrips", 384, "Threshold of number of fired strips per wafer, to mask noisy modules. 0 disables the per-wafer cut."}

private

Definition at line 117 of file SCT_Clusterization.h.

◆ m_maxTotalOccupancyPercent

UnsignedIntegerProperty InDet::SCT_Clusterization::m_maxTotalOccupancyPercent {this, "maxTotalOccupancyInPercent", 100, "Threshold of percentage of fired strips for the whole SCT. 100 disables the whole SCT cut."}

private

Definition at line 118 of file SCT_Clusterization.h.

◆ m_monTool

ToolHandle< GenericMonitoringTool > InDet::SCT_Clusterization::m_monTool { this, "MonTool", "", "Monitoring tool" }

private

Definition at line 89 of file SCT_Clusterization.h.

◆ m_pSummaryTool

ToolHandle<IInDetConditionsTool> InDet::SCT_Clusterization::m_pSummaryTool {this, "conditionsTool", "SCT_ConditionsSummaryTool/InDetSCT_ConditionsSummaryTool", "Tool to retrieve SCT conditions summary"}

private

Definition at line 88 of file SCT_Clusterization.h.

◆ m_rdoContainerKey

SG::ReadHandleKey<SCT_RDO_Container> InDet::SCT_Clusterization::m_rdoContainerKey {this, "DataObjectName", "SCT_RDOs", "SCT RDOs"}

private

Definition at line 99 of file SCT_Clusterization.h.

◆ m_regionSelector

ToolHandle<IRegSelTool> InDet::SCT_Clusterization::m_regionSelector {this, "RegSelTool", "RegSelTool/RegSel_SCT", "region selector tool for HLT"}

private

Definition at line 86 of file SCT_Clusterization.h.

◆ m_roiCollectionKey

SG::ReadHandleKey<TrigRoiDescriptorCollection> InDet::SCT_Clusterization::m_roiCollectionKey {this, "RoIs", "", "RoIs to read in"}

private

Definition at line 98 of file SCT_Clusterization.h.

◆ m_roiSeeded

BooleanProperty InDet::SCT_Clusterization::m_roiSeeded {this, "isRoI_Seeded", false, "Use RoI"}

private

Definition at line 119 of file SCT_Clusterization.h.

◆ m_sctDetElStatus

SG::ReadHandleKey<InDet::SiDetectorElementStatus> InDet::SCT_Clusterization::m_sctDetElStatus {this, "SCTDetElStatus", "", "Key of SiDetectorElementStatus for SCT"}

private

Optional read handle to get status data to test whether a SCT detector element is good.

If set to e.g. SCTDetectorElementStatus the event data will be used instead of the SCT conditions summary tool.

Definition at line 110 of file SCT_Clusterization.h.

◆ m_useDataPoolWithCache

Gaudi::Property<bool> InDet::SCT_Clusterization::m_useDataPoolWithCache

private

Initial value:

{

this, "useDataPoolWithCache", false, "use DataPool With Cache"}

Definition at line 121 of file SCT_Clusterization.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SCT_Clusterization() [1/3]

◆ SCT_Clusterization() [2/3]

◆ SCT_Clusterization() [3/3]

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator=()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_checkBadModules

◆ m_clusterContainerCacheKey

◆ m_clusterContainerKey

◆ m_clusterContainerLinkKey

◆ m_clusteringTool

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_flaggedCondCacheKey

◆ m_flaggedCondDataKey

◆ m_idHelper

◆ m_maxFiredStrips

◆ m_maxTotalOccupancyPercent

◆ m_monTool

◆ m_pSummaryTool

◆ m_rdoContainerKey

◆ m_regionSelector

◆ m_roiCollectionKey

◆ m_roiSeeded

◆ m_sctDetElStatus

◆ m_useDataPoolWithCache

◆ m_varHandleArraysDeclared

◆ m_vhka