Skip to content

Commit 04c79b0

Browse files
committed
docs(mesh-io): add point set functions to typescript docs
1 parent 06b188e commit 04c79b0

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

packages/mesh-io/typescript/README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Import:
2525
import {
2626
readMesh,
2727
writeMesh,
28+
readPointSet,
29+
writePointSet,
2830
byuReadMesh,
2931
byuWriteMesh,
3032
freeSurferAsciiReadMesh,
@@ -45,6 +47,16 @@ import {
4547
wasmWriteMesh,
4648
wasmZstdReadMesh,
4749
wasmZstdWriteMesh,
50+
objReadPointSet,
51+
objWritePointSet,
52+
offReadPointSet,
53+
offWritePointSet,
54+
vtkPolyDataReadPointSet,
55+
vtkPolyDataWritePointSet,
56+
wasmReadPointSet,
57+
wasmWritePointSet,
58+
wasmZstdReadPointSet,
59+
wasmZstdWritePointSet,
4860
setPipelinesBaseUrl,
4961
getPipelinesBaseUrl,
5062
} from "@itk-wasm/mesh-io"
@@ -114,6 +126,70 @@ async function writeMesh(
114126
| `webWorker` | *Worker* | WebWorker used for computation. |
115127
| `serializedMesh` | *BinaryFile* | Output mesh |
116128

129+
#### readPointSet
130+
131+
*Read a pointSet file format and convert it to the itk-wasm file format*
132+
133+
```ts
134+
async function readPointSet(
135+
serializedPointSet: File | BinaryFile,
136+
options: ReadPointSetOptions = {}
137+
) : Promise<ReadPointSetResult>
138+
```
139+
140+
| Parameter | Type | Description |
141+
| :--------------: | :-------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
142+
| `serializedPointSet` | *File | BinaryFile* | Input pointSet serialized in the file format |
143+
144+
**`ReadPointSetOptions` interface:**
145+
146+
| Property | Type | Description |
147+
| :---------------: | :-------: | :-------------------------------------------------- |
148+
| `informationOnly` | *boolean* | Only read image metadata -- do not read pixel data. |
149+
| `webWorker` | *null or Worker or boolean* | WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to `false` to run in the current thread / worker. |
150+
| `noCopy` | *boolean* | When SharedArrayBuffer's are not available, do not copy inputs.
151+
152+
**`ReadPointSetResult` interface:**
153+
154+
| Property | Type | Description |
155+
| :---------: | :--------------: | :----------------------------------------------------------------------- |
156+
| `webWorker` | *Worker* | WebWorker used for computation. |
157+
| `pointSet` | *PointSet* | Output pointSet |
158+
159+
#### writePointSet
160+
161+
*Write an itk-wasm file format converted to an pointSet file format*
162+
163+
```ts
164+
async function writePointSet(
165+
pointSet: PointSet,
166+
serializedPointSet: string,
167+
options: WritePointSetOptions = {}
168+
) : Promise<WritePointSetResult>
169+
```
170+
171+
| Parameter | Type | Description |
172+
| :--------------: | :-------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
173+
| `pointSet` | *PointSet* | Input pointSet |
174+
| `serializedPointSet` | *string* | Output pointSet |
175+
176+
**`WritePointSetOptions` interface:**
177+
178+
| Property | Type | Description |
179+
| :---------------: | :-------: | :------------------------------------------------------- |
180+
| `informationOnly` | *boolean* | Only write image metadata -- do not write pixel data. |
181+
| `useCompression` | *boolean* | Use compression in the written file, if supported |
182+
| `binaryFileType` | *boolean* | Use a binary file type in the written file, if supported |
183+
| `webWorker` | *null or Worker or boolean* | WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to `false` to run in the current thread / worker. |
184+
| `noCopy` | *boolean* | When SharedArrayBuffer's are not available, do not copy inputs.
185+
186+
**`WritePointSetResult` interface:**
187+
188+
| Property | Type | Description |
189+
| :--------------: | :--------------: | :-------------------------------------------------------------------------- |
190+
| `webWorker` | *Worker* | WebWorker used for computation. |
191+
| `serializedPointSet` | *BinaryFile* | Output pointSet |
192+
117193
#### byuReadMesh
118194

119195
*Read a mesh file format and convert it to the itk-wasm file format*
@@ -799,6 +875,10 @@ Import:
799875

800876
```js
801877
import {
878+
readMeshNode,
879+
writeMeshNode,
880+
readPointSetNode,
881+
writePointSetNode,
802882
byuReadMeshNode,
803883
byuWriteMeshNode,
804884
freeSurferAsciiReadMeshNode,
@@ -819,6 +899,16 @@ import {
819899
wasmWriteMeshNode,
820900
wasmZstdReadMeshNode,
821901
wasmZstdWriteMeshNode,
902+
objReadPointSetNode,
903+
objWritePointSetNode,
904+
offReadPointSetNode,
905+
offWritePointSetNode,
906+
vtkPolyDataReadPointSetNode,
907+
vtkPolyDataWritePointSetNode,
908+
wasmReadPointSetNode,
909+
wasmWritePointSetNode,
910+
wasmZstdReadPointSetNode,
911+
wasmZstdWritePointSetNode,
822912
} from "@itk-wasm/mesh-io"
823913
```
824914

0 commit comments

Comments
 (0)