panimg 0.18.1
Conversion of medical images to MHA and TIFF.
License: Apache-2.0
Requires Python: <4.0,>=3.10

# panimg

[![CI](https://github.com/DIAGNijmegen/rse-panimg/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DIAGNijmegen/rse-panimg/actions/workflows/ci.yml?query=branch%3Amain)
[![PyPI](https://img.shields.io/pypi/v/panimg)](https://pypi.org/project/panimg/)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FDIAGNijmegen%2Frse-panimg%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![DOI](https://zenodo.org/badge/344730308.svg)](https://zenodo.org/badge/latestdoi/344730308)

**NOT FOR CLINICAL USE**

Conversion of medical images to MHA and TIFF.
Requires Python 3.10, 3.11, 3.12, 3.13 or 3.14.
`libvips-dev` and `libopenslide-dev` must be installed on your system.

Under the hood we use:

* `SimpleITK`
* `pydicom`
* `pylibjpeg`
* `Pillow`
* `openslide-python`
* `pyvips`
* `oct-converter`
* `wsidicom`
* `pyisyntax`

## Usage

`panimg` takes a directory and tries to convert the containing files to MHA or TIFF.
By default, it will try to convert files from subdirectories as well.
To only convert files in the top level directory, set `recurse_subdirectories` to `False`.
It will try several strategies for loading the contained files, and if an image is found it will output it to the output directory.
It will return a structure containing information about what images were produced, what images were used to form the new images, image metadata, and any errors from any of the strategies.


**NOTE: Alpha software, do not run this on directories you do not have a backup of.**

```python
from pathlib import Path
from panimg import convert

result = convert(
    input_directory=Path("/path/to/files/"),
    output_directory=Path("/where/files/will/go/"),
)
```

### Command Line Interface

`panimg` is also accessible from the command line.
Install the package from pip as before, then you can use:

**NOTE: Alpha software, do not run this on directories you do not have a backup of.**

```shell
panimg convert --input-dir /path/to/files/ --output-dir /where/files/will/go/
```

To access the help test you can use `panimg -h`.

### Supported Formats

| Input                               | Output  | Strategy   | Notes                      |
|-------------------------------------| --------| ---------- | -------------------------- |
| `.mha`                              | `.mha`  | `metaio`   |                            |
| `.mhd` with `.raw` or `.zraw`       | `.mha`  | `metaio`   |                            |
| `.dcm`                              | `.mha`  | `dicom`    |                            |
| `.nii`                              | `.mha`  | `nifti`    |                            |
| `.nii.gz`                           | `.mha`  | `nifti`    |                            |
| `.nrrd`                             | `.mha`  | `nrrd`     | <sup>[1](#footnote1)</sup> |
| `.e2e`                              | `.mha`  | `oct`      | <sup>[2](#footnote2)</sup> |
| `.fds`                              | `.mha`  | `oct`      | <sup>[2](#footnote2)</sup> |
| `.fda`                              | `.mha`  | `oct`      | <sup>[2](#footnote2)</sup> |
| `.png`                              | `.mha`  | `fallback` | <sup>[3](#footnote3)</sup> |
| `.jpeg`                             | `.mha`  | `fallback` | <sup>[3](#footnote3)</sup> |
| `.tiff`                             | `.tif`  | `tiff`     |                            |
| `.tif`                              | `.tif`  | `tiff`     |                            |
| `.svs` (Aperio)                     | `.tif`  | `tiff`     |                            |
| `.vms`, `.vmu`, `.ndpi` (Hamamatsu) | `.tif`  | `tiff`     |                            |
| `.scn` (Leica)                      | `.tif`  | `tiff`     |                            |
| `.mrxs` (MIRAX)                     | `.tif`  | `tiff`     |                            |
| `.biff` (Ventana)                   | `.tif`  | `tiff`     |                            |
| `.dcm` (DICOM-WSI)                  | `.tif`  | `tiff`     |                            |
| `.isyntax` (iSyntax)                | `.tif`  | `tiff`     | <sup>[4](#footnote4)</sup> |

<a name="footnote1">1</a>: Detached headers are not supported.

<a name="footnote2">2</a>: Only OCT volume(s), no fundus image(s) will be extracted.

<a name="footnote3">3</a>: 2D only, unitary dimensions

<a name="footnote3">4</a>: When `isyntax` is available in the python environment

#### Post Processors

You can also define a set of post processors that will operate on each output file.
Post processors will not produce any new image entities, but rather add additional representations of an image, such as DZI or thumbnails.
We provide a `dzi_to_tiff` post processor that is enabled by default, which will produce a DZI file if it is able to.
To customise the post processors that run you can do this with

```python
result = convert(..., post_processors=[...])
```

You are able to run the post processors directly with

```python
from panimg import post_process
from panimg.models import PanImgFile

result = post_process(image_files={PanImgFile(...), ...}, post_processors=[...])
```

#### Using Strategies Directly

If you want to run a particular strategy directly which returns a generator of images for a set of files you can do this with

```python
files = {f for f in Path("/foo/").glob("*.dcm") if f.is_file()}

try:
    for result in image_builder_dicom(files=files):
        sitk_image = result.image
        process(sitk_image)  # etc. you can also look at result.name for the name of the file,
                             # and result.consumed_files to see what files were used for this image
except UnconsumedFilesException as e:
    # e.file_errors is keyed with a Path to a file that could not be consumed,
    # with a list of all the errors found with loading it,
    # the user can then choose what to do with that information
    ...
```