Skip to content

Commit 1238a4d

Browse files
committed
docs: packages pagee myst re-formatting
1 parent dc995aa commit 1238a4d

13 files changed

+32
-25
lines changed

docs/introduction/file_formats/index.md

-10
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,3 @@ ITK-Wasm file formats are available in ITK-Wasm IO functions but also in C++ via
1818
<dt><b>ITK-Wasm Image (.iwi, .iwi.cbor, .iwi.cbor.zst)</b><dt><dd>Serialization of an <a href="../../typescript/interface_types/Image.html"><code>Image</code></a>.</dd>
1919
<dt><b>ITK-Wasm Mesh (.iwm, .iwm.cbor, .iwm.cbor.zst)</b><dt><dd>Serialization of a <a href="../../typescript/interface_types/Mesh.html"><code>Mesh</code></a>, or <a href="../../typescript/interface_types/PolyData.html"><code>PolyData</code></a>.</dd>
2020
</dl>
21-
22-
23-
```{toctree}
24-
:hidden:
25-
:maxdepth: 3
26-
27-
images.md
28-
meshes.md
29-
dicom.md
30-
```

docs/introduction/packages.md

+31-14
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,38 @@ Example packages built with itk-wasm can be found below. If you created a
44
package, please [open a pull
55
request](https://github.com/InsightSoftwareConsortium/ITK-Wasm/compare) to add it to the table!
66

7-
| <img width=100/> Repository | <img width=125/> Description <img width=125/> | <img width=200/> Links |
8-
|-----------------------------|:---------------------------------------------:|:----------------------:|
9-
| [@itk-wasm/compare-images][compare-images-repo] | [<img src="../static/packages/compare-images.png" width="128" />][compare-images-demo-js] <br /> *Compare images with a tolerance for regression testing.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][compare-images-demo-js] <br/>[🕮 Docs][compare-images-docs-js] <br/>[📦 Package][compare-images-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][compare-images-docs-py] <br/>[📦 Package][compare-images-package-py] |
10-
| [@itk-wasm/compress-stringify][compress-stringify-repo] | [<img src="../static/packages/compress-stringify.png" width="128" />][compress-stringify-demo-js]<br /> *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][compress-stringify-demo-js] <br/>[🕮 Docs][compress-stringify-docs-js] <br/>[📦 Package][compress-stringify-package-js] <br/> <br/> ![py][py-logo] <br/>[👨‍💻 Demo][compress-stringify-demo-py] <br/>[🕮 Docs][compress-stringify-docs-py] <br/>[📦 Package][compress-stringify-package-py] |
11-
| [@itk-wasm/dicom][dicom-repo] | [<img src="../static/packages/dicom.png" width="128" />][dicom-demo-js] <br /> *Read files and images related to DICOM file format.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][dicom-demo-js] <br/>[🕮 Docs][dicom-docs-js] <br/>[📦 Package][dicom-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][dicom-docs-py] <br/>[📦 Package][dicom-package-py] |
12-
| [@itk-wasm/downsample][downsample-repo] | [<img src="../static/packages/downsample.png" width="128" />][downsample-demo-js] <br /> *Pipelines for downsampling images.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][downsample-demo-js] <br/>[🕮 Docs][downsample-docs-js] <br/>[📦 Package][downsample-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][downsample-docs-py] <br/>[📦 Package][downsample-package-py] |
13-
| [@itk-wasm/elastix][elastix-repo] | [<img src="../static/packages/elastix.png" width="128" />][elastix-demo-js] <br /> *A toolbox for rigid and nonrigid registration of images.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][elastix-demo-js] <br/>[🕮 Docs][elastix-docs-js] <br/>[📦 Package][elastix-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][elastix-docs-py] <br/>[📦 Package][elastix-package-py] |
14-
| [@itk-wasm/htj2k][htj2k-repo] | [<img src="../static/packages/htj2k.png" width="128" />][htj2k-demo-js] <br /> *Wasm-SIMD accelerated decoding and encoding High-throughput JPEG2000 (HTJ2K) images.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][htj2k-demo-js] <br/>[🕮 Docs][htj2k-docs-js] <br/>[📦 Package][htj2k-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][htj2k-docs-py] <br/>[📦 Package][htj2k-package-py] |
15-
| [@itk-wasm/image-io][image-io-repo] | [<img src="../static/packages/image-io.png" width="128" />][image-io-demo-js] <br /> *Input and output for scientific and medical image file formats.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][image-io-demo-js] <br/>[🕮 Docs][image-io-docs-js] <br/>[📦 Package][image-io-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][image-io-docs-py] <br/>[📦 Package][image-io-package-py] |
16-
| [@itk-wasm/mesh-io][mesh-io-repo] | [<img src="../static/packages/mesh-io.png" width="128" />][mesh-io-demo-js] <br /> *Input and output for scientific and medical mesh file formats.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][mesh-io-demo-js] <br/>[🕮 Docs][mesh-io-docs-js] <br/>[📦 Package][mesh-io-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][mesh-io-docs-py] <br/>[📦 Package][mesh-io-package-py] |
17-
| [@itk-wasm/morphological-contour-interpolation][morphological-contour-interpolation-repo] | [<img src="../static/packages/morphological-contour-interpolation.png" width="128" />][morphological-contour-interpolation-demo-js] <br /> *Input and output for scientific and medical mesh file formats.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][morphological-contour-interpolation-demo-js] <br/>[🕮 Docs][morphological-contour-interpolation-docs-js] <br/>[📦 Package][morphological-contour-interpolation-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][morphological-contour-interpolation-docs-py] <br/>[📦 Package][morphological-contour-interpolation-package-py] |
7+
```{list-table} Example packages
8+
:header-rows: 1
9+
:label: example-packages
10+
:class: text-center
1811
19-
[js-logo]: /static/javascript-logo.svg
20-
[ts-logo]: /static/typescript-logo.svg
21-
[py-logo]: /static/python.svg
12+
* - Description
13+
- Links
14+
* - [![compare-images](../static/packages/compare-images.png)][compare-images-demo-js] [compare-images][compare-images-repo] <br /> *Compare images with a tolerance for regression testing.*
15+
- ![js][js-logo] [👨‍💻 Demo][compare-images-demo-js] <br />[🕮 Docs][compare-images-docs-js] <br />[📦 Package][compare-images-package-js] <br /><br /> ![py][py-logo] [🕮 Docs][compare-images-docs-py] <br />[📦 Package][compare-images-package-py] ![](../static/links-spacer.png)
16+
* - [![compress-stringify](../static/packages/compress-stringify.png)][compress-stringify-demo-js] [compress-stringify][compress-stringify-repo] <br /> *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.*
17+
- ![js][js-logo] [👨‍💻 Demo][compress-stringify-demo-js] <br />[🕮 Docs][compress-stringify-docs-js] <br />[📦 Package][compress-stringify-package-js] <br/> <br/> ![py][py-logo] [👨‍💻 Demo][compress-stringify-demo-py] <br />[🕮 Docs][compress-stringify-docs-py] <br />[📦 Package][compress-stringify-package-py]
18+
* - [![dicom](../static/packages/dicom.png)][dicom-demo-js] [dicom][dicom-repo] <br /> *Read files and images related to DICOM file format.*
19+
- ![js][js-logo] [👨‍💻 Demo][dicom-demo-js] <br/>[🕮 Docs][dicom-docs-js] <br/>[📦 Package][dicom-package-js] <br /><br/> ![py][py-logo] [🕮 Docs][dicom-docs-py] <br/>[📦 Package][dicom-package-py]
20+
* - [![downsample](../static/packages/downsample.png)][downsample-demo-js] [downsample][downsample-repo] <br /> *Pipelines for downsampling images.*
21+
- ![js][js-logo] [👨‍💻 Demo][downsample-demo-js] <br/>[🕮 Docs][downsample-docs-js] <br/>[📦 Package][downsample-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][downsample-docs-py] <br/>[📦 Package][downsample-package-py]
22+
* - [![elastix](../static/packages/elastix.png)][elastix-demo-js] [elastix][elastix-repo] <br /> *A toolbox for rigid and nonrigid registration of images.*
23+
- ![js][js-logo] [👨‍💻 Demo][elastix-demo-js] <br/>[🕮 Docs][elastix-docs-js] <br/>[📦 Package][elastix-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][elastix-docs-py] <br/>[📦 Package][elastix-package-py]
24+
* - [![htj2k](../static/packages/htj2k.png)][htj2k-demo-js] [htj2k][htj2k-repo] <br /> *Wasm-SIMD accelerated decoding and encoding High-throughput JPEG2000 (HTJ2K) images.*
25+
- ![js][js-logo] [👨‍💻 Demo][htj2k-demo-js] <br/>[🕮 Docs][htj2k-docs-js] <br/>[📦 Package][htj2k-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][htj2k-docs-py] <br/>[📦 Package][htj2k-package-py]
26+
* - [![image-io](../static/packages/image-io.png)][image-io-demo-js] [image-io][image-io-repo] <br /> *Input and output for scientific and medical image file formats.*
27+
- ![js][js-logo] [👨‍💻 Demo][image-io-demo-js] <br/>[🕮 Docs][image-io-docs-js] <br/>[📦 Package][image-io-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][image-io-docs-py] <br/>[📦 Package][image-io-package-py]
28+
* - [![mesh-io](../static/packages/mesh-io.png)][mesh-io-demo-js] [mesh-io][mesh-io-repo]<br /> *Input and output for scientific and medical mesh file formats.*
29+
- ![js][js-logo] [👨‍💻 Demo][mesh-io-demo-js] <br/>[🕮 Docs][mesh-io-docs-js] <br/>[📦 Package][mesh-io-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][mesh-io-docs-py] <br/>[📦 Package][mesh-io-package-py]
30+
* - [![morphological-contour-interpolation](../static/packages/morphological-contour-interpolation.png)][morphological-contour-interpolation-demo-js] [morphological-contour-interpolation][morphological-contour-interpolation-repo] <br /> *Input and output for scientific and medical mesh file formats.*
31+
- ![js][js-logo] [👨‍💻 Demo][morphological-contour-interpolation-demo-js] <br/>[🕮 Docs][morphological-contour-interpolation-docs-js] <br/>[📦 Package][morphological-contour-interpolation-package-js] <br/> <br/> ![py][py-logo] [🕮 Docs][morphological-contour-interpolation-docs-py] <br/>[📦 Package][morphological-contour-interpolation-package-py]
32+
33+
```
34+
35+
[js-logo]: ../static/javascript-logo.svg
36+
[ts-logo]: ../static/typescript-logo.svg
37+
[py-logo]: ../static/python.svg
38+
[gh-logo]: ../static/github.svg
2239

2340
[compare-images-repo]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/packages/compare-images
2441
[compare-images-demo-js]: https://insightsoftwareconsortium.github.io/ITK-Wasm/compare-images/ts/app/

docs/myst.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ project:
2323
- title: File Formats
2424
children:
2525
- file: introduction/file_formats/index.md
26-
- file: introduction/file_formats/dicom.md
2726
- file: introduction/file_formats/images.md
2827
- file: introduction/file_formats/meshes.md
28+
- file: introduction/file_formats/dicom.md
2929
- title: 🔗 Model
3030
children:
3131
- file: model/index.md

docs/static/links-spacer.png

160 Bytes
Loading
19.5 KB
Loading
-3.41 KB
Loading

docs/static/packages/dicom.png

-13 KB
Loading

docs/static/packages/downsample.png

-19.1 KB
Loading

docs/static/packages/elastix.png

-33.4 KB
Loading

docs/static/packages/htj2k.png

-9 KB
Loading

docs/static/packages/image-io.png

-18.7 KB
Loading

docs/static/packages/mesh-io.png

-7.4 KB
Loading
Loading

0 commit comments

Comments
 (0)