summaryrefslogtreecommitdiff
path: root/python-panimg.spec
blob: cf567e4c882f38bc361e85a91c3570851f2d7603 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
%global _empty_manifest_terminate_build 0
Name:		python-panimg
Version:	0.12.0
Release:	1
Summary:	Conversion of medical images to MHA and TIFF.
License:	Apache-2.0
URL:		https://github.com/DIAGNijmegen/rse-panimg
Source0:	https://mirrors.aliyun.com/pypi/web/packages/1f/e3/9401ec58f8700a0d9bcbefa9be87ccfe226a6c65390834d7eacb0c1fb7b6/panimg-0.12.0.tar.gz
BuildArch:	noarch

Requires:	python3-pydantic
Requires:	python3-numpy
Requires:	python3-SimpleITK
Requires:	python3-pydicom
Requires:	python3-Pillow
Requires:	python3-openslide-python
Requires:	python3-pyvips
Requires:	python3-tifffile
Requires:	python3-construct
Requires:	python3-click
Requires:	python3-pylibjpeg
Requires:	python3-pylibjpeg-libjpeg
Requires:	python3-pylibjpeg-openjpeg
Requires:	python3-wsidicom
Requires:	python3-imagecodecs

%description
# 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/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/panimg)](https://pypi.org/project/panimg/)
[![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.8, 3.9, 3.10 or 3.11.
`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`

## 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 /path/to/files/ /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`                             | `.tiff` | `tiff`     |                            |
| `.svs` (Aperio)                     | `.tiff` | `tiff`     |                            |
| `.vms`, `.vmu`, `.ndpi` (Hamamatsu) | `.tiff` | `tiff`     |                            |
| `.scn` (Leica)                      | `.tiff` | `tiff`     |                            |
| `.mrxs` (MIRAX)                     | `.tiff` | `tiff`     |                            |
| `.biff` (Ventana)                   | `.tiff` | `tiff`     |                            |
| `.dcm` (DICOM-WSI)                  | `.tiff` | `tiff`     |                            |

<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

#### 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.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
    ...
```


%package -n python3-panimg
Summary:	Conversion of medical images to MHA and TIFF.
Provides:	python-panimg
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-panimg
# 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/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/panimg)](https://pypi.org/project/panimg/)
[![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.8, 3.9, 3.10 or 3.11.
`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`

## 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 /path/to/files/ /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`                             | `.tiff` | `tiff`     |                            |
| `.svs` (Aperio)                     | `.tiff` | `tiff`     |                            |
| `.vms`, `.vmu`, `.ndpi` (Hamamatsu) | `.tiff` | `tiff`     |                            |
| `.scn` (Leica)                      | `.tiff` | `tiff`     |                            |
| `.mrxs` (MIRAX)                     | `.tiff` | `tiff`     |                            |
| `.biff` (Ventana)                   | `.tiff` | `tiff`     |                            |
| `.dcm` (DICOM-WSI)                  | `.tiff` | `tiff`     |                            |

<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

#### 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.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
    ...
```


%package help
Summary:	Development documents and examples for panimg
Provides:	python3-panimg-doc
%description help
# 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/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/panimg)](https://pypi.org/project/panimg/)
[![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.8, 3.9, 3.10 or 3.11.
`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`

## 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 /path/to/files/ /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`                             | `.tiff` | `tiff`     |                            |
| `.svs` (Aperio)                     | `.tiff` | `tiff`     |                            |
| `.vms`, `.vmu`, `.ndpi` (Hamamatsu) | `.tiff` | `tiff`     |                            |
| `.scn` (Leica)                      | `.tiff` | `tiff`     |                            |
| `.mrxs` (MIRAX)                     | `.tiff` | `tiff`     |                            |
| `.biff` (Ventana)                   | `.tiff` | `tiff`     |                            |
| `.dcm` (DICOM-WSI)                  | `.tiff` | `tiff`     |                            |

<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

#### 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.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
    ...
```


%prep
%autosetup -n panimg-0.12.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-panimg -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.12.0-1
- Package Spec generated