SCT_ClusteringTool.h

Go to the documentation of this file.

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

#ifndef SiClusterizationTool_SCT_ClusteringTool_H
#define SiClusterizationTool_SCT_ClusteringTool_H

#include "AthenaBaseComps/AthAlgTool.h"
#include "Identifier/Identifier.h"
#include "InDetCondTools/ISiLorentzAngleTool.h"
#include "InDetConditionsSummaryService/IInDetConditionsTool.h"
#include "InDetIdentifier/SCT_ID.h"
#include "InDetReadoutGeometry/SiDetectorElementCollection.h"
#include "InDetReadoutGeometry/SiDetectorElementStatus.h"
#include "SCT_ReadoutGeometry/SCT_ChipUtils.h"
#include "SiClusterizationTool/ClusterMakerTool.h"
#include "SiClusterizationTool/ISCT_ClusteringTool.h"
#include "StoreGate/ReadCondHandleKey.h"

#include "GaudiKernel/ToolHandle.h"

#include <bitset>
#include <string>
#include <vector>
 
class SCT_ChannelStatusAlg;
class StatusCode;
 
namespace InDetDD {
class SCT_ModuleSideDesign;
}
 
namespace InDet {
class SCT_ClusteringTool final
    : public extends<AthAlgTool, ISCT_ClusteringTool> {
 
 using IdVec_t = std::vector<Identifier>;
 public:
  SCT_ClusteringTool(const std::string& type, const std::string& name,
                     const IInterface* parent);
  virtual StatusCode initialize() override;
  virtual ~SCT_ClusteringTool() = default;

  SCT_ClusterCollection* clusterize(
      const InDetRawDataCollection<SCT_RDORawData>& RDOs,
      const SCT_ID& idHelper,
      const InDet::SiDetectorElementStatus* sctDetElementStatus,
      SCTClusteringCache& cache,
      DataPool<SCT_Cluster>* dataItemsPool,
      const EventContext& ctx) const override;

  SCT_ClusterCollection* fastClusterize(
      const InDetRawDataCollection<SCT_RDORawData>& RDOs,
      const SCT_ID& idHelper,
      const InDet::SiDetectorElementStatus* sctDetElementStatus,
      SCTClusteringCache& cache,
      DataPool<SCT_Cluster>* dataItemsPool,
      const EventContext& ctx) const;
 
 private:

  ToolHandle<IInDetConditionsTool> m_conditionsTool{
      this, "conditionsTool",
      "SCT_ConditionsSummaryTool/InDetSCT_ConditionsSummaryTool",
      "Tool to retrieve SCT Conditions summary"};
  ToolHandle<ClusterMakerTool> m_clusterMaker{this, "globalPosAlg",
                                              "InDet::ClusterMakerTool"};
  ToolHandle<ISiLorentzAngleTool> m_lorentzAngleTool{
      this, "LorentzAngleTool", "SiLorentzAngleTool/SCTLorentzAngleTool",
      "Tool to retreive Lorentz angle of SCT"};


  IntegerProperty m_errorStrategy{this, "errorStrategy", 1};
  BooleanProperty m_checkBadChannels{this, "checkBadChannels", true};
  StringProperty m_timeBinStr{this, "timeBins", ""};
  BooleanProperty m_innermostBarrelX1X{this, "innermostBarrelX1X", false};
  BooleanProperty m_innertwoBarrelX1X{this, "innertwoBarrelX1X", false};
  BooleanProperty m_majority01X{this, "majority01X", false};
  BooleanProperty m_useRowInformation{this, "useRowInformation", false};
  BooleanProperty m_doFastClustering{this, "doFastClustering", true};
  BooleanProperty m_doSimplePosWidth{this, "doSimplePositionWidthCalculation", false, "Always use the simpler position and width calculation in fast clustering"};

  SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection>
      m_SCTDetEleCollKey{this, "SCTDetEleCollKey",
                         "SCT_DetectorElementCollection",
                         "Key of SiDetectorElementCollection for SCT. "
                         "Necessary for alignment"};


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

  int m_timeBinBits[3]{-1, -1, -1};

  static void addStripsToCluster(const Identifier& firstStripId,
                                 unsigned int nStrips, IdVec_t& clusterVector,
                                 const SCT_ID& idHelper);

  void addStripsToClusterWithChecks(
      const Identifier& firstStripId, unsigned int nStrips,
      IdVec_t& clusterVector, std::vector<IdVec_t>& idGroups,
      const SCT_ID& idHelper,
      const InDet::SiDetectorElementStatus* det_el_status,
      const EventContext& ctx) const;

  void addStripsToClusterInclRows(
      const Identifier& firstStripId, unsigned int nStrips,
      IdVec_t& clusterVector, std::vector<IdVec_t>& idGroups,
      const SCT_ID& idHelper,
      const InDet::SiDetectorElementStatus* det_el_status,
      const EventContext& ctx) const;

  IdVec_t recluster(IdVec_t& clusterVector,
                    std::vector<IdVec_t>& idGroups) const;

  struct DimensionAndPosition {
    InDetDD::SiLocalPosition centre;
    double width;
    DimensionAndPosition(const InDetDD::SiLocalPosition& c, double w)
        : centre(c), width(w) {}
  };

  static DimensionAndPosition clusterDimensions(
      int firstStrip, int lastStrip, const InDetDD::SiDetectorElement* element,
      const SCT_ID& idHelper);

  static DimensionAndPosition clusterDimensionsInclRow(
      int firstStrip, int lastStrip, int row,
      const InDetDD::SiDetectorElement* element,
      const InDetDD::SCT_ModuleSideDesign* design);

  bool isBad(const InDet::SiDetectorElementStatus* sctDetElStatus,
             const SCT_ID& sctID, const IdentifierHash& waferHash,
             const Identifier& stripId, const EventContext& ctx) const;

  StatusCode decodeTimeBins();
  StatusCode decodeTimeBin(char timeBin, int& bit) const;

  bool testTimeBins(int timeBin) const;
  static bool testTimeBins01X(int timeBin);
  static bool testTimeBinsX1X(int timeBin);
  bool testTimeBinsN(const std::bitset<3>& timePattern) const;
};  // end of class

// Inline methods
 
inline bool SCT_ClusteringTool::isBad(
    const InDet::SiDetectorElementStatus* sctDetElStatus, const SCT_ID& sctID,
    const IdentifierHash& waferHash, const Identifier& stripId,
    const EventContext& ctx) const {
  if (sctDetElStatus) {
    const int strip_i{sctID.strip(stripId)};
    VALIDATE_STATUS_ARRAY(
        sctDetElStatus, sctDetElStatus->isCellGood(waferHash.value(), strip_i),
        m_conditionsTool->isGood(stripId, InDetConditions::SCT_STRIP, ctx));
    return !sctDetElStatus->isCellGood(waferHash.value(), strip_i);
  } else {
    return (
        not m_conditionsTool->isGood(stripId, InDetConditions::SCT_STRIP, ctx));
  }
}
 
inline bool SCT_ClusteringTool::testTimeBinsN(
    const std::bitset<3>& timePattern) const {
  // Convert the given timebin to a bit set and test each bit
  // if bit is -1 (i.e. X) it always passes, other wise require exact match of
  // 0/1 N.B bitset has opposite order to the bit pattern we define
 
  if (m_timeBinBits[0] != -1 and
      timePattern.test(2) != static_cast<bool>(m_timeBinBits[0]))
    return false;
  if (m_timeBinBits[1] != -1 and
      timePattern.test(1) != static_cast<bool>(m_timeBinBits[1]))
    return false;
  if (m_timeBinBits[2] != -1 and
      timePattern.test(0) != static_cast<bool>(m_timeBinBits[2]))
    return false;
  return true;
}
 
}  // namespace InDet
#endif  // SiClusterizationTool_SCT_ClusteringTool_H