ActsTrk::StripClusteringTool Class Reference

#include <StripClusteringTool.h>

Inheritance diagram for ActsTrk::StripClusteringTool:

Collaboration diagram for ActsTrk::StripClusteringTool:

Public Types
using	StripRDORawData = SCT_RDORawData
using	StripID = SCT_ID

Public Member Functions
	StripClusteringTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	clusterize (const EventContext &ctx, const InDetRawDataCollection< StripRDORawData > &RDOs, const InDet::SiDetectorElementStatus &stripDetElStatus, const InDetDD::SiDetectorElement &element, Acts::Ccl::ClusteringData &data, std::vector< typename IStripClusteringTool::ClusterCollection > &collection) const override
virtual std::any	makeVars (SG::AuxVectorData &) const override
virtual StatusCode	makeClusters (const EventContext &ctx, typename IStripClusteringTool::ClusterCollection &cluster, const InDetDD::SiDetectorElement &element, size_t icluster, std::any &vars, typename ClusterContainer::iterator itrContainer) const override

Private Member Functions
std::optional< std::pair< typename IStripClusteringTool::CellCollection, bool > >	unpackRDOs (const EventContext &ctx, const RawDataCollection &RDOs, const InDet::SiDetectorElementStatus &stripDetElStatus, const InDetDD::SiDetectorElement &element) const
bool	passTiming (const std::bitset< 3 > &timePattern) const
StatusCode	decodeTimeBins ()
bool	isBadStrip (const EventContext &ctx, const InDet::SiDetectorElementStatus *sctDetElStatus, const StripID &idHelper, IdentifierHash waferHash, Identifier stripId) const
StatusCode	makeCluster (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

Private Attributes
StringProperty	m_timeBinStr {this, "timeBins", ""}
ToolHandle< ISiLorentzAngleTool >	m_lorentzAngleTool
SG::ReadHandleKey< InDet::SiDetectorElementStatus >	m_stripDetElStatus
ToolHandle< IInDetConditionsTool >	m_conditionsTool
Gaudi::Property< bool >	m_checkBadModules
Gaudi::Property< unsigned int >	m_maxFiredStrips
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_stripDetEleCollKey
Gaudi::Property< bool >	m_isITk
Gaudi::Property< unsigned int >	m_errorStrategy {this, "errorStrategy", 0, "Use different error strategies for the strip clusters"}
int	m_timeBinBits [3] {-1, -1, -1}
const StripID *	m_stripID {nullptr}

Detailed Description

Definition at line 26 of file StripClusteringTool.h.

Member Typedef Documentation

StripID

using ActsTrk::StripClusteringTool::StripID = SCT_ID

Definition at line 29 of file StripClusteringTool.h.

StripRDORawData

using ActsTrk::StripClusteringTool::StripRDORawData = SCT_RDORawData

Definition at line 28 of file StripClusteringTool.h.

Constructor & Destructor Documentation

StripClusteringTool()

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

Definition at line 49 of file StripClusteringTool.cxx.

    : base_class(type,name,parent)
{
}

Member Function Documentation

clusterize()

StatusCode ActsTrk::StripClusteringTool::clusterize ( const EventContext & ctx, const InDetRawDataCollection< StripRDORawData > & RDOs, const InDet::SiDetectorElementStatus & stripDetElStatus, const InDetDD::SiDetectorElement & element, Acts::Ccl::ClusteringData & data, std::vector< typename IStripClusteringTool::ClusterCollection > & collection ) const

overridevirtual

Definition at line 99 of file StripClusteringTool.cxx.

{
    IdentifierHash idHash = RDOs.identifyHash();
    // At least an empty cluster collection needs to be always added because the
    // assumption is that there is one element per element RawDataCollection.
    collection.emplace_back();
    bool goodModule = true;
    if (m_checkBadModules.value()) {
      goodModule = stripDetElStatus.isGood(idHash);
    }
 
    VALIDATE_STATUS_ARRAY(
      m_checkBadModules.value() && !m_stripDetElStatus.empty(),
      stripDetElStatus.isGood(idHash), m_conditionsTool->isGood(idHash));
 
    if (!goodModule) {
      ATH_MSG_DEBUG("Strip module failed status check");
      return StatusCode::SUCCESS;
    }
    
    // If more than a certain number of RDOs set module to bad
    // in this case we skip clusterization
    if (m_maxFiredStrips != 0u) {
      unsigned int nFiredStrips = 0u;
      for (const SCT_RDORawData* rdo : RDOs) {
        nFiredStrips += rdo->getGroupSize();
      }
      if (nFiredStrips > m_maxFiredStrips)
    return StatusCode::SUCCESS;
    }
        
    std::optional<std::pair<typename IStripClusteringTool::CellCollection,bool>> unpckd
      = unpackRDOs(ctx, RDOs, stripDetElStatus, element);
 
    if (not unpckd.has_value()) {
    ATH_MSG_FATAL("Error encountered while unpacking strip RDOs!");
    return StatusCode::FAILURE;
    }
 
    auto& [cells, badStripOnModule] = *unpckd;
    // Bad strips on a module invalidates the hitsInThirdTimeBin word.
    // Therefore set it to 0 if that's the case.
    // We are currently not using this, but keeping it here should we need it in the future
 
    Acts::Ccl::createClusters<CellCollection, typename IStripClusteringTool::ClusterCollection, 1>(data, cells, collection.back());
 
    return StatusCode::SUCCESS;
}

decodeTimeBins()

StatusCode ActsTrk::StripClusteringTool::decodeTimeBins ( )

private

Definition at line 79 of file StripClusteringTool.cxx.

{
    for (size_t i = 0; i < m_timeBinStr.size(); i++) {
    if (i >= 3) {
        ATH_MSG_WARNING("Time bin string has excess characters");
        break;
    }
    switch (std::toupper(m_timeBinStr[i])) {
    case 'X': m_timeBinBits[i] = -1; break;
    case '0': m_timeBinBits[i] =  0; break;
    case '1': m_timeBinBits[i] =  1; break;
    default:
        ATH_MSG_FATAL("Invalid time bin string: " << m_timeBinStr);
        return StatusCode::FAILURE;
    }
    }
    return StatusCode::SUCCESS;
}

initialize()

StatusCode ActsTrk::StripClusteringTool::initialize ( )

overridevirtual

Definition at line 55 of file StripClusteringTool.cxx.

{
    ATH_MSG_DEBUG("Initializing " << name() << "...");
 
    ATH_MSG_DEBUG(m_stripDetElStatus);
    ATH_MSG_DEBUG(m_checkBadModules);
    ATH_MSG_DEBUG(m_maxFiredStrips);
    ATH_MSG_DEBUG(m_stripDetEleCollKey);
    ATH_MSG_DEBUG(m_isITk);
    ATH_MSG_DEBUG(m_errorStrategy);
 
 
    ATH_CHECK(m_conditionsTool.retrieve(DisableTool{!m_stripDetElStatus.empty()} ));
    ATH_CHECK(m_lorentzAngleTool.retrieve());
    ATH_CHECK(decodeTimeBins());    
 
    ATH_CHECK(m_stripDetElStatus.initialize(not m_stripDetElStatus.empty()));
    ATH_CHECK(m_stripDetEleCollKey.initialize());
 
    ATH_CHECK( detStore()->retrieve(m_stripID, "SCT_ID") );
    
    return StatusCode::SUCCESS;
}

isBadStrip()

bool ActsTrk::StripClusteringTool::isBadStrip ( const EventContext & ctx, const InDet::SiDetectorElementStatus * sctDetElStatus, const StripID & idHelper, IdentifierHash waferHash, Identifier stripId ) const

private

Definition at line 365 of file StripClusteringTool.cxx.

{
    if (stripDetElStatus) {
        const int strip_i{stripID.strip(stripId)};
    VALIDATE_STATUS_ARRAY(
        stripDetElStatus,
        stripDetElStatus->isCellGood(waferHash.value(), strip_i),
        m_conditionsTool->isGood(stripId, InDetConditions::SCT_STRIP));
    return not stripDetElStatus->isCellGood(waferHash.value(), strip_i) ;
    }
    return not m_conditionsTool->isGood(stripId, InDetConditions::SCT_STRIP, ctx);
}

makeCluster()

StatusCode ActsTrk::StripClusteringTool::makeCluster ( 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

private

Definition at line 300 of file StripClusteringTool.cxx.

{
    std::size_t size = cluster.ids.size();
    
    auto [localPos, globalPos]
      = computePosition(cluster, size, lorentzShift, stripID, element, design, m_isITk);
 
    // For Strip Clusters the identifier is taken from the front rod list object
    // This is the same strategy used in Athena:
    // Since clusterId is arbitary (it only needs to be unique) just use ID of first strip
    // For strip Cluster it has been found that "identifierOfPosition" does not produces unique values
 
 
    // If requiring broad errors, use the cluster size as error -
    // TODO use SiWidth to get the right cluster size as I'm assuming equal strip pitch
    
    if (m_errorStrategy == 1)   {// use width
      
      localCov *= size*size;
      
    } else if (m_errorStrategy == 2) { //use tuned error as function of size
      
      if (size == 1)
        localCov *= oneStripSF;
      else if (size == 2)
        localCov *= twoStripSF*size*size;
      else
        localCov *= size*size;
      
    }
 
    if (not m_isITk) {
      localCov(0,0) = computeRotatedLocalCov(localCov(0,0), element, design, cluster, size, stripID, localPos(0,0));
    }
 
    cl.setMeasurement<1>(element.identifyHash(), localPos, localCov);
    cl.setIdentifier( cluster.ids.front() );
 
    // Do I really need the global position in fast tracking?
    cl.globalPosition() = globalPos;     
    
    cl.setChannelsInPhi(size);
    cl.setRDOlist(std::move(cluster.ids));
    
    return StatusCode::SUCCESS;
}

makeClusters()

StatusCode ActsTrk::StripClusteringTool::makeClusters ( const EventContext & ctx, typename IStripClusteringTool::ClusterCollection & cluster, const InDetDD::SiDetectorElement & element, size_t icluster, std::any & vars, typename ClusterContainer::iterator itrContainer ) const

overridevirtual

Definition at line 155 of file StripClusteringTool.cxx.

{
    const IdentifierHash idHash = element.identifyHash();
    double lorentzShift = m_lorentzAngleTool->getLorentzShift(idHash, ctx);
 
    const InDetDD::SiDetectorDesign& design = element.design();
    // get the pitch, this will be the local covariance for the cluster
 
    assert((not m_isITk) || element.isBarrel() ||  dynamic_cast<const InDetDD::StripStereoAnnulusDesign*>(&element.design()) !=nullptr);
    float pitch = (element.isBarrel() or (not m_isITk))
      ? design.phiPitch()
      : static_cast<const InDetDD::StripStereoAnnulusDesign&>(element.design()).phiPitchPhi();
    Eigen::Matrix<float,1,1> localCov(pitch * pitch * ONE_TWELFTH);
 
    for (typename IStripClusteringTool::Cluster& cl : clusters) {
      try {
    xAOD::StripCluster *xaodCluster = *itrContainer;
    ATH_CHECK(makeCluster(cl,
                  lorentzShift,
                  localCov,
                  *m_stripID,
                  element,
                  design,
                  *xaodCluster));
    ++itrContainer;
      } catch (const std::exception& e) {
    ATH_MSG_FATAL("Exception thrown while creating xAOD::StripCluster:"
              << e.what());
    ATH_MSG_FATAL("Detector Element identifier: " << element.identify());
    ATH_MSG_FATAL("Strip Identifiers in cluster:");
    for (const auto& id : cl.ids)
      ATH_MSG_FATAL("  " << id);
    return StatusCode::FAILURE;
      }
    }
 
    return StatusCode::SUCCESS;
}

makeVars()

virtual std::any ActsTrk::StripClusteringTool::makeVars ( SG::AuxVectorData & ) const

inlineoverridevirtual

Definition at line 45 of file StripClusteringTool.h.

    { return std::any(); }

passTiming()

bool ActsTrk::StripClusteringTool::passTiming ( const std::bitset< 3 > & timePattern ) const

private

Definition at line 354 of file StripClusteringTool.cxx.

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

unpackRDOs()

std::optional< std::pair< typename IStripClusteringTool::CellCollection, bool > > ActsTrk::StripClusteringTool::unpackRDOs ( const EventContext & ctx, const RawDataCollection & RDOs, const InDet::SiDetectorElementStatus & stripDetElStatus, const InDetDD::SiDetectorElement & element ) const

private

Definition at line 384 of file StripClusteringTool.cxx.

{
     const InDetDD::SiDetectorDesign& design = element.design();
  
     CellCollection cells;
     // reserve memory. number evaluated on ttbar pu200
     cells.reserve(60);
     bool badStripOnModule{false};
     //Check type in debug build otherwise assume it is correct
     assert(dynamic_cast<const InDetDD::SCT_ModuleSideDesign*>(&design)!=nullptr);
     std::size_t ncells = static_cast<size_t>(static_cast<const InDetDD::SCT_ModuleSideDesign&>(design).cells());
     
     // Simple single-entry cache
    Identifier::value_type waferId_compact_cache = 0;
    IdentifierHash waferHash_cache(0);
    bool cache_valid = false;
 
    for (const StripRDORawData * raw : RDOs) {
 
        //Check type in debug build otherwise assume it is correct
        assert(static_cast<const SCT3_RawData*>(raw)!=nullptr);
    const SCT3_RawData* raw3 = static_cast<const SCT3_RawData*>(raw);
 
    std::bitset<3> timePattern(raw3->getTimeBin());
    if (!passTiming(timePattern)) {
        ATH_MSG_DEBUG("Strip failed timing check");
        continue;
    }
 
    Identifier firstStripId = raw->identify();
    Identifier waferId = m_stripID->wafer_id(firstStripId);
 
    Identifier::value_type waferId_compact = waferId.get_compact();
 
    
    // Check cache - will be invalid when switching wafer groups
    if (!cache_valid || waferId_compact != waferId_compact_cache) {
      waferId_compact_cache = waferId_compact;
      waferHash_cache = m_stripID->wafer_hash(waferId);
      cache_valid = true;
    }
    
    std::size_t iFirstStrip = static_cast<size_t>(m_stripID->strip(firstStripId));
 
    std::size_t iMaxStrip = std::min(
        iFirstStrip + raw->getGroupSize(),
        ncells
        );
    
    for (size_t i = iFirstStrip; i < iMaxStrip; i++) {
        Identifier stripIdent = m_stripID->strip_id(waferId, i);
        if (isBadStrip(ctx, &stripDetElStatus, *m_stripID, waferHash_cache, stripIdent)) {
        // Bad strip, throw it out to minimize useless work.
        ATH_MSG_DEBUG("Bad strip encountered:" << stripIdent
                  << ", wafer is: " << waferId);
        badStripOnModule = true;
        } else {
        // Good strip!
        cells.emplace_back(i, stripIdent, std::move(timePattern));
        }
    }
    }
 
    return std::make_pair(std::move(cells), badStripOnModule);
}

Member Data Documentation

m_checkBadModules

Gaudi::Property<bool> ActsTrk::StripClusteringTool::m_checkBadModules

private

Initial value:

{this, "checkBadModules", true,
      "Check bad modules using the conditions summary tool"}

Definition at line 95 of file StripClusteringTool.h.

                                          {this, "checkBadModules", true,
      "Check bad modules using the conditions summary tool"};

m_conditionsTool

ToolHandle<IInDetConditionsTool> ActsTrk::StripClusteringTool::m_conditionsTool

private

Initial value:

{this, "conditionsTool", "",
      "Conditions summary tool"}

Definition at line 92 of file StripClusteringTool.h.

                                                      {this, "conditionsTool", "",
      "Conditions summary tool"};

m_errorStrategy

Gaudi::Property<unsigned int> ActsTrk::StripClusteringTool::m_errorStrategy {this, "errorStrategy", 0, "Use different error strategies for the strip clusters"}

private

Definition at line 107 of file StripClusteringTool.h.

{this, "errorStrategy", 0, "Use different error strategies for the strip clusters"};

m_isITk

Gaudi::Property<bool> ActsTrk::StripClusteringTool::m_isITk

private

Initial value:

{this, "isITk", true,
      "True if running in ITk"}

Definition at line 104 of file StripClusteringTool.h.

                                {this, "isITk", true,
      "True if running in ITk"};

m_lorentzAngleTool

ToolHandle<ISiLorentzAngleTool> ActsTrk::StripClusteringTool::m_lorentzAngleTool

private

Initial value:

{this, "LorentzAngleTool", "",
      "Tool to retreive Lorentz angle of Si detector module"
    }

Definition at line 84 of file StripClusteringTool.h.

                                                       {this, "LorentzAngleTool", "",
      "Tool to retreive Lorentz angle of Si detector module"
    };

m_maxFiredStrips

Gaudi::Property<unsigned int> ActsTrk::StripClusteringTool::m_maxFiredStrips

private

Initial value:

{this, "maxFiredStrips", 384u,
      "Threshold of number of fired strips per wafer. 0 disables the per-wafer cut."}

Definition at line 98 of file StripClusteringTool.h.

                                                 {this, "maxFiredStrips", 384u,
      "Threshold of number of fired strips per wafer. 0 disables the per-wafer cut."};

m_stripDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> ActsTrk::StripClusteringTool::m_stripDetEleCollKey

private

Initial value:

{this, "StripDetEleCollKey", "ITkStripDetectorElementCollection",
      "SiDetectorElementCollection key for strip"}

Definition at line 101 of file StripClusteringTool.h.

                                                                                 {this, "StripDetEleCollKey", "ITkStripDetectorElementCollection",
      "SiDetectorElementCollection key for strip"};

m_stripDetElStatus

SG::ReadHandleKey<InDet::SiDetectorElementStatus> ActsTrk::StripClusteringTool::m_stripDetElStatus

private

Initial value:

{this, "StripDetElStatus", "",
      "SiDetectorElementStatus for strip"}

Definition at line 89 of file StripClusteringTool.h.

                                                                     {this, "StripDetElStatus", "",
      "SiDetectorElementStatus for strip"};

m_stripID

const StripID* ActsTrk::StripClusteringTool::m_stripID {nullptr}

private

Definition at line 112 of file StripClusteringTool.h.

{nullptr};

m_timeBinBits

int ActsTrk::StripClusteringTool::m_timeBinBits[3] {-1, -1, -1}

private

Definition at line 109 of file StripClusteringTool.h.

{-1, -1, -1};

m_timeBinStr

StringProperty ActsTrk::StripClusteringTool::m_timeBinStr {this, "timeBins", ""}

private

Definition at line 82 of file StripClusteringTool.h.

{this, "timeBins", ""};

---

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

• StripClusteringTool.h
• StripClusteringTool.cxx