-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re: #887
- Loading branch information
Showing
77 changed files
with
2,484 additions
and
24 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17 KB
packages/core/python/itkwasm/docs/_static/packages/compress-stringify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+275 KB
...ages/core/python/itkwasm/docs/_static/tutorial/debugging/debug-cxx-devtools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+49.9 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/devtools-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+47.2 KB
.../core/python/itkwasm/docs/_static/tutorial/debugging/emscripten-build-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+29.1 KB
...ore/python/itkwasm/docs/_static/tutorial/debugging/emscripten-build-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+40.5 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/emscripten-build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+106 KB
...python/itkwasm/docs/_static/tutorial/debugging/enable-chrome-wasm-debugging.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+113 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/http-server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+179 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/lldb-wasi-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+96.2 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/native-build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+154 KB
...ages/core/python/itkwasm/docs/_static/tutorial/debugging/native-debug-linux.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+178 KB
...ython/itkwasm/docs/_static/tutorial/debugging/node-inspect-chrome-dev-tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+45.1 KB
...e/python/itkwasm/docs/_static/tutorial/debugging/node-inspect-remote-target.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+21.7 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/node-inspect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+136 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/path-substitution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+80.5 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/run-node-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+112 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/run-node-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+45.5 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/run-wasi-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+88.2 KB
packages/core/python/itkwasm/docs/_static/tutorial/debugging/wasi-build-debug.png
Oops, something went wrong.
Binary file added
BIN
+27.6 KB
packages/core/python/itkwasm/docs/_static/tutorial/hello_pipeline.png
Oops, something went wrong.
Binary file added
BIN
+6.84 KB
packages/core/python/itkwasm/docs/_static/tutorial/hello_wasm_world.png
Oops, something went wrong.
Binary file added
BIN
+22.8 KB
packages/core/python/itkwasm/docs/_static/tutorial/inputs_outputs_help.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+26.6 KB
packages/core/python/itkwasm/docs/_static/umd/umd_select_load_data_spec.png
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Installation | ||
|
||
Building WebAssembly pipelines is driven by the `itk-wasm` Node.js command line executable, which drives builds, run tests, and generates interface bindings. Install with: | ||
|
||
```sh | ||
npm install -g itk-wasm | ||
``` | ||
|
||
For more information and guidance on installation, see [the tutorial | ||
Introduction](../tutorial/hello_world?id=introduction). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# Interface Types | ||
|
||
itk-wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/src/core/InterfaceTypes.ts): | ||
|
||
- [TextFile](../typescript/interface_types/TextFile) | ||
- [BinaryFile](../typescript/interface_types/BinaryFile) | ||
- [TextStream](../typescript/interface_types/TextStream) | ||
- [BinaryStream](../typescript/interface_types/BinaryStream) | ||
- [Image](../typescript/interface_types/Image) | ||
- [Mesh](../typescript/interface_types/Mesh) | ||
- [PolyData](../typescript/interface_types/PolyData) | ||
- [JsonObject](../typescript/interface_types/JsonObject) | ||
|
||
These interfaces types are supported in the [Emscripten interface](../typescript/browser_pipelines), [WASI](https://wasi.dev/) embedding interfaces, and native or virtual [filesystem IO](../introduction/file_formats/index). They are intended to be forward-compatible with the [WebAssembly Component Model](https://github.com/WebAssembly/component-model). | ||
|
||
--- | ||
|
||
The following [CLI11](https://github.com/CLIUtils/CLI11) [`itk::wasm::Pipeline`](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/include/itkPipeline.h) components can be included in a C++ to ingest and produce these interface types. For `Input` types, use `Get()` to get the corresponding C++ object value after `ITK_WASM_PARSE_ARGS` is called. For `Output` types, use `Set(value)` to output the value before `main` exits. For example, | ||
|
||
```cpp | ||
#include "itkPipeline.h" | ||
#include "itkInputTextStream.h" | ||
#include "itkOutputTextStream.h" | ||
|
||
int main(argc, char * argv[]) | ||
{ | ||
itk::wasm::Pipeline pipeline("test-pipeline", "A test ITK Wasm Pipeline", argc, argv); | ||
|
||
itk::wasm::InputTextStream inputTextStream; | ||
pipeline.add_option("InputText", inputTextStream, | ||
"The input text")->required()->type_name("INPUT_TEXT_STREAM"); | ||
|
||
itk::wasm::OutputTextStream outputTextStream; | ||
pipeline.add_option("OutputText", outputTextStream, | ||
"The output text")->required()->type_name("OUTPUT_TEXT_STREAM"); | ||
|
||
|
||
ITK_WASM_PARSE(pipeline); | ||
|
||
|
||
const std::string inputTextStreamContent{ std::istreambuf_iterator<char>(inputTextStream.Get()), | ||
std::istreambuf_iterator<char>() }; | ||
|
||
outputTextStream.Get() << inputTextStreamContent; | ||
} | ||
``` | ||
<dl> | ||
<dt><b><code>itk::wasm::InputTextStream</code></b><dt><dd>A string. To reader this data type in C++, using the resulting <a href="https://www.cplusplus.com/reference/istream/istream/">std::istream</a>.</dd> | ||
</dl> | ||
*todo: document remaining CLI11 input and output classes.* | ||
For binding generation, set the `type_name` an the options accordingly. The type names are: | ||
- `INPUT_TEXT_FILE` | ||
- `OUTPUT_TEXT_FILE` | ||
- `INPUT_BINARY_FILE` | ||
- `OUTPUT_BINARY_FILE` | ||
- `INPUT_TEXT_STREAM` | ||
- `OUTPUT_TEXT_STREAM` | ||
- `INPUT_BINARY_STREAM` | ||
- `OUTPUT_BINARY_STREAM` | ||
- `INPUT_IMAGE` | ||
- `OUTPUT_IMAGE` | ||
- `INPUT_MESH` | ||
- `OUTPUT_MESH` | ||
- `INPUT_POLYDATA` | ||
- `OUTPUT_POLYDATA` |
Oops, something went wrong.