Metadata-Version: 2.4
Name: voxscope
Version: 0.1.20
Summary: Local web viewer for DICOM, NIfTI, NPY, and NPZ volumes.
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: fastapi
Requires-Dist: uvicorn
Requires-Dist: numpy
Requires-Dist: nibabel
Requires-Dist: pydicom

# voxscope

Local web viewer for 3D medical image volumes. It supports DICOM directory series, NIfTI, NPY, and NPZ data.

Not for diagnostic use.

## Install

```powershell
python -m pip install voxscope
```

If a mirror has not synced the latest release yet:

```powershell
python -m pip install --index-url https://pypi.org/simple voxscope
```

## Run

```powershell
voxscope
voxscope "C:\data"
voxscope "\\nas\share\dataset" --no-open
```

Default URL: `http://127.0.0.1:8765`

## Input Data

- DICOM directories are grouped into series.
- `.nii` and `.nii.gz` use NIfTI affine metadata.
- `.npy` is read as one 3D array in `[Z, Y, X]` order.
- `.npz` image files require an `image` key.
- `.npz` mask files can use `mask` or `image`.

Optional NPZ metadata:

- `spacing`: `[Z, Y, X]`
- `affine`: `4 x 4`
- `norm_type`: string
- `display_range`: `[min, max]`
- `label_names`, `label_colors` for masks

Default for NPY/NPZ without metadata: spacing `1, 1, 1 mm`.

## Current Scope

Available now: three-plane MPR, synchronized crosshair picking, on-demand vtk.js MIP/basic VR on full-resolution scalar data, window/level transfer functions, normalized display modes, directory browsing, lazy listing, multiple masks, and basic metadata display.

Deferred: annotation, measurement, screenshot export, data export, oblique MPR, advanced transfer functions, segmentation surfaces, 4D data, DICOM SEG/RTSTRUCT, and mask resampling.
