add help docs and ?
This commit is contained in:
23
docs/nodes/Statistics.md
Normal file
23
docs/nodes/Statistics.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Statistics
|
||||
|
||||
Compute basic surface statistics: min, max, mean, RMS roughness, median, and skewness. Equivalent to gwy_data_field_get_min/max/avg/rms.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|------|------|----------|-------------|
|
||||
| field | DATA_FIELD | Yes | Input field to analyze |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
|------|------|-------------|
|
||||
| stats | RECORD_TABLE | Table of statistical quantities with values and units |
|
||||
|
||||
## Controls
|
||||
|
||||
None.
|
||||
|
||||
## Limitations
|
||||
|
||||
- None.
|
||||
Reference in New Issue
Block a user