Metadata-Version: 2.3
Name: id-uptake-values
Version: 0.4.0a1
Summary: Add your description here
Author: Christian Hinge
Author-email: Christian Hinge <christian.hinge@regionh.dk>
Requires-Dist: argparse>=1.4.0
Requires-Dist: matplotlib>=3.11.2
Requires-Dist: nibabel>=5.4.2
Requires-Dist: scipy>=1.18.1
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# 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](https://huggingface.co/datasets/DEPICT-RH/Multimodal-HC) dataset into the Hugging Face cache.
