Docs: Intrins now require units.

This commit is contained in:
2026-04-03 21:57:41 -04:00
parent 156da322b6
commit 5811af7cb1
2 changed files with 70 additions and 70 deletions
+10 -9
View File
@@ -46,15 +46,16 @@ Each stim-buff-api is designed to work with specific stim-iface libraries that u
**Intrinsic Stimuli Support** (for pcloudAmbience quale-iface-api):
The `pcloudAmbience` quale-iface-api exports both a postrin and a negtrin whose
thresholds are configurable via standard quale-iface-api-params:
- **Postrin interest threshold**: Configurable via `postrin-interest-percentage` / `postrin-interest-pc` / `postrin-interest` (default: 90, interpreted as percentage)
- **Negtrin interest threshold**: Configurable via `negtrin-interest-percentage` / `negtrin-interest-pc` / `negtrin-interest-threshold` / `negtrin-interest-th` / `negtrin-interest` (default: 30)
- **Postrin interest threshold**: Configurable via `postrin-interest-[percentage|pc|threshold|thresh|thr]`
- **Negtrin interest threshold**: Configurable via `negtrin-interest-[percentage|pc|threshold|thresh|thr]`
The postrin interest threshold is percentage-based only (0-100) and specifies the
percentage of frames whose average intensity must be <= the ambience intensity low
value threshold. Frames whose average intensity is <= the ambience intensity low
value qualify for postrin, and frames whose average intensity is >= the negtrin
interest threshold qualify for negtrin. The ambience count written to each stimFrame
is the number of frames that qualify for either intrinsic.
The `-percentage` and `-pc` variants take percentages in the range
`0-100`. The `-threshold`, `-thresh`, and `-thr` variants take an
absolute number whose interpretation is defined by the API library
itself. Users should specify only one unit-suffixed variant per targeted
intrinsic threshold; if multiple such variants are supplied, the
lattermost one takes precedence. Shorthand forms without a unit suffix
are not valid.
### 3. Point Cloud Coordinate Data Device (Extrospector)
@@ -258,4 +259,4 @@ The specification includes comprehensive error handling for:
- Invalid coordinate format requests
- IMU data stream interruptions
- Device discovery failures
- Connection retry timeouts
- Connection retry timeouts