From 5be6f4f6459382cbaa92cc47354ad6306ffb605a Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Thu, 25 Jan 2024 22:13:19 -0500 Subject: [PATCH] DOC: Add some documentation for current methods --- docs/methods.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/docs/methods.md b/docs/methods.md index f83c1a3..1e0706a 100644 --- a/docs/methods.md +++ b/docs/methods.md @@ -28,7 +28,7 @@ The default method. ## `ITKWASM_BIN_SHRINK` -Used the local mean for the output value. +Used the [local mean] for the output value. [WebAssembly] build. Fast but generates more artifacts than gaussian-based methods. @@ -36,6 +36,10 @@ Appropriate for intensity images. ## `ITKWASM_LABEL_IMAGE` +A sample is the mode of the linearly weighted [local labels] in the image. + +Fast and minimal artifacts. For label images. + ## `ITK_GAUSSIAN` Similar to `ITKWASM_GAUSSIAN`, but the package is built to native binaries. @@ -48,14 +52,40 @@ pip install itk-vkfft ## `ITK_BIN_SHRINK` +Used the [local mean] for the output value. Native binary build. + +Fast but generates more artifacts than gaussian-based methods. + +Appropriate for intensity images. + ## `DASK_IMAGE_GAUSSIAN` +Smoothed with a discrete gaussian filter to generate a [scale space], ideal for +intensity images. + +[dask-image] implementation based on [scipy]. + ## `DASK_IMAGE_MODE` +Local mode for label images. + +Fewer artifacts than simple nearest neighbor interpolation. + +Slower. + ## `DASK_IMAGE_NEAREST` +Nearest neighbor for label images. + +Will have many artifacts for high-frequecy content and / or multiple scales. + [aliasing artifacts]: https://en.wikipedia.org/wiki/Nyquist%E2%80%93Shannon_sampling_theorem +[dask-image]: https://image.dask.org/ +[ITK-Wasm]: https://wasm.itk.orghttps://image.dask.org/ +[local mean]: https://doi.org/10.54294/p39qox +[local labels]: https://doi.org/10.54294/nr6iii [SIMD]: https://en.wikipedia.org/wiki/Single_instruction,_multiple_data [scale space]: https://en.wikipedia.org/wiki/Scale_space -[ITK-Wasm]: https://wasm.itk.org +[scipy]: https://scipy.org/ +[WebAssembly]: https://webassembly.org/