traccc::detector_description -> traccc::silicon_detector_description.

In preparation for introducing detector description objects for
other types of detectors as well later on.

Author: krasznaa

core/CMakeLists.txt

@@ -33,10 +33,10 @@ traccc_add_library( traccc_core core TYPE SHARED
   "include/traccc/edm/cell.hpp"
   # Geometry description.
   "include/traccc/geometry/detector.hpp"
-  "include/traccc/geometry/detector_description.hpp"
   "include/traccc/geometry/module_map.hpp"
   "include/traccc/geometry/geometry.hpp"
   "include/traccc/geometry/pixel_data.hpp"
+  "include/traccc/geometry/silicon_detector_description.hpp"
   # Utilities.
   "include/traccc/utils/algorithm.hpp"
   "include/traccc/utils/type_traits.hpp"

core/include/traccc/clusterization/clusterization_algorithm.hpp

@@ -12,7 +12,7 @@
 #include "traccc/clusterization/sparse_ccl_algorithm.hpp"
 #include "traccc/edm/cell.hpp"
 #include "traccc/edm/measurement.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 #include "traccc/utils/algorithm.hpp"
 
 // VecMem include(s).
@@ -32,7 +32,7 @@ namespace traccc::host {
 class clusterization_algorithm
     : public algorithm<measurement_collection_types::host(
           const cell_collection_types::const_view&,
-          const detector_description::const_view&)> {
+          const silicon_detector_description::const_view&)> {
 
     public:
     using config_type = std::monostate;
@@ -51,7 +51,7 @@ class clusterization_algorithm
     ///
     output_type operator()(
         const cell_collection_types::const_view& cells_view,
-        const detector_description::const_view& dd_view) const override;
+        const silicon_detector_description::const_view& dd_view) const override;
 
     private:
     /// @name Sub-algorithms used by this algorithm

core/include/traccc/clusterization/details/measurement_creation.hpp

@@ -12,19 +12,20 @@
 #include "traccc/definitions/qualifiers.hpp"
 #include "traccc/edm/cell.hpp"
 #include "traccc/edm/measurement.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 
 namespace traccc::details {
 
 /// Function used for retrieving the cell signal based on the module id
 TRACCC_HOST_DEVICE
-inline scalar signal_cell_modelling(scalar signal_in,
-                                    const detector_description::const_device&);
+inline scalar signal_cell_modelling(
+    scalar signal_in, const silicon_detector_description::const_device&);
 
 /// Function for pixel segmentation
 TRACCC_HOST_DEVICE
 inline vector2 position_from_cell(
-    const cell& cell, const detector_description::const_device& det_descr);
+    const cell& cell,
+    const silicon_detector_description::const_device& det_descr);
 
 /// Function used for calculating the properties of the cluster during
 /// measurement creation
@@ -38,7 +39,7 @@ inline vector2 position_from_cell(
 ///
 TRACCC_HOST_DEVICE inline void calc_cluster_properties(
     const cell_collection_types::const_device& cluster,
-    const detector_description::const_device& det_descr, point2& mean,
+    const silicon_detector_description::const_device& det_descr, point2& mean,
     point2& var, scalar& totalWeight);
 
 /// Function used for calculating the properties of the cluster during
@@ -54,7 +55,7 @@ TRACCC_HOST_DEVICE inline void fill_measurement(
     measurement_collection_types::device& measurements,
     measurement_collection_types::device::size_type index,
     const cell_collection_types::const_device& cluster,
-    const detector_description::const_device& det_descr);
+    const silicon_detector_description::const_device& det_descr);
 
 }  // namespace traccc::details
 

core/include/traccc/clusterization/details/spacepoint_formation.hpp

@@ -11,7 +11,7 @@
 #include "traccc/definitions/qualifiers.hpp"
 #include "traccc/edm/measurement.hpp"
 #include "traccc/edm/spacepoint.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 
 namespace traccc::details {
 
@@ -23,7 +23,7 @@ namespace traccc::details {
 ///
 TRACCC_HOST_DEVICE inline void fill_spacepoint(
     spacepoint& sp, const measurement& meas,
-    const detector_description::const_device& dd);
+    const silicon_detector_description::const_device& dd);
 
 }  // namespace traccc::details
 

core/include/traccc/clusterization/impl/measurement_creation.ipp

@@ -12,14 +12,15 @@
 namespace traccc::details {
 
 TRACCC_HOST_DEVICE
-inline scalar signal_cell_modelling(scalar signal_in,
-                                    const detector_description::const_device&) {
+inline scalar signal_cell_modelling(
+    scalar signal_in, const silicon_detector_description::const_device&) {
     return signal_in;
 }
 
 TRACCC_HOST_DEVICE
 inline vector2 position_from_cell(
-    const cell& cell, const detector_description::const_device& det_descr) {
+    const cell& cell,
+    const silicon_detector_description::const_device& det_descr) {
 
     // Retrieve the specific values based on module idx
     const cell::link_type module_link = cell.module_link;
@@ -33,7 +34,7 @@ inline vector2 position_from_cell(
 
 TRACCC_HOST_DEVICE inline void calc_cluster_properties(
     const cell_collection_types::const_device& cluster,
-    const detector_description::const_device& det_descr, point2& mean,
+    const silicon_detector_description::const_device& det_descr, point2& mean,
     point2& var, scalar& totalWeight) {
 
     point2 offset{0., 0.};
@@ -79,7 +80,7 @@ TRACCC_HOST_DEVICE inline void fill_measurement(
     measurement_collection_types::device& measurements,
     const measurement_collection_types::device::size_type index,
     const cell_collection_types::const_device& cluster,
-    const detector_description::const_device& det_descr) {
+    const silicon_detector_description::const_device& det_descr) {
 
     // To calculate the mean and variance with high numerical stability
     // we use a weighted variant of Welford's algorithm. This is a

core/include/traccc/clusterization/impl/spacepoint_formation.ipp

@@ -14,7 +14,7 @@ namespace traccc::details {
 
 TRACCC_HOST_DEVICE inline void fill_spacepoint(
     spacepoint& sp, const measurement& meas,
-    const detector_description::const_device& dd) {
+    const silicon_detector_description::const_device& dd) {
 
     // Transform measurement position to 3D
     const point3 local_3d = {meas.local[0], meas.local[1], 0.f};

core/include/traccc/clusterization/measurement_creation_algorithm.hpp

@@ -10,7 +10,7 @@
 // Library include(s).
 #include "traccc/edm/cluster.hpp"
 #include "traccc/edm/measurement.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 #include "traccc/utils/algorithm.hpp"
 
 // VecMem include(s).
@@ -30,7 +30,7 @@ namespace traccc::host {
 class measurement_creation_algorithm
     : public algorithm<measurement_collection_types::host(
           const cluster_container_types::const_view &,
-          const detector_description::const_view &)> {
+          const silicon_detector_description::const_view &)> {
 
     public:
     /// Measurement_creation algorithm constructor
@@ -48,7 +48,7 @@ class measurement_creation_algorithm
     ///
     output_type operator()(
         const cluster_container_types::const_view &clusters_view,
-        const detector_description::const_view &dd_view) const override;
+        const silicon_detector_description::const_view &dd_view) const override;
 
     private:
     /// The memory resource used by the algorithm

core/include/traccc/clusterization/spacepoint_formation_algorithm.hpp

@@ -10,7 +10,7 @@
 // Library include(s).
 #include "traccc/edm/measurement.hpp"
 #include "traccc/edm/spacepoint.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 #include "traccc/utils/algorithm.hpp"
 
 // VecMem include(s).
@@ -29,7 +29,7 @@ namespace traccc::host {
 class spacepoint_formation_algorithm
     : public algorithm<spacepoint_collection_types::host(
           const measurement_collection_types::const_view&,
-          const detector_description::const_view&)> {
+          const silicon_detector_description::const_view&)> {
 
     public:
     /// Constructor for spacepoint_formation
@@ -47,7 +47,7 @@ class spacepoint_formation_algorithm
     ///
     output_type operator()(
         const measurement_collection_types::const_view& measurements_view,
-        const detector_description::const_view& dd_view) const override;
+        const silicon_detector_description::const_view& dd_view) const override;
 
     private:
     /// The memory resource used by the algorithm

core/include/traccc/geometry/detector_description.hpp core/include/traccc/geometry/silicon_detector_description.hpp

@@ -19,13 +19,13 @@
 
 namespace traccc {
 
-/// Interface for the @c traccc::detector_description class.
+/// Interface for the @c traccc::silicon_detector_description class.
 ///
 /// It provides the API that users would interact with, while using the
-/// columns/arrays defined in @c traccc::detector_description.
+/// columns/arrays defined in @c traccc::silicon_detector_description.
 ///
 template <typename BASE>
-class detector_description_interface : public BASE {
+class silicon_detector_description_interface : public BASE {
 
     public:
     /// Inherit the base class's constructor(s)
@@ -225,11 +225,11 @@ class detector_description_interface : public BASE {
 
     /// @}
 
-};  // class detector_description_interface
+};  // class silicon_detector_description_interface
 
-/// SoA container describing the detector
-using detector_description = vecmem::edm::container<
-    detector_description_interface,
+/// SoA container describing a silicon detector
+using silicon_detector_description = vecmem::edm::container<
+    silicon_detector_description_interface,
     vecmem::edm::type::vector<detray::geometry::barcode>,
     vecmem::edm::type::vector<transform3>,
     vecmem::edm::type::vector<geometry_id>, vecmem::edm::type::vector<scalar>,

core/src/clusterization/clusterization_algorithm.cpp

@@ -15,7 +15,7 @@ clusterization_algorithm::clusterization_algorithm(vecmem::memory_resource& mr)
 
 clusterization_algorithm::output_type clusterization_algorithm::operator()(
     const cell_collection_types::const_view& cells_view,
-    const detector_description::const_view& dd_view) const {
+    const silicon_detector_description::const_view& dd_view) const {
 
     const sparse_ccl_algorithm::output_type clusters = m_cc(cells_view);
     const auto clusters_data = get_data(clusters);

core/src/clusterization/measurement_creation_algorithm.cpp

@@ -20,11 +20,11 @@ measurement_creation_algorithm::measurement_creation_algorithm(
 measurement_creation_algorithm::output_type
 measurement_creation_algorithm::operator()(
     const cluster_container_types::const_view &clusters_view,
-    const detector_description::const_view &dd_view) const {
+    const silicon_detector_description::const_view &dd_view) const {
 
     // Create device containers for the input variables.
     const cluster_container_types::const_device clusters{clusters_view};
-    const detector_description::const_device det_descr{dd_view};
+    const silicon_detector_description::const_device det_descr{dd_view};
 
     // Create the result object.
     output_type result(clusters.size(), &(m_mr.get()));

core/src/clusterization/spacepoint_formation_algorithm.cpp

@@ -19,12 +19,12 @@ spacepoint_formation_algorithm::spacepoint_formation_algorithm(
 spacepoint_formation_algorithm::output_type
 spacepoint_formation_algorithm::operator()(
     const measurement_collection_types::const_view& measurements_view,
-    const detector_description::const_view& dd_view) const {
+    const silicon_detector_description::const_view& dd_view) const {
 
     // Create device containers for the inputs.
     const measurement_collection_types::const_device measurements{
         measurements_view};
-    const detector_description::const_device det_descr{dd_view};
+    const silicon_detector_description::const_device det_descr{dd_view};
 
     // Create the result container.
     output_type result(measurements.size(), &(m_mr.get()));

device/alpaka/include/traccc/alpaka/clusterization/clusterization_algorithm.hpp

@@ -13,7 +13,7 @@
 #include "traccc/edm/cell.hpp"
 #include "traccc/edm/measurement.hpp"
 #include "traccc/edm/spacepoint.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 #include "traccc/utils/algorithm.hpp"
 #include "traccc/utils/memory_resource.hpp"
 
@@ -36,7 +36,7 @@ namespace traccc::alpaka {
 class clusterization_algorithm
     : public algorithm<measurement_collection_types::buffer(
           const cell_collection_types::const_view&,
-          const detector_description::const_view&)> {
+          const silicon_detector_description::const_view&)> {
 
     public:
     /// Configuration type
@@ -58,9 +58,9 @@ class clusterization_algorithm
     /// @param det_descr The detector description
     /// @return a measurement collection (buffer)
     ///
-    output_type operator()(
-        const cell_collection_types::const_view& cells,
-        const detector_description::const_view& det_descr) const override;
+    output_type operator()(const cell_collection_types::const_view& cells,
+                           const silicon_detector_description::const_view&
+                               det_descr) const override;
 
     private:
     /// The average number of cells in each partition

device/alpaka/include/traccc/alpaka/clusterization/spacepoint_formation_algorithm.hpp

@@ -11,7 +11,7 @@
 #include "traccc/edm/cell.hpp"
 #include "traccc/edm/measurement.hpp"
 #include "traccc/edm/spacepoint.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 #include "traccc/utils/algorithm.hpp"
 #include "traccc/utils/memory_resource.hpp"
 
@@ -31,7 +31,7 @@ namespace traccc::alpaka {
 class spacepoint_formation_algorithm
     : public algorithm<spacepoint_collection_types::buffer(
           const measurement_collection_types::const_view&,
-          const detector_description::const_view&)> {
+          const silicon_detector_description::const_view&)> {
 
     public:
     /// Constructor for spacepoint_formation
@@ -51,7 +51,8 @@ class spacepoint_formation_algorithm
     ///
     output_type operator()(
         const measurement_collection_types::const_view& measurements_view,
-        const detector_description::const_view& det_descr) const override;
+        const silicon_detector_description::const_view& det_descr)
+        const override;
 
     private:
     /// The memory resource(s) to use

device/alpaka/src/clusterization/clusterization_algorithm.cpp

@@ -27,7 +27,7 @@ struct CCLKernel {
     ALPAKA_FN_ACC void operator()(
         TAcc const& acc, const clustering_config cfg,
         const cell_collection_types::const_view cells_view,
-        const detector_description::const_view det_descr_view,
+        const silicon_detector_description::const_view det_descr_view,
         vecmem::data::vector_view<device::details::index_t> f_backup_view,
         vecmem::data::vector_view<device::details::index_t> gf_backup_view,
         vecmem::data::vector_view<unsigned char> adjc_backup_view,
@@ -85,7 +85,7 @@ clusterization_algorithm::clusterization_algorithm(
 
 clusterization_algorithm::output_type clusterization_algorithm::operator()(
     const cell_collection_types::const_view& cells,
-    const detector_description::const_view& det_descr) const {
+    const silicon_detector_description::const_view& det_descr) const {
 
     // Setup alpaka
     auto devAcc = ::alpaka::getDevByIdx(::alpaka::Platform<Acc>{}, 0u);

device/alpaka/src/clusterization/spacepoint_formation_algorithm.cpp

@@ -21,7 +21,7 @@ struct FormSpacepointsKernel {
     ALPAKA_FN_ACC void operator()(
         TAcc const& acc,
         measurement_collection_types::const_view measurements_view,
-        const detector_description::const_view det_descr_view,
+        const silicon_detector_description::const_view det_descr_view,
         const unsigned int measurement_count,
         spacepoint_collection_types::view spacepoints_view) const {
 
@@ -41,7 +41,7 @@ spacepoint_formation_algorithm::spacepoint_formation_algorithm(
 spacepoint_formation_algorithm::output_type
 spacepoint_formation_algorithm::operator()(
     const measurement_collection_types::const_view& measurements_view,
-    const detector_description::const_view& det_descr) const {
+    const silicon_detector_description::const_view& det_descr) const {
 
     // Setup alpaka
     auto devAcc = ::alpaka::getDevByIdx(::alpaka::Platform<Acc>{}, 0u);

device/common/include/traccc/clusterization/device/aggregate_cluster.hpp

@@ -12,7 +12,7 @@
 #include "traccc/definitions/qualifiers.hpp"
 #include "traccc/edm/cell.hpp"
 #include "traccc/edm/measurement.hpp"
-#include "traccc/geometry/detector_description.hpp"
+#include "traccc/geometry/silicon_detector_description.hpp"
 
 // VecMem include(s).
 #include <vecmem/containers/data/vector_view.hpp>
@@ -34,7 +34,7 @@ namespace traccc::device {
 TRACCC_HOST_DEVICE
 inline void aggregate_cluster(
     const cell_collection_types::const_device& cells,
-    const detector_description::const_device& det_descr,
+    const silicon_detector_description::const_device& det_descr,
     const vecmem::device_vector<details::index_t>& f, unsigned int start,
     unsigned int end, unsigned short cid, measurement& out,
     vecmem::data::vector_view<unsigned int> cell_links, unsigned int link);