Skip to content

Commit

Permalink
Merge pull request #66 from thewtex/doc-methods
Browse files Browse the repository at this point in the history
DOC: Add some documentation for current methods
  • Loading branch information
thewtex authored Jan 26, 2024
2 parents bcf03ba + 5be6f4f commit f16f650
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions docs/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,18 @@ 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.

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.
Expand All @@ -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/

0 comments on commit f16f650

Please sign in to comment.