Skip to content

Commit 1971a4f

Browse files
thewtexthewtex
committed
docs: add LinkML Model to Myst toctree
1 parent 8d1a3d0 commit 1971a4f

File tree

98 files changed

+2412
-7
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+2412
-7
lines changed

‎docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ The project provides tools to
3535
3636
introduction/packages.md
3737
introduction/parts.md
38+
model/index.md
3839
introduction/file_formats/index.md
3940
```
4041

‎docs/model/BinaryData.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# Class: BinaryData
3+
4+
5+
Represents a contiguous array of bytes.
6+
The data in representations are encoded as:
7+
8+
- WIT: `list<u8>`
9+
- JSON: Data URI `string` with base64 encoding, zstd compression, 'data:application/zstd;base64,[...]'
10+
- C++: C array on the heap
11+
- Python: `numpy.ndarray`
12+
- JavaScript: TypedArray
13+
14+
URI: [wasm:BinaryData](https://w3id.org/itk/wasmBinaryData)
15+
16+
17+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[BinaryFile]++-%20data%201..1>[BinaryData],[BinaryStream]++-%20data%201..1>[BinaryData],[Image]++-%20data%200..1>[BinaryData],[Image]++-%20direction%201..1>[BinaryData],[Mesh]++-%20cellData%200..1>[BinaryData],[Mesh]++-%20cells%200..1>[BinaryData],[Mesh]++-%20pointData%200..1>[BinaryData],[Mesh]++-%20points%200..1>[BinaryData],[PolyData]++-%20cellData%200..1>[BinaryData],[PolyData]++-%20lines%200..1>[BinaryData],[PolyData]++-%20pointData%200..1>[BinaryData],[PolyData]++-%20points%200..1>[BinaryData],[PolyData]++-%20polygons%200..1>[BinaryData],[PolyData],[Mesh],[Image],[BinaryStream],[BinaryFile])](https://yuml.me/diagram/nofunky;dir:TB/class/[BinaryFile]++-%20data%201..1>[BinaryData],[BinaryStream]++-%20data%201..1>[BinaryData],[Image]++-%20data%200..1>[BinaryData],[Image]++-%20direction%201..1>[BinaryData],[Mesh]++-%20cellData%200..1>[BinaryData],[Mesh]++-%20cells%200..1>[BinaryData],[Mesh]++-%20pointData%200..1>[BinaryData],[Mesh]++-%20points%200..1>[BinaryData],[PolyData]++-%20cellData%200..1>[BinaryData],[PolyData]++-%20lines%200..1>[BinaryData],[PolyData]++-%20pointData%200..1>[BinaryData],[PolyData]++-%20points%200..1>[BinaryData],[PolyData]++-%20polygons%200..1>[BinaryData],[PolyData],[Mesh],[Image],[BinaryStream],[BinaryFile])
18+
19+
## Referenced by Class
20+
21+
* **None** *[➞data](binaryFile__data.md)* <sub>1..1</sub> **[BinaryData](BinaryData.md)**
22+
* **None** *[➞data](binaryStream__data.md)* <sub>1..1</sub> **[BinaryData](BinaryData.md)**
23+
* **None** *[➞data](image__data.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
24+
* **None** *[➞direction](image__direction.md)* <sub>1..1</sub> **[BinaryData](BinaryData.md)**
25+
* **None** *[➞cellData](mesh__cellData.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
26+
* **None** *[➞cells](mesh__cells.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
27+
* **None** *[➞pointData](mesh__pointData.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
28+
* **None** *[➞points](mesh__points.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
29+
* **None** *[➞cellData](polyData__cellData.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
30+
* **None** *[➞lines](polyData__lines.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
31+
* **None** *[➞pointData](polyData__pointData.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
32+
* **None** *[➞points](polyData__points.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
33+
* **None** *[➞polygons](polyData__polygons.md)* <sub>0..1</sub> **[BinaryData](BinaryData.md)**
34+
35+
## Attributes
36+
37+
38+
## Other properties
39+
40+
| | | |
41+
| --- | --- | --- |
42+
| **Mappings:** | | wasm:BinaryData |
43+

‎docs/model/BinaryFile.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
# Class: BinaryFile
3+
4+
5+
Representation of a binary file on a filesystem. For performance reasons, use BinaryStream when possible, instead of BinaryFile.
6+
7+
URI: [wasm:BinaryFile](https://w3id.org/itk/wasmBinaryFile)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[BinaryData]<data%201..1-++[BinaryFile&#124;path:string],[InterfaceType]^-[BinaryFile],[BinaryData])](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[BinaryData]<data%201..1-++[BinaryFile&#124;path:string],[InterfaceType]^-[BinaryFile],[BinaryData])
11+
12+
## Parents
13+
14+
* is_a: [InterfaceType](InterfaceType.md) - An interface type is a higher-level type that represents the structure of data that can be passed between WebAssembly modules and the host environment.
15+
16+
## Attributes
17+
18+
19+
### Own
20+
21+
* [path](path.md) <sub>1..1</sub>
22+
* Description: The filename or path.
23+
* Range: [String](types/String.md)
24+
* [➞data](binaryFile__data.md) <sub>1..1</sub>
25+
* Description: The content of the binary file.
26+
* Range: [BinaryData](BinaryData.md)
27+
28+
## Other properties
29+
30+
| | | |
31+
| --- | --- | --- |
32+
| **Mappings:** | | wasm:BinaryFile |
33+

‎docs/model/BinaryStream.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
# Class: BinaryStream
3+
4+
5+
Representation of a binary stream. For performance reasons, use BinaryStream when possible, instead of BinaryFile.
6+
7+
URI: [wasm:BinaryStream](https://w3id.org/itk/wasmBinaryStream)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[BinaryData]<data%201..1-++[BinaryStream],[InterfaceType]^-[BinaryStream],[BinaryData])](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[BinaryData]<data%201..1-++[BinaryStream],[InterfaceType]^-[BinaryStream],[BinaryData])
11+
12+
## Parents
13+
14+
* is_a: [InterfaceType](InterfaceType.md) - An interface type is a higher-level type that represents the structure of data that can be passed between WebAssembly modules and the host environment.
15+
16+
## Attributes
17+
18+
19+
### Own
20+
21+
* [➞data](binaryStream__data.md) <sub>1..1</sub>
22+
* Description: The content of the binary stream.
23+
* Range: [BinaryData](BinaryData.md)
24+
25+
## Other properties
26+
27+
| | | |
28+
| --- | --- | --- |
29+
| **Mappings:** | | wasm:BinaryStream |
30+

‎docs/model/DoubleList.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# Class: DoubleList
3+
4+
5+
Representation of a sequence of doubles.
6+
7+
URI: [wasm:DoubleList](https://w3id.org/itk/wasmDoubleList)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[DoubleList&#124;values:double%20%2B])](https://yuml.me/diagram/nofunky;dir:TB/class/[DoubleList&#124;values:double%20%2B])
11+
12+
## Attributes
13+
14+
15+
### Own
16+
17+
* [➞values](doubleList__values.md) <sub>1..\*</sub>
18+
* Description: The content of the double sequence.
19+
* Range: [Double](types/Double.md)
20+
21+
## Other properties
22+
23+
| | | |
24+
| --- | --- | --- |
25+
| **Mappings:** | | wasm:DoubleList |
26+

‎docs/model/FloatList.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# Class: FloatList
3+
4+
5+
Representation of a sequence of floats.
6+
7+
URI: [wasm:FloatList](https://w3id.org/itk/wasmFloatList)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[FloatList&#124;values:float%20%2B])](https://yuml.me/diagram/nofunky;dir:TB/class/[FloatList&#124;values:float%20%2B])
11+
12+
## Attributes
13+
14+
15+
### Own
16+
17+
* [➞values](floatList__values.md) <sub>1..\*</sub>
18+
* Description: The content of the float sequence.
19+
* Range: [Float](types/Float.md)
20+
21+
## Other properties
22+
23+
| | | |
24+
| --- | --- | --- |
25+
| **Mappings:** | | wasm:FloatList |
26+

‎docs/model/FloatTypes.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# Enum: FloatTypes
3+
4+
5+
Float types.
6+
7+
URI: [wasm:FloatTypes](https://w3id.org/itk/wasmFloatTypes)
8+
9+
10+
## Other properties
11+
12+
| | | |
13+
| --- | --- | --- |
14+
15+
## Permissible Values
16+
17+
| Text | Description | Meaning | Other Information |
18+
| :--- | :---: | :---: | ---: |
19+
| float32 | | | |
20+
| float64 | | | |
21+

‎docs/model/Image.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
# Class: Image
3+
4+
5+
Representation of an N-dimensional scientific image.
6+
7+
URI: [wasm:Image](https://w3id.org/itk/wasmImage)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[ImageType],[BinaryData]<data%200..1-++[Image&#124;name:string;origin:double%20%2B;spacing:double%20%2B;size:integer%20%2B;metadata:string],[BinaryData]<direction%201..1-++[Image],[ImageType]<imageType%201..1-++[Image],[InterfaceType]^-[Image],[BinaryData])](https://yuml.me/diagram/nofunky;dir:TB/class/[InterfaceType],[ImageType],[BinaryData]<data%200..1-++[Image&#124;name:string;origin:double%20%2B;spacing:double%20%2B;size:integer%20%2B;metadata:string],[BinaryData]<direction%201..1-++[Image],[ImageType]<imageType%201..1-++[Image],[InterfaceType]^-[Image],[BinaryData])
11+
12+
## Parents
13+
14+
* is_a: [InterfaceType](InterfaceType.md) - An interface type is a higher-level type that represents the structure of data that can be passed between WebAssembly modules and the host environment.
15+
16+
## Attributes
17+
18+
19+
### Own
20+
21+
* [➞imageType](image__imageType.md) <sub>1..1</sub>
22+
* Description: Type of the image.
23+
* Range: [ImageType](ImageType.md)
24+
* [➞name](image__name.md) <sub>1..1</sub>
25+
* Description: Name of the image.
26+
* Range: [String](types/String.md)
27+
* [➞origin](image__origin.md) <sub>1..\*</sub>
28+
* Description: Location of the center of the first pixel in physical space.
29+
x, y, z, ... order.
30+
* Range: [Double](types/Double.md)
31+
* [➞spacing](image__spacing.md) <sub>1..\*</sub>
32+
* Description: Size of a pixel in physical space.
33+
x, y, z, ... order.
34+
* Range: [Double](types/Double.md)
35+
* [➞direction](image__direction.md) <sub>1..1</sub>
36+
* Description: Orientation of the pixel grid in physical space.
37+
Encoded as float64 binary data in column-major order of length NxN where N is the spatial dimension of the image. x, y, z, ... order.
38+
* Range: [BinaryData](BinaryData.md)
39+
* [➞size](image__size.md) <sub>1..\*</sub>
40+
* Description: Number of image pixels in each dimension.
41+
x, y, z, ... order.
42+
* Range: [Integer](types/Integer.md)
43+
* [➞metadata](image__metadata.md) <sub>1..1</sub>
44+
* Description: Metadata for the image.
45+
* Range: [String](types/String.md)
46+
* [➞data](image__data.md) <sub>0..1</sub>
47+
* Description: Content of the image pixels.
48+
Encoded in column-major order, i.e. contiguous x. Multi-component pixels are interleaved.
49+
* Range: [BinaryData](BinaryData.md)
50+
51+
## Other properties
52+
53+
| | | |
54+
| --- | --- | --- |
55+
| **Mappings:** | | wasm:Image |
56+

‎docs/model/ImageType.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
# Class: ImageType
3+
4+
5+
Representation of an N-dimensional scientific image type.
6+
7+
URI: [wasm:ImageType](https://w3id.org/itk/wasmImageType)
8+
9+
10+
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Image]++-%20imageType%201..1>[ImageType&#124;dimension:integer;componentType:string;pixelType:PixelTypes;components:integer],[Image])](https://yuml.me/diagram/nofunky;dir:TB/class/[Image]++-%20imageType%201..1>[ImageType&#124;dimension:integer;componentType:string;pixelType:PixelTypes;components:integer],[Image])
11+
12+
## Referenced by Class
13+
14+
* **None** *[➞imageType](image__imageType.md)* <sub>1..1</sub> **[ImageType](ImageType.md)**
15+
16+
## Attributes
17+
18+
19+
### Own
20+
21+
* [dimension](dimension.md) <sub>1..1</sub>
22+
* Description: Number of spatial dimensions.
23+
* Range: [Integer](types/Integer.md)
24+
* [componentType](componentType.md) <sub>1..1</sub>
25+
* Description: Type of binary data components in a pixel.
26+
* Range: [String](types/String.md)
27+
* [pixelType](pixelType.md) <sub>1..1</sub>
28+
* Description: Type of the pixel or attribute.
29+
* Range: [PixelTypes](PixelTypes.md)
30+
* [components](components.md) <sub>1..1</sub>
31+
* Description: Number of components in a pixels.
32+
* Range: [Integer](types/Integer.md)
33+
34+
## Other properties
35+
36+
| | | |
37+
| --- | --- | --- |
38+
| **Mappings:** | | wasm:ImageType |
39+

‎docs/model/IntTypes.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
# Enum: IntTypes
3+
4+
5+
Integer types.
6+
7+
URI: [wasm:IntTypes](https://w3id.org/itk/wasmIntTypes)
8+
9+
10+
## Other properties
11+
12+
| | | |
13+
| --- | --- | --- |
14+
15+
## Permissible Values
16+
17+
| Text | Description | Meaning | Other Information |
18+
| :--- | :---: | :---: | ---: |
19+
| int8 | | | |
20+
| uint8 | | | |
21+
| int16 | | | |
22+
| uint16 | | | |
23+
| int32 | | | |
24+
| uint32 | | | |
25+
| int64 | | | |
26+
| uint64 | | | |
27+

0 commit comments

Comments
 (0)