This release is a pre-release and may not be stable for production use.
ID-uptake-values
Estimate SUV (body-mass normalised) and SUL (lean-body-mass normalised) PET images without DICOM metadata such as injected dose or patient weight. Total activity and body mass / lean body mass are inferred from the images themselves, using TotalSegmentator masks and a k-nearest-neighbour model over axial distribution functions.
Installation
pip install . # or: uv sync
The model weights are bundled with the package.
Usage
Installing provides the suv_id and sul_id commands (also runnable as python -m id_uptake_values.suv / .sul).
Inputs are NIfTI files: PET, CT, and TotalSegmentator segmentations (total, body, and for SUL also tissue).
# SUV
suv_id --pet pet.nii.gz --ct ct.nii.gz \
--totalseg total.nii.gz --bodyseg body.nii.gz \
--output-image suv.nii.gz --output-json suv.json --debug-image debug.png
# SUL
sul_id --pet pet.nii.gz --ct ct.nii.gz \
--totalseg total.nii.gz --tissueseg tissue.nii.gz --bodyseg body.nii.gz \
--output-image sul.nii.gz --output-json sul.json --debug-image debug.png
The JSON contains the estimated activity (MBq), the estimated body mass or lean body mass (kg), and the denominator the PET image was divided by.
The scan must cover the region from C1 to the sacrum; otherwise a ValueError is raised.
Add --remove-bladder (or remove_bladder=True in suv_id / sul_id) to exclude the bladder from the activity estimate. The spike just below the sacrum is cut from both the reference and patient curves (references are renormalised to sum to 1), so the nearest-neighbour matching ignores bladder filling and estimated_activity_MBq is the total activity excluding the bladder. Off by default.
Development
uv sync
uv run pytest
The tests download subject sub-000 from the DEPICT-RH/Multimodal-HC dataset into the Hugging Face cache.
Metadata
Release files for id-uptake-values 0.4.0a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| id_uptake_values-0.4.0a1.tar.gz | 12.6 MB | Without provenance | Details for id_uptake_values-0.4.0a1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| id_uptake_values-0.4.0a1-py3-none-any.whl | Python 3 | none | any | Details for id_uptake_values-0.4.0a1-py3-none-any.whl |
Total release size: 25.3 MB
Release files / id_uptake_values-0.4.0a1.tar.gz
| Download URL | id_uptake_values-0.4.0a1.tar.gz |
|---|---|
| Size | 12.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
541ff93766725a319bb0ffa8fd1dbe6cb541e7d5ee0fa6e4c0ce15184c0087d0
|
|
BLAKE2b-256 checksum How to use checksums |
aa650f13849b7dc0e00e028b88db61b19f38322b27c12755ac99b2ffc589ada1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / id_uptake_values-0.4.0a1-py3-none-any.whl
| Download URL | id_uptake_values-0.4.0a1-py3-none-any.whl |
|---|---|
| Size | 12.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e6f444aad996be5dd78fa9e70a738aaf4881e349efb62e9becc22a170150926c
|
|
BLAKE2b-256 checksum How to use checksums |
7971d127194707e7742675ebb52066c15b5200eb155d162cdd4785d408c13774
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for id-uptake-values 0.4.0a1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.