StripClusteringTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ACTSTRK_DATAPREPARATION_STRIP_CLUSTERING_TOOL_H
#define ACTSTRK_DATAPREPARATION_STRIP_CLUSTERING_TOOL_H
 
#include <optional>
#include <vector>
 
#include <Acts/Clusterization/Clusterization.hpp>
 
#include <AthenaBaseComps/AthAlgTool.h>
#include <ActsToolInterfaces/IStripClusteringTool.h>
#include <InDetConditionsSummaryService/IInDetConditionsTool.h>
#include <InDetIdentifier/SCT_ID.h>
#include <InDetRawData/InDetRawDataCollection.h>
#include <InDetRawData/SCT_RDORawData.h>
#include <InDetReadoutGeometry/SiDetectorElement.h>
#include <InDetReadoutGeometry/SiDetectorElementStatus.h>
#include <xAODInDetMeasurement/StripClusterContainer.h>
 
namespace ActsTrk {
 
 
class StripClusteringTool : public extends<AthAlgTool, IStripClusteringTool> {
public:
 
    using StripRDORawData = SCT_RDORawData;
    using StripID = SCT_ID;
 
    struct Cell {
    size_t index;
    Identifier id;
    std::bitset<3> timeBits;
    Acts::Ccl::Label label{Acts::Ccl::NO_LABEL}; // required by ACTS
 
    Cell(size_t i, Identifier id, const std::bitset<3>& timeBits)
        : index(i), id(id), timeBits(timeBits) {}
    };
 
    struct Cluster {
    std::vector<Identifier> ids;
    uint16_t hitsInThirdTimeBin{0};
    };
 
    using CellCollection = std::vector<Cell>;
    using ClusterCollection = std::vector<Cluster>;
 
    StripClusteringTool(const std::string& type,
            const std::string& name,
            const IInterface* parent);
 
    virtual StatusCode initialize() override;
 
    virtual StatusCode
    clusterize(const InDetRawDataCollection<StripRDORawData>& RDOs,
           const StripID& stripID,
           const EventContext& ctx,
           xAOD::StripClusterContainer& container) const override;
 
private:
 
    bool passTiming(const std::bitset<3>& timePattern) const;
    
    StatusCode decodeTimeBins();
 
    std::optional<std::pair<std::vector<Cell>, bool>>
    unpackRDOs(const InDetRawDataCollection<StripRDORawData>& RDOs,
           const StripID& idHelper,
           const InDet::SiDetectorElementStatus *sctDetElStatus,
         const EventContext& ctx) const;
 
    bool isBadStrip(const EventContext& ctx,
        const InDet::SiDetectorElementStatus *sctDetElStatus,
            const StripID& idHelper,
            IdentifierHash waferHash,
            Identifier stripId) const;
 
    // N.B. the cluster is added to the container
    StatusCode makeCluster(const StripClusteringTool::Cluster &cluster,
               double LorentzShift,
               Eigen::Matrix<float,1,1>& localCov,
               const StripID& stripID,
               const InDetDD::SiDetectorElement* element,
               const InDetDD::SiDetectorDesign& design,
               xAOD::StripCluster& container) const;
 
    const InDet::SiDetectorElementStatus *getStripDetElStatus(const EventContext& ctx) const;
 
    StringProperty m_timeBinStr{this, "timeBins", ""};
 
    ToolHandle<ISiLorentzAngleTool> m_lorentzAngleTool {this, "LorentzAngleTool", "",
      "Tool to retreive Lorentz angle of Si detector module"
    };
 
    // TODO this one should be removed?
    SG::ReadHandleKey<InDet::SiDetectorElementStatus> m_stripDetElStatus {this, "StripDetElStatus", "",
      "SiDetectorElementStatus for strip"};
 
    ToolHandle<IInDetConditionsTool> m_conditionsTool {this, "conditionsTool", "",
      "Conditions summary tool"};
 
    Gaudi::Property<bool> m_checkBadModules {this, "checkBadModules", true,
      "Check bad modules using the conditions summary tool"};
 
    Gaudi::Property<unsigned int> m_maxFiredStrips {this, "maxFiredStrips", 384u,
      "Threshold of number of fired strips per wafer. 0 disables the per-wafer cut."};
 
    SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> m_stripDetEleCollKey {this, "StripDetEleCollKey", "ITkStripDetectorElementCollection",
      "SiDetectorElementCollection key for strip"};
 
    int m_timeBinBits[3]{-1, -1, -1};
 
};
 
} // namespace ActsTrk
 
#endif