Files
aare/docs/src/pyClusterFile.rst
Erik Fröjdh 11fa95b23c Improved documentation for ClusterFile on the python side (#201)
- Fixed CI job not doing python docs
- added more docs on cluster file 
- fixed generating docs on cluster vector
2025-06-13 10:41:39 +02:00

741 B

ClusterFile

The ClusterFile class is the main interface to read and write clusters in aare. Unfortunately the old file format does not include metadata like the cluster size and the data type. This means that the user has to know this information from other sources. Specifying the wrong cluster size or data type will lead to garbage data being read.

ClusterFile

Below is the API of the ClusterFile_Cluster3x3i but all variants share the same API.

aare._aare.ClusterFile_Cluster3x3i