mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-04-21 22:30:02 +02:00
33 lines
1000 B
ReStructuredText
33 lines
1000 B
ReStructuredText
ClusterVector
|
|
================
|
|
|
|
The ClusterVector, holds clusters from the ClusterFinder. Since it is templated
|
|
in C++ we use a suffix indicating the data type in python. The suffix is
|
|
``_i`` for integer, ``_f`` for float, and ``_d`` for double.
|
|
|
|
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**
|
|
|
|
.. code:: python
|
|
|
|
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)
|
|
|
|
|
|
.. py:currentmodule:: aare
|
|
|
|
.. autoclass:: ClusterVector_i
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:inherited-members: |