Skip to content

Commit 0f98bb8

Browse files
committed
SNT: document PeripathDetector & re-organize pages
1 parent 7a8f15c commit 0f98bb8

7 files changed

Lines changed: 223 additions & 129 deletions

File tree

_pages/plugins/snt/analysis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Delineations allow measuring proportions of reconstructions within other structu
245245
- Do branches near a lesion site differ from branches further away from it?
246246
- Are there morphological differences across subregions of a neuron's receptive field?
247247

248-
Delineations are described in [Walkthroughs › Delineation Analysis](/plugins/snt/walkthroughs#delineation-analysis).
248+
Delineations are described in [Delineation Analysis](/plugins/snt/delineations).
249249

250250
# Root Angle Analysis
251251
Root angle analysis measures the angular distribution of how far neurites deviate from a direct path to the soma (or root of the neuronal arbor), a functional property that is captured by [Sholl profiles](#sholl-analysis) (see also [angular Sholl](./sholl#angular-sholl)). It quantifies properties such as [balancing factor](./metrics#root-angles-balancing-factor), [centripetal bias](./metrics#root-angles-centripetal-bias), and [mean direction](./metrics#root-angles-mean-direction). It is described in:
@@ -267,7 +267,7 @@ The analysis can be performed from the [Analysis menu](/plugins/snt/manual#root-
267267

268268
# Growth Analysis
269269

270-
Growth Analysis provides detailed time-lapse analysis of neuronal patterns and requires traced paths to be matched across time frames, as detailed in the [Time-lapse analysis](./walkthroughs#time-lapse-analysis) walkthrough. The Analysis is accessed through the [Path Manager](./manual#path-manager)'s [Time-lapse Utilities](./manual#time-lapse-utilities-) menu.
270+
Growth Analysis provides detailed time-lapse analysis of neuronal patterns and requires traced paths to be matched across time frames, as detailed in the [Time-lapse analysis](./walkthroughs#time-lapse-analysis) walkthrough. The Analysis is accessed through the [Path Manager](./manual#path-manager)'s [Time-lapse Utilities](./manual#time-lapses-) menu.
271271

272272
{% capture timelapse-demo%}
273273
For parameter validation and configuration comparisons, load the _Hippocampal neuron (DIC timelapse)_ demo dataset ({% include bc path='File|Load Demo Dataset...' %})

_pages/plugins/snt/delineations.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: SNT › Delineation Analysis
3+
nav-links: true
4+
nav-title: Delineations
5+
name: Delineation Analysis
6+
categories: [Contours,Analysis,Neuroanatomy]
7+
artifact: org.morphonets:SNT
8+
icon: /media/icons/snt.png
9+
forum-tag: snt
10+
update-site: Neuroanatomy
11+
doi: 10.1038/s41592-021-01105-7
12+
tags: snt,tracing,neuroanatomy,contours
13+
---
14+
15+
16+
{% capture version%}
17+
**This page was last revised for [version 5.0.6](https://github.com/morphonets/SNT/releases)**.
18+
{% endcapture %}
19+
{% include notice content=version %}
20+
21+
# Delineation Analysis
22+
Delineations aggregate sections of reconstructions into groups to allow measuring proportions of paths within other structures defined by ROIs or neuropil annotations (e.g., cortical layers, biomarkers, or counterstaining landmarks). Delineation analyses can be applied to disconnected paths, a single cell, or multiple cells. Some of the questions that delineation analyses can answer include:
23+
24+
- Do branching patterns of neurons change along strata (cell layers)?
25+
- What is the total dendritic/axonal length contained within a cortical layer?
26+
- Do branches near a lesion site differ from branches further away from it?
27+
- Are there morphological differences across subregions of a neuron's receptive field?
28+
29+
{% capture ml-demo %}
30+
You can use the _MouseLight dendrites_ demo dataset to follow the delineation tutorials. While this dataset does not include counterstaining images, it can still be used for both ROI-based and Atlas-based delineations:
31+
32+
1. Open {% include bc path='File|Load Demo Dataset...' %} and choose _MouseLight dendrites (Reconstructions only)_
33+
2. Right-click on the _Display Canvas_ and choose _Pause SNT_ from the contextual menu
34+
3. Follow the instructions below
35+
{% endcapture %}
36+
{% include notice icon="info" content=ml-demo %}
37+
38+
<div align="center">
39+
<img src="/media/plugins/snt/snt-delineation-analysis1.png" alt="Delineation Analysis: MouseLight dendrites demo dataset delineated by cortical layers " title="Delineation Analysis: MouseLight dendrites demo dataset delineated by cortical layers " width="650" />
40+
</div>
41+
42+
## Creating Delineations from ROIs
43+
The most common way to generate delineations is by means of ROIs:
44+
45+
1. Activate the _Delineations_ tab in the [main dialog](/plugins/snt/manual#delineations-tab)
46+
47+
2. Pause SNT by right-clicking on the image and choose "Pause SNT" from the contextual menu
48+
49+
3. Create an area ROI. _Any_ area ROI is supported (freehand, polygon, wand-defined, rectangular, oval, etc.)
50+
51+
4. Press the _Assign_ button. Sections of paths with XY coordinates contained by the ROI are colored by the delineation label. Note that assignments propagate to all Z-coordinates within the ROI
52+
53+
5. Optional: If you prefer, press the <i class="fas fa-pen"></i> icon and type a new label in the _name_ field You can also change the delineation color by clicking its color tag
54+
55+
6. Repeat this process as needed until all paths of interest have been tiled by a delineation. If needed, visibility of previously assigned ROIs can be toggled using the <i class="fas fa-eye"></i> button
56+
57+
7. Proceed to [Measuring Delineations](#measuring-delineations)
58+
59+
ROIs generated programmatically or in bulk outside SNT can be applied in a single step using _Import Assignments from ROI Manager_ from the Options (gear) menu. This command will parse each area ROI in the ROI Manager as an assignment ROI. The delineation name and color will be retrieved directly from ROIs that have been renamed or colored (either stroke or fill color).
60+
61+
62+
## Creating Delineations from Atlas Annotations
63+
Delineations can also be created from [neuropil annotations](/plugins/snt/analysis#atlas-based-analysis) using the _Import Assignments from Atlas Annotation_ option from the Options (gear) menu. In this case delineations are created from selected brain compartments associated with the cell(s) being analyzed. Note that this requires cells to be tagged by atlas annotations. Currently only cells downloaded directly from the MouseLight database fulfill this criterion.
64+
65+
66+
## Editing Delineations
67+
To re-define a delineation it is sufficient to re-define or re-adjust an existing ROI and press the _Assign_ button. The Options (gear) menu lists commands for rebuilding, restoring, and deleting delineations. Most of the editing operations can be performed through the toolbar at the bottom of the delineations list, including:
68+
- <i class="fas fa-plus"></i> Adds more entries to the delineations list
69+
- <i class="fas fa-object-group"></i> Merges two or more delineations into one
70+
- <i class="fas fa-swatchbook"></i> Applies one of the default color schemes to the delineations list
71+
- <i class="fas fa-pen"></i> Enables/Disables direct editing of delineation names
72+
- _Outside color_ widget: Defines the color for non-delineated sections, i.e., those sections that remain _outside_ delineated areas
73+
74+
75+
## Measuring Delineations
76+
77+
Measurements are retrieved using the <i class="fas fa-chart-bar"></i> _Plot_ and <i class="fas fa-table"></i> _Measure_ buttons:
78+
79+
- <i class="fas fa-chart-bar"></i> _Plot_: Plots distributions of selected metrics. Plotting styles include: Box plots (one delineation per category), multi-series histograms (one delineation per series), or a montage of single-series histograms (one panel per delineation)
80+
- <i class="fas fa-table"></i> _Measure_: Reports common metrics to a dedicated table (Total length, No. of nodes, No. of junctions, etc.) across delineations
81+
82+
In addition to defined delineations, plots and tables may include two other categories:
83+
84+
- _Non-delineated_: This category corresponds to all the path sections that remained in-between or outside delineations. _Non-delineated_ sections are labeled by [outside color](#editing-delineations)
85+
86+
- _Unaffected paths_: This category corresponds to full paths that have no XY coordinates inside any delineation. _Unaffected paths_ retain their rendered colors
87+
88+
{% include notice icon="info" content="Topological constraints may not allow certain metrics to be computed for a particular delineation. E.g., a metric that requires a [graph-theoretic tree](./analysis#graph-based-analysis) may not be computed for a delineation defined by a non-contiguous ROI." %}

_pages/plugins/snt/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ See [Sholl Analysis › FAQ](./sholl#faq).
112112
## Spine Analysis
113113

114114
### Does SNT support spine analysis?
115-
See [Spine/Varicosity Analysis](./walkthroughs#spinevaricosity-analysis). In-depth quantification of spine morphology can be done using [Spot Spine](/plugins/spot-spine), after tracing dendrites in SNT.
115+
See [Spine/Varicosity Analysis](./spines-varicosities). In-depth quantification of spine morphology can be done using [Spot Spine](/plugins/spot-spine), after tracing dendrites in SNT.
116116

117117

118118
## Soma Analysis
119119

120120
### Can SNT reconstruct somata?
121-
Yes, see [Autotracing › Soma/Root Detection](./auto-tracing#somaroot-detection). Note, however, that most SNT tutorials favor the [single-point soma representation](https://neuromorpho.org/SomaFormat.html).
121+
Yes, see [Autotracing › Soma/Root Detection](./auto-tracing#somaroot-detection). Note, however, that most SNT tutorials favor the [single-point soma representation](https://neuromorpho.org/SomaFormat.html).

_pages/plugins/snt/key-shortcuts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The [Command Palette](manual#command-palette) ({% include key keys='ctlcmd|Shift
3131
### Interactive Prompt
3232

3333
| {% include key key='C' %} | <u>C</u>ancels a path. Note that you can finish a path by pressing {% include key key='N' %} {% include key key='N' %} twice |
34-
| {% include key key='F' %} | <u>F</u>inishes a path. Note that you can finish a path by pressing {% include key key='Y' %} {% include key key='Y' %} twice |
34+
| {% include key key='F' %} | <u>F</u>inishes a path. Note that you can finish a path by pressing {% include key key='Y' %} {% include key key='Y' %} twice or using {% include key keys='Double Click' %}|
3535
| {% include key key='N' %} | Discards the current temporary path. *Mnemonic: <u>N</u>o* |
3636
| {% include key key='Y' %} | Confirms the current temporary path. *Mnemonic: <u>Y</u>es* |
3737
| {% include key key='Esc' %}| Aborts current operation / Exits current mode |

_pages/plugins/snt/manual.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ The Legacy 3D Viewer is a functional tracing canvas and allows images to be trac
557557

558558
## Bookmarks Tab
559559

560-
This tab hosts the Bookmark Manager, a utility that stores image locations to be (re)visited during tracing (e.g., a location of an ambiguous branching point or an ambiguous cross-over between two neurites). Bookmarked locations can also be used as [spine/varicosity markers](/plugins/snt/walkthroughs#spinevaricosity-analysis). The basic usage is as follows:
560+
This tab hosts the Bookmark Manager, a utility that stores image locations to be (re)visited during tracing (e.g., a location of an ambiguous branching point or an ambiguous cross-over between two neurites). Bookmarked locations can also be used as [spine/varicosity markers](/plugins/snt/spines-varicosities). The basic usage is as follows:
561561

562562
<img align="right" width="300" src="/media/plugins/snt/snt-delineations-tab.png" alt="Delineations tab" title="Delineations tab" />
563563
<img align="right" width="300" src="/media/plugins/snt/snt-bookmarks-tab.png" alt="Bookmarks tab" title="Bookmarks tab" />
@@ -578,7 +578,7 @@ This tab hosts the Bookmark Manager, a utility that stores image locations to be
578578
<span id="delineations-manager"></span>
579579

580580
## Delineations Tab
581-
This tab hosts the Delineations Manager, a utility that allows measuring proportions of paths within other structures defined by ROIs or neuropil annotations (e.g., cortical layers, biomarkers, or counterstaining landmarks). Delineation analyses are described in detail in [Walkthroughs › Delineation Analysis](/plugins/snt/walkthroughs#delineation-analysis).
581+
This tab hosts the Delineations Manager, a utility that allows measuring proportions of paths within other structures defined by ROIs or neuropil annotations (e.g., cortical layers, biomarkers, or counterstaining landmarks). Delineation analyses are described in detail in [Delineation Analysis](/plugins/snt/delineations).
582582

583583
<span id="notepad"></span>
584584

@@ -823,7 +823,7 @@ Assigns a constant radius to all the nodes of selected Path(s). This setting onl
823823

824824
#### Specify No. Spine\Varicosity Markers...
825825

826-
Assigns the no. of markers (e.g., spines or varicosities) to be associated to selected path(s) (see [Spine/Varicosity Analysis](/plugins/snt/walkthroughs#spinevaricosity-analysis)).
826+
Assigns the no. of markers (e.g., spines or varicosities) to be associated to selected path(s) (see [Spine/Varicosity Analysis](/plugins/snt/spines-varicosities)).
827827

828828
#### Ramer-Douglas-Peuker Downsampling...
829829

@@ -1057,11 +1057,11 @@ NB:
10571057

10581058
- *Integration metric* The statistics (Mean, Median, Sum, etc.) integrating pixel intensities within *shape*.
10591059

1060-
#### Spine/Varicosity Utilities
1060+
#### Spines/Varicosities
10611061

1062-
This menu contains commands tools for analyzing at manually placed markers along paths such as dendritic spines or axonal varicosities. The starting point for such analyses are multipoint ROIs placed along paths. These are detailed in [Step-by-step instructions](/plugins/snt/walkthroughs#spinevaricosity-analysis).
1062+
This menu contains commands tools for analyzing at manually placed markers along paths such as dendritic spines or axonal varicosities. The starting point for such analyses are multipoint ROIs placed along paths. These are detailed in [Spine/Varicosity Analysis](/plugins/snt/spines-varicosities).
10631063

1064-
#### Time-lapse Utilities
1064+
#### Time-lapses
10651065

10661066
This menu contains commands tools for analyzing time-lapse videos, and assume that the same structure has been traced across multiple frames. Refer to [Step-by-step instructions](/plugins/snt/walkthroughs#time-lapse-analysis) for more details.
10671067

0 commit comments

Comments
 (0)