mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2026-02-20 17:58:48 +01:00
11fa95b23c
- Fixed CI job not doing python docs - added more docs on cluster file - fixed generating docs on cluster vector
1.1 KiB
1.1 KiB
ClusterVector
The ClusterVector, holds clusters from the ClusterFinder. Since it is
templated in C++ we use a suffix indicating the type of cluster it
holds. The suffix follows the same pattern as for ClusterFile i.e.
ClusterVector_Cluster3x3i for a vector holding 3x3 integer
clusters.
At the moment the functionality from python is limited and it is not supported to push_back clusters to the vector. The intended use case is to pass it to C++ functions that support the ClusterVector or to view it as a numpy array.
View ClusterVector as numpy array
from aare import ClusterFile
with ClusterFile("path/to/file") as f:
cluster_vector = f.read_frame()
# Create a copy of the cluster data in a numpy array
clusters = np.array(cluster_vector)
# Avoid copying the data by passing copy=False
clusters = np.array(cluster_vector, copy = False)aare._aare.ClusterVector_Cluster3x3i