ICellClusteringToolBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ACTSTOOLINTERFACES_ICELLCLUSTERINGTOOLBASE_H
#define ACTSTOOLINTERFACES_ICELLCLUSTERINGTOOLBASE_H
 
#include <GaudiKernel/IAlgTool.h>
#include <InDetReadoutGeometry/SiDetectorElement.h>
#include <InDetReadoutGeometry/SiDetectorElementStatus.h>
#include <cstdint>
#include <concepts>
#include <any>
#include <vector>
#include <utility>
 
namespace ActsTrk {
 
template <typename T_RDO_Container>
struct RDOContainerTraits {
   using PerModuleRDOs = typename T_RDO_Container::base_value_type;
};
 
// forward declaration (defintion  Tracking/Acts/ActsDataPreparation/src/details/CellContainer.h)
template <typename coordinates_t, std::size_t NDIM, std::unsigned_integral index_t>
struct CellContainer;
 
template <typename T_RDO_Container, typename T_OutputContainer, std::size_t NDIM, std::integral coordinate_t=std::int16_t>
class ICellClusteringToolBase : virtual public IAlgTool {
public:
  using RDOContainer = T_RDO_Container;
  using RawDataCollection = RDOContainerTraits<T_RDO_Container>::PerModuleRDOs;
  using ClusterContainer = T_OutputContainer;
 
  using CellContainer = ActsTrk::CellContainer<coordinate_t,NDIM,std::uint16_t>;

  virtual std::pair<unsigned int, unsigned int>
  countCells(const RDOContainer& rdo_collection,
             const std::vector<IdentifierHash> &listOfIds,
             const InDetDD::SiDetectorElementCollection &detector_elements) const =0;

  virtual StatusCode
  clusterize(const EventContext& ctx,
             const RawDataCollection& RDOs,
             const InDet::SiDetectorElementStatus& stripDetElStatus,
             const InDetDD::SiDetectorElement& element,
             CellContainer &cell_container) const = 0;

  virtual std::any createEventDataCache(ClusterContainer& cont,
                                        std::size_t nClusterRDOs) const = 0;

  virtual StatusCode
  makeClusters(const EventContext& ctx,
               const RDOContainer &rdo_container,
               const CellContainer& cell_container,
               unsigned int module_i,
               const InDetDD::SiDetectorElement& element,
               unsigned int icluster,
               ClusterContainer& cont,
               std::any& vars) const = 0;
};
}
#endif