panimg
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:
SimpleITKpydicompylibjpegPillowopenslide-pythonpyvipsoct-converterwsidicompyisyntax
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.
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.
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 |
1 |
.e2e |
.mha |
oct |
2 |
.fds |
.mha |
oct |
2 |
.fda |
.mha |
oct |
2 |
.png |
.mha |
fallback |
3 |
.jpeg |
.mha |
fallback |
3 |
.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 |
4 |
1: Detached headers are not supported.
2: Only OCT volume(s), no fundus image(s) will be extracted.
3: 2D only, unitary dimensions
4: 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
result = convert(..., post_processors=[...])
You are able to run the post processors directly with
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
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
...
1 maintainer
Metadata
1 maintainer
Release files for panimg 0.18.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| panimg-0.18.2.tar.gz | 56.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| panimg-0.18.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 108.5 kB
Release files / panimg-0.18.2.tar.gz
| Download URL | panimg-0.18.2.tar.gz |
|---|---|
| Size | 56.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
af105f061bfe43cafbee956f4f01d1cca2bec1dbcf8b3115be3d21b707aa0d9c
|
|
BLAKE2b-256 checksum How to use checksums |
22191ce9b65e231656cb39f9da91b2f20f19f1b281318e1d8a5ac33b8b7b7052
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 20, 2026.
Transparency logRelease files / panimg-0.18.2-py3-none-any.whl
| Download URL | panimg-0.18.2-py3-none-any.whl |
|---|---|
| Size | 51.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d408f5ff69408d6d7d298f50de01505b8824b87615b7fccccacee3101de5d90e
|
|
BLAKE2b-256 checksum How to use checksums |
863527ff32d3d42e262acd778915ca508e9b62a562444c2ab2310a84ad7b7b3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 20, 2026.
Transparency log
