Skip to content

docs(itk-python): example of file format conversion via wasm io packages #1240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2024
Merged

docs(itk-python): example of file format conversion via wasm io packages #1240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 37 additions & 7 deletions docs/python/itk_python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,36 @@ itkwasm_image = Image(**image_dict)

The file extensions for these formats are `.iwi` and `.iwm` for images and mesh-like data, respectively. When written, these will output directories with an `index.json` file and raw binary files. When `.iwi.cbor` or `.iwm.cbor` extensions are used, a single [CBOR](https://en.wikipedia.org/wiki/CBOR) file is created.

### Wasm Python Packages

These file formats can be use with the ITK-Wasm Python packages, both on the system
or in the browser.

Install the wasm Python IO packages:

```shell
pip install itkwasm-image-io
pip install itkwasm-mesh-io
```

Then use with `itkwasm_image_io.imread`, `itkwasm_image_io.imwrite`,
`itkwasm_mesh_io.meshread`, `itkwasm_mesh_io.meshwrite`. Example:

```python
from itkwasm_image_io import imread, imwrite
from itkwasm_mesh_io import meshread, meshwrite

image = imread('cthead1.png')
imwrite(image, 'cthead1.iwi')
imwrite(image, 'cthead1.iwi.cbor')

mesh = meshread('cow.vtk')
meshwrite(mesh, 'cow.iwm')
meshwrite(mesh, 'cow.iwm.cbor')
```

### Native Python Packages

These file formats can also be used with native ITK Python.

Install the binary Python package:
Expand All @@ -52,13 +82,13 @@ pip install itk-webassemblyinterface
Then use with `itk.imread`, `itk.imwrite`, `itk.meshread`, `itk.meshwrite`. Example:

```python
import itk
from itk import imread, imwrite, meshread, meshwrite

image = itk.imread('cthead1.png')
itk.imwrite(image, 'cthead1.iwi')
itk.imwrite(image, 'cthead1.iwi.cbor')
image = imread('cthead1.png')
imwrite(image, 'cthead1.iwi')
imwrite(image, 'cthead1.iwi.cbor')

mesh = itk.meshread('cow.vtk')
itk.meshwrite(mesh, 'cow.iwm')
itk.meshwrite(mesh, 'cow.iwm.cbor')
mesh = meshread('cow.vtk')
meshwrite(mesh, 'cow.iwm')
meshwrite(mesh, 'cow.iwm.cbor')
```
Loading