detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2026-02-19 05:28:39 +01:00
Code Issues Actions Packages Releases Activity

added documentation
All checks were successful
Build on RHEL8 / build (push) Successful in 3m10s
Details
Build on RHEL9 / build (push) Successful in 3m12s
Details

Browse Source
This commit is contained in:
mazzol_a
2025-09-01 15:29:58 +02:00
parent 7926993bb2
commit 12114e7275
5 changed files with 73 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/src/ClusterVector.rst
View File

@@ -12,4 +12,11 @@ ClusterVector
:members:
:undoc-members:
:private-members:
**Free Functions:**
.. doxygenfunction:: aare::reduce_to_3x3(const ClusterVector<Cluster<T, ClusterSizeX, ClusterSizeY, CoordType>>&)
.. doxygenfunction:: aare::reduce_to_2x2(const ClusterVector<Cluster<T, ClusterSizeX, ClusterSizeY, CoordType>>&)

15
docs/src/pyClusterVector.rst
View File

@@ -33,4 +33,17 @@ C++ functions that support the ClusterVector or to view it as a numpy array.
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
:inherited-members:
**Free Functions:**
.. autofunction:: reduce_to_3x3
:noindex:
Reduce a single Cluster to 3x3 by taking the 3x3 subcluster with highest photon energy.
.. autofunction:: reduce_to_2x2
:noindex:
Reduce a single Cluster to 2x2 by taking the 2x2 subcluster with highest photon energy.