add help docs and ?

This commit is contained in:
2026-03-30 23:10:42 -07:00
parent ced43bec4f
commit 63d76bac72
76 changed files with 2184 additions and 1 deletions

View File

@@ -0,0 +1,28 @@
# Spot Removal
Fill defect pixels (hot pixels, dropouts, scan artifacts) by interpolation. The mask defines defect locations. Equivalent to Gwyddion spotremove.c.
## Inputs
| Name | Type | Required | Description |
|------|------|----------|-------------|
| field | DATA_FIELD | Yes | Input field with defect pixels |
| mask | IMAGE | No | Binary mask marking defect pixel locations; if omitted, no inpainting is performed |
## Outputs
| Name | Type | Description |
|------|------|-------------|
| result | DATA_FIELD | Field with defect pixels replaced by interpolated values |
## Controls
| Name | Type | Default | Description |
|------|------|---------|-------------|
| method | dropdown | laplace | Inpainting method: laplace (smooth Laplace equation solution), mean (local mean), or zero |
| max_iter | INT | 100 | Maximum number of iterations for the Laplace solver (12000) |
## Limitations
- Large masked regions may not converge fully within max_iter iterations using the Laplace method.
- The mean method uses a simple neighbourhood average and may leave visible discontinuities at large defect clusters.