petsird 0.2.0__tar.gz

petsird-0.2.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: petsird
+Version: 0.2.0
+Summary: Library and tools for working with PET Emission Tomography Standardization Initiative Raw Data (PETSIRD) data
+Author-email: Kris Thielemans <k.thielemans@ucl.ac.uk>
+Maintainer-email: Casper da Costa-Luis <imaging@cdcl.ml>, Kris Thielemans <k.thielemans@ucl.ac.uk>
+License: Apache-2.0
+Project-URL: Homepage, https://etsinitiative.org
+Project-URL: Repository, https://github.com/ETSInitiative/PETSIRD
+Project-URL: Issues, https://github.com/ETSInitiative/PETSIRD/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.22
+
+# PETSIRD Python SDK
+
+The [Emission Tomography Standardization Initiative (ETSI)](https://etsinitiative.org/)
+is working towards establishing a standard for PET Raw Data, called PETSIRD ("Positron Emission Tomography Standardization Initiative Raw Data").
+
+Read & write PETSIRD data in Python.
+
+## Examples
+
+See [ETSInitiative/PETSIRD:python](https://github.com/ETSInitiative/PETSIRD/tree/main/python).

petsird-0.2.0/README.md

@@ -0,0 +1,41 @@
+# PETSIRD basic Python example
+
+This directory contains some Python example code to read/write PETSIRD data.
+
+## Install
+
+Some python code is generated by `yardl` and included in the PyPI distribution.
+
+```sh
+python3 -m venv ~/petsirdenv
+source ~/petsirdenv/bin/activate
+pip install petsird
+```
+
+## Local Development
+
+(This option needs the `yardl` binary, either download it, or use our devcontainer or GitHub CodeSpace.)
+
+You need to `yardl generate` in the `model` directory first. This will create the Python package files in a `petsird`
+subfolder.
+
+```sh
+cd ../model
+yardl generate
+pip install --editable ../python
+```
+
+## Usage
+
+The Python code shows piping the compact binary format to standard out and
+reading it from standard in. This can be used as follows:
+
+1. From the repo root `cd python`
+1. `python petsird_generator.py | python petsird_analysis.py`
+
+There is also a very basic utility to plot the scanner geometry. For instance
+
+```sh
+python petsird_generator.py > test.bin
+python petsird_plot_scanner.py < test.bin
+```

petsird-0.2.0/README.pypi.md

@@ -0,0 +1,10 @@
+# PETSIRD Python SDK
+
+The [Emission Tomography Standardization Initiative (ETSI)](https://etsinitiative.org/)
+is working towards establishing a standard for PET Raw Data, called PETSIRD ("Positron Emission Tomography Standardization Initiative Raw Data").
+
+Read & write PETSIRD data in Python.
+
+## Examples
+
+See [ETSInitiative/PETSIRD:python](https://github.com/ETSInitiative/PETSIRD/tree/main/python).

petsird-0.2.0/petsird/__init__.py

@@ -0,0 +1,76 @@
+# This file was generated by the "yardl" tool. DO NOT EDIT.
+
+# pyright: reportUnusedImport=false
+from typing import Tuple as _Tuple
+import re as _re
+import numpy as _np
+
+_MIN_NUMPY_VERSION = (1, 22, 0)
+
+def _parse_version(version: str) -> _Tuple[int, ...]:
+    try:
+        return tuple(map(int, version.split(".")))
+    except ValueError:
+        # ignore any prerelease suffix
+        version = _re.sub(r"[^0-9.]", "", version)
+        return tuple(map(int, version.split(".")))
+
+if _parse_version(_np.__version__) < _MIN_NUMPY_VERSION:
+    raise ImportError(f"Your installed numpy version is {_np.__version__}, but version >= {'.'.join(str(i) for i in _MIN_NUMPY_VERSION)} is required.")
+
+from .yardl_types import *
+from .types import (
+    AnnulusShape,
+    Atom,
+    BedMovementTimeBlock,
+    BoxShape,
+    BoxSolidVolume,
+    BulkMaterial,
+    CoincidenceEvent,
+    CoincidencePolicy,
+    Coordinate,
+    DetElEfficiencies,
+    DetectionEfficiencies,
+    DetectorModule,
+    Direction,
+    DirectionMatrix,
+    EventTimeBlock,
+    ExamInformation,
+    ExternalSignalTimeBlock,
+    ExternalSignalType,
+    ExternalSignalTypeEnum,
+    GantryMovementTimeBlock,
+    GenericSolidVolume,
+    GeometricShape,
+    Header,
+    Institution,
+    ModulePairEfficiencies,
+    ModulePairEfficienciesVector,
+    ModulePairSGIDLUT,
+    ReplicatedBoxSolidVolume,
+    ReplicatedDetectorModule,
+    ReplicatedGenericSolidVolume,
+    ReplicatedObject,
+    RigidTransformation,
+    ScannerGeometry,
+    ScannerInformation,
+    SolidVolume,
+    Subject,
+    TimeBlock,
+    TimeFrameInformation,
+    TimeInterval,
+    TripleEvent,
+    get_dtype,
+)
+from .protocols import (
+    PETSIRDReaderBase,
+    PETSIRDWriterBase,
+)
+from .binary import (
+    BinaryPETSIRDReader,
+    BinaryPETSIRDWriter,
+)
+from .ndjson import (
+    NDJsonPETSIRDReader,
+    NDJsonPETSIRDWriter,
+)