Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.76 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.76 KB
Raw

PETSIRD draft data model and examples

CI pre-commit.ci status

The purpose of this repo is to have a working example of a data model for PET imaging (list mode data). This is not complete, and aspects do not follow the actual proposal of PETSIRD yet.

Background

The Emission Tomography Standardization Initiative (ETSI) is working towards establishing a standard for PET Raw Data, called PETSIRD ("PET ETSI Raw Data").

The specification uses the yardl tool to define the model. yardl can be used to read the specification (in the model directory) and generate an SDK for both C++ and Python to read/write PETSIRD data.

To get started as a Python user:

If you don't want to modify the yardl model, just pip install petsird. More detail is in the python/README.md.

To get started quickly as a developer:

  1. Open this repo in GitHub Codespaces or in a VS Code devcontainer. This codespace/container will contain all necessary tools, including yardl itself, as well as the current repository.

  2. Browse the model directory.

  3. Use yardl to generate C++ and Python code for the model:

    cd model
yardl generate

  4. Have a look at (and try!) the examples in the cpp and/or python directories.