Skip to content

Commit 172a4a8

Browse files
committed
snt: correct outdated sections
1 parent 310fd19 commit 172a4a8

2 files changed

Lines changed: 28 additions & 18 deletions

File tree

‎_pages/plugins/snt/curation.md‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Assistant panel is organized into four regions:
3232

3333
1. **[Live Monitoring Parameters](#live-monitoring-parameters)**: Lightweight checks that run inline during interactive tracing (at fork initiation, segment completion, path finalization, and node editing)
3434
2. **[On-Demand Monitoring Parameters](#on-demand-monitoring-parameters)**: More computationally intensive checks that scan the full reconstruction when explicitly triggered
35-
3. **[Toolbar](#toolbar-actions)**: Action buttons and options menu for calibration and presets
35+
3. **[Toolbar](#toolbar-actions)**: Action buttons and options for calibration and presets
3636
4. **[Issues Table](#issues-table)**: Displays current issues sorted by severity and/or impact. Double-click a row to navigate to the warning location in the image
3737

3838

@@ -156,7 +156,19 @@ A dropdown with two sections:
156156
- **Show**: Checkboxes for each severity level (_Errors_, _Warnings_, _Advisory Notes_) controlling which categories appear in the table
157157
- **Sort**: A _Sort by Impact (descending)_ toggle that orders the issues by impact fraction, highest first. Useful for triage when you want consequential issues at the top. Clicking a column header manually overrides it until re-enabled
158158

159-
### <i class="fas fa-cog"></i> Options Menu
159+
### <i class="fas fa-toolbox"></i> Utilities Menu
160+
A dropdown listing commands listing conveninence actions:
161+
162+
- **Visiting Zoom Level ›**: Configures the zoom applied when double-clicking a warning to navigate.
163+
164+
- **Color Paths by Issue Severity**: For each issue, color codes affected paths by severity: <span style="font-weight: bold;color:#FF6565;">Error</span>, <span style="font-weight: bold;color:#FFD654;">Warning</span>, or <span style="font-weight: bold;color:#4DA0FF;">Advisory Note</span>
165+
166+
- **Seed Reviews**:
167+
- **Mark Affected Path(s) As ›**: Tags the path(s) referenced by the selected warning(s) as _positive_, _negative_, or _follow-up_ examples for [seed-review workflows](#seed-review)
168+
- **Show Reviewed Paths in Path Manager**: Switches focus to the Path Manager and filters its list to paths carrying any `cur:*` review tag.
169+
170+
171+
### <i class="fas fa-cog"></i> Calibration Menu
160172
A dropdown listing commands for parameter [calibration](#calibrating-parameters): from [existing reconstructions](#calibrating-thresholds-from-traced-cells), [built-in](#built-in-presets), or [user](#user-presets) presets.
161173

162174
## Issues Table
@@ -172,13 +184,9 @@ Default order is by severity descending (_Errors_ → _Warnings_ → _Advisory N
172184
**Double-click** a row to navigate to the warning's spatial location in the image. The view centers on the affected node and zooms to the configured visiting zoom level (table's contextual menu).
173185

174186
**Right-click** the table for:
175-
176187
- **Copy Issue Description**: Copies selected issues (or all rows when nothing is selected) to the clipboard as tab-separated text including severity, message, and affected path names
177188
- **Help on Issue...**: Opens this documentation page anchored to the section describing the selected check
178189
- **Clear All Issues**: Empties the table
179-
- **Mark Affected Path(s) As ›**: Tags the path(s) referenced by the selected warning(s) as _positive_, _negative_, or _follow-up_ examples for [seed-review workflows](#seed-review)
180-
- **Show Reviewed Paths in Path Manager**: Switches focus to the Path Manager and filters its list to paths carrying any `cur:*` review tag.
181-
- **Visiting Zoom Level ›**: Configures the zoom applied when double-clicking a warning to navigate.
182190
- **Detach Table**: Pops the issues table out into a separate floating window so it can be docked elsewhere or kept visible while the main panel is used for other tasks.
183191

184192
# Understanding Impact
@@ -201,11 +209,11 @@ For fork-point warnings involving both a parent and child path, the **child** is
201209
A striking feature of the Curation Assistant is that the threshold of each validation parameter can be calibrated with fine granularity using known ground-truth data from multiple sources: existing files, built-in presets, or user presets. It is also possible to fine-tune thresholds by inspecting the distributions of traced paths.
202210

203211
## Calibrating Thresholds from Traced Cells
204-
Calibrates the Assistant from existing reconstructions. Available via the [Options Menu](#options-menu), {% include bc path='Calibrate Thresholds from Traced Cells...'%}: the command opens a file chooser for selecting reconstruction files. The selected cells are loaded, and all thresholds are inferred from their morphological statistics using percentile analysis (5<sup>th</sup> percentile for lower-bound thresholds, 95<sup>th</sup> percentile for upper-bound).
212+
Calibrates the Assistant from existing reconstructions. Available via the [Utilities Menu](#utilities-menu), {% include bc path='Calibrate Thresholds from Traced Cells...'%}: the command opens a file chooser for selecting reconstruction files. The selected cells are loaded, and all thresholds are inferred from their morphological statistics using percentile analysis (5<sup>th</sup> percentile for lower-bound thresholds, 95<sup>th</sup> percentile for upper-bound).
205213
The calibrated values are applied to the panel immediately. See [Advanced Curation Tasks](#advanced-curation-tasks) for details on the underlying algorithm.
206214

207215
## Built-in Presets
208-
Calibrates the Assistant from NeuroMorpho reference data and provides sensible starting points for common cell types. Available via the [Options Menu](#options-menu) {% include bc path='Built-in Presets'%} list:
216+
Calibrates the Assistant from NeuroMorpho reference data and provides sensible starting points for common cell types. Available via the [Utilities Menu](#utilities-menu) {% include bc path='Built-in Presets'%} list:
209217
Selecting a preset loads its thresholds and enabled states into the panel. Presets include:
210218

211219
| Preset | Cell type | Species | Publication(s) | NeuroMorpho archive |
@@ -222,17 +230,18 @@ Selecting a preset loads its thresholds and enabled states into the panel. Prese
222230

223231

224232
## User Presets
225-
Calibrates the Assistant from your own data. Available via the [Options Menu](#options-menu) {% include bc path='User Presets'%} list, automatically populated from preset files (`.curation` extension) found in the `curations/` subdirectory of the SNT workspace (typically `~/SNT_workspace/curations/`). This section of the menu also includes commands to manage presets:
233+
Calibrates the Assistant from your own data. Available via the [Calibration Menu](#utilities-menu) {% include bc path='User Presets'%} list, automatically populated from preset files (`.curation` extension) found in the `curations/` subdirectory of the SNT workspace (typically `~/SNT_workspace/curations/`). This section of the menu also includes commands to manage presets:
226234

227235
- **Create From Current Parameters...** Saves the current thresholds and enabled states to a new `.curation` file (described [here](./extending#curation-file-format)).
228236
- **Reload User Presets**: Rescans the curations directory and refreshes the menu
229237
- **Reveal User Presets Directory**: Opens the curations directory in the system file manager
230238

231239

232240
## Distribution Inspection
233-
Allows you to calibrate the Assistant from all the paths currently listed in the [Path Manager](./manual#path-manager). Next to each parameter spinner is a small histogram button. Clicking it opens a popup showing the distribution of the corresponding metric across the current reconstruction, with:
234241
<img align="right" width="375" src="/media/plugins/snt/snt-curation-distribution.png" alt="Distribution Inspection" title="Calibrating the assistant using distributions" />
235242

243+
Allows you to calibrate the Assistant from all the paths currently listed in the [Path Manager](./manual#path-manager). Next to each parameter spinner is a small histogram button. Clicking it opens a popup showing the distribution of the corresponding metric across the current reconstruction, with:
244+
236245
- Quartile markers (Q1, median, Q3) and a descriptive subtitle reporting _n_, _min_, _max_, _mean_, and _SD_
237246
- A threshold line at the configured spinner value, with the flagged region lightly shaded
238247
- A footer reporting how many units could be evaluated and how many were skipped (e.g., _220/258 forks assessed_)

‎_pages/plugins/snt/scripting.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ update-site: Neuroanatomy
99
---
1010

1111
{% capture version%}
12-
**This page was last revised for [version 5.0.0](https://github.com/morphonets/SNT/releases)**.
12+
**This page was last revised for [version 5.0.11](https://github.com/morphonets/SNT/releases)**.
1313
{% endcapture %}
1414
{% include notice content=version %}
1515

@@ -83,13 +83,14 @@ The REPL has access to _all_ of SNT's API. The prompt does not feature auto-comp
8383

8484
{% highlight java %}
8585
>>> api(snt, "demo")
86-
6 method(s) available in sc.fiji.snt.SNTService:
87-
demoImage(String arg0) -> ImagePlus
88-
demoTree(String arg0) -> Tree
89-
demoTree() -> Tree
90-
demoTreeImage() -> ImagePlus
91-
demoTrees() -> List
92-
demoTreesSWC() -> List
86+
7 method(s) available in sc.fiji.snt.SNTService:
87+
demoImage(String arg0) -> ImagePlus
88+
demoImgPlus(String arg0) -> ImgPlus
89+
demoTree() -> Tree
90+
demoTree(String arg0) -> Tree
91+
demoTreeImage() -> ImagePlus
92+
demoTrees() -> List
93+
demoTreesSWC() -> List
9394
{% endhighlight %}
9495

9596
# Analysis of External Data

0 commit comments

Comments
 (0)