Skip to main content

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.

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.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for id-uptake-values 0.3.1
File Size Uploaded Provenance Actions
id_uptake_values-0.3.1.tar.gz 12.6 MB Without provenance Details for id_uptake_values-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for id-uptake-values 0.3.1
File Interpreter ABI Platform Actions
id_uptake_values-0.3.1-py3-none-any.whl Python 3 none any Details for id_uptake_values-0.3.1-py3-none-any.whl

Total release size: 25.3 MB

Release files / id_uptake_values-0.3.1.tar.gz

Download URL id_uptake_values-0.3.1.tar.gz
Size 12.6 MB
Tags Source
SHA-256 checksum
How to use checksums
023385ae9e760899f3a9cdeb85fb261d58721f8c6d8a260f680a06a868e5604c
BLAKE2b-256 checksum
How to use checksums
5c0886ea9538a51035ec0ee12841fa74e52cee45071dbea47e518b245452efe5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.3.1-py3-none-any.whl

Download URL id_uptake_values-0.3.1-py3-none-any.whl
Size 12.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
452fea8cda45f14fa74b45884528e7d5ad44f7fe0fd147998282ffd0fee23447
BLAKE2b-256 checksum
How to use checksums
e034e656d01d4c58adda47ea9298ec674bb1e5bf193a7c392607b455f442e432
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.3.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page