Skip to content, Skip to search

Changes

SNT: Manual

30,870 bytes added, 15 August
m
Tiago moved page SNT: Overview to SNT: Manual: Improve naming consistency
{{SNTNavBar}}[[Category:SNT]][[Category:Neuroanatomy]]<div class="toclimit-2">=Main=Startup Prompt=This tab aggregated widgets [[Image:SNT-Startup-Prompt.png|right|thumb]]SNT is initialized by running {{bc|Plugins|NeuroAnatomy|SNT...}}. All the options in the startup prompt can be set once SNT is opened, but the startup prompt provides the convenience of setting the most important parameters at once.* '''Image'''/'''Image File''' The image to be traced/analyzed. The drop-down menu will list all images currently open in ImageJ. Alternatively, an image path may be specified by clicking ''Browse'' and choosing an image file. If no image is chosen, SNT will create an empty display canvas from the computed bounding box of the reconstruction file (if provided).* '''Reconstruction file''' The path of the reconstruction file to be imported. SNT will automatically try to guess if there is a reconstruction file associated with the chosen image by looking at all the reconstruction files (<tt>.traces</tt>, <tt>.(e)swc</tt>, or <tt>.json</tt>) in the image directory, and choosing one that more [https://en.wikipedia.org/wiki/Levenshtein_distance closely matches] the image filename.* '''User interface''' Specifies which views to display for tracing 3D images. The default setting provides the XY, ZY, and XZ views and frequent operationsallows for more [[SNT:_Step-By-Step_Instructions#Accurate_Point_Placement|accurate node placement]] but requires more RAM.* '''Tracing Channel''' Specifies the image channel to trace on (this option is ignored with single-channel images).
=Main Dialog==Cursor Auto-snapping=Menu Commands=====File===If active (the default) the cursor snaps to the brightest voxel in its vicinity. To accomplish this, SNT takes the cuboid of the specified dimensions (in pixels) centered on the current cursor position and searches quickly Lists commands for local maxima in that neighborhood, moving the cursor to that positionI/O operations. The ZMost are self-plane in which the maximum was found is automatically selected if the "Z" parameter is greater than 0explanatory. Noteworthy:* This feature assumes the signal is brighter than the background as typically found in fluorescent images.* If multiple maxima exist (e.g., when the signal is saturated), it snaps to their centroid.[[FileImage:cursorSNT-snapFrom-Open-Image-Prompt.png|right|borderthumb|200px|]]* {{bc|Choose Tracing Image|&nbsp;}} Specifies the image to trace on without having to restart SNT. To streamline trace on an image currently open in ImageJ, use ''From Open Image...''. A prompt with the computation: currently open images will appear, allowing selection of one. XYZ dimensions are constrained To browse for an image file, use ''From File...''. You should toggle the ''validate spatial calibration'' checkbox to ensure the image to even numbers and limited rangebe imported is compatible with the existing one. * Snapping occurs in 2D {{bc|Import| Labels (iAmiraMesh).e..}} This option assumes you are tracing on the same spatial coordinates of an annotated neuropil, for which compartments have been segmented (''labeled'') and stored in the active plane) if Z=0an [https://amira.* The XZ, ZY views are synchronized when 3D snapping is active (izib.ede/ Amira] labels file.Once loaded, Z>0)SNT will report the name of the compartments in the ImageJ status bar when hovering over the image.
===Auto-tracing===By default, SNT uses the [https://en.wikipedia.org/wiki/A*_search_algorithm A* search algorithm] to automatically construct paths between two manually selected points. To manually place each node in a path, toggle this feature off. [[FileImage:SNT-autoMouseLight-tracingRemote-Loader-Prompt.png|right|thumb|Auto-tracing dialog200px|]]A quick way to improve the quality and efficiency * {{bc|Import| Remote Databases|&nbsp;}} Allows import of neuronal reconstructions from the pathfinding is to enable "Hessian-based analysis"[http://www.flycircuit.tw/ FlyCircuit], which filters the image for tube-like structures. Two parameters need to be chosen[https:* '''Sigma''' //ml- Controls the spatial scale of the filteringneuronbrowser. A lower value of sigma will capture small structural details but is more sensitive to noisejanelia. A larger value of sigma will consider larger scale structure, but may be less sensitive to local shape characteristicsorg/ MouseLight] and [http://neuromorpho. It is generally advisable to pick a value which reflects the average radius of the structures you are tracing.* '''Maximum''' - The maximum pixel intensity on the ''Tubeness'' image beyond which the cost function for A* search is minimizedorg/ NeuroMorpho] remote databases.
These parameters may be chosen "Manually" * {{bc|Export (if you already have a quantitative understanding All Paths)|&nbsp;}} Allows export of all traced paths in the image) or "Visually" (generally more intuitive). If you choose "Visually"[[SNT:_FAQ#swc|SWC]] file format, the dialog will prompt most common format for representing neuronal reconstructions. Note that you to click on a representative portion can also export subsets of paths using the image which has meaningful structure[[#Path Manager|Path Manager]]. Once you click thereAdditionally, useful numeric properties of paths can be stored in a 9-square palette will be generated showing increasing values of sigma (from top-left to bottom-right) applied to that chunk of CSV file by choosing the image''CSV Properties.[[File:Sigma-palette-location.png|left|thumb|400px|Representative region in image]].'' export option.<div align="rightleft">
<ul>
<li style="display:inline-block;"> [[Image:SigmaSNT-palettePath-max.png|none|thumb|250px|Adjusted Max - oversaturated]] </li><li style="display:inline-block;"> [[Image:Sigma-paletteCSV-mid.png|none|thumb|250px|Adjusted Max Properties- default]] </li><li style="display:inlineExample-block;"> [[Image:Sigma-palette-minSpreadsheet.png|none|thumb|250px600px|Adjusted Max - undersaturatedOP_1 CSV Properties snapshot in LibreOffice]] </li>
</ul>
</div>
{{clear}}
Experiment with moving the "Adjusted Max" slider to find a setting which captures the important structures you are interested in, while taking care to avoid over or under-saturation. In the former case, the search might consider pixels outside of the tubular structures. In the latter case, the search might take longer or not finish at all, since each pixel will carry greater cost than it should. It is usually safe to choose a value somewhere near the median. Once you have chosen this value, click on the square in the palette with the sigma that best fits your application (its border will turn green) then press "Apply". The parameters will be transferred to the interface and a Gaussian convolution will be run over the image, which may take some time depending on its size. Once it's done, path-finding will occur on the Hessian image. To display this image during tracing, go to {{bc | View | Show Hessian (Tubeness) Image}} from the SNT dialog.
[[File:original-hessian-side-by-side.png|center|thumb|600px|Original (left) and Hessian (right)]]
===Tracing on Filtered ImageUtilities===SNT's "Hessian-based analysis" option provides * {{bc|Quick Measurements|}} Shows a convenient and easy way to pre-process your datatable with summary statistics for all existing paths. However, if your data requires tailored pre-processing, you may also choose to trace on a user-specified filtered image. For exampleTo measure only selected paths, one might use {{bc|Analyze|Measure}} in the [https://linkPath Manager.springer* {{bc|Sholl Analysis.com/content/pdf/10.1007%252FBFb0056195.pdf Frangi et al. 1998}} Shows a help menu which describes how to conduct [[Simple_Neurite_Tracer:_Sholl_analysis|Sholl Analysis]] method to enhance vessel-like structuresfrom within SNT on existing paths.<div align="left"><ul> <li style===A Single "display:inline-block;"> [[Image====:SNT-Sholl-Analysis-How-to-Menu.png|none|thumb|200px]] </li></ul></div>To process a single image, load your image ("test.tif", say) into Fiji and select * {{bc | Process | Filters | Frangi VesselnessStrahler Analysis}}Conducts Strahler Analysis on existing paths, producing a table of analysis results and a Strahler plot. (There is more information about this plugin <div align="left"><ul> <li style="display:inline-block;"> [[FrangiImage:SNT-Strahler-Analysis-Table.png|on its pagenone|thumb|200px|Strahler Analysis table for OP_1]].) By way of example, let's say that you select two scales, from twice the x voxel separation to five times that value. We apply a Gaussian convolution at each scale. Assuming your image has isotropic resolution, the parameters would look like this.</li><li style="display:inline-block;"> [[FileImage:frangiSNT-Strahler-Analysis-parametersPlot.png|centernone|thumb|Frangi parameters200px|Strahler Analysis plot for OP_1]]</li></ul>Save </div>* {{bc|Reconstruction Plotter...}} Plots a dynamic 2D projection of all existing paths. A control panel is included which allows adjustment of the result by doing spatial orientation of the tracing. If paths are assigned color tags, use {{bc | File Actions| Save AsRender final (colorized) plot}} with from the same extension as control panel to render the original image ("teststatic) plot with color-filtered.tif", for example). Thenmapped paths, with SNT open, go to the main dialog tab and look for final orientation matching that of the dynamic plot.<div align="Tracing on Filtered Imageleft". Click ><ul> <li style="Browse" to load the filtered image, select display:inline-block;"> [[Image:SNT-Reconstruction-Plotter-Example.png|none|thumb|200px]] </li><li style=" for the parser and press display:inline-block;"Load> [[Image:SNT-Reconstruction-Plotter-Controls.png|none|thumb|200px]] </li><li style=". Finally, toggle the display:inline-block;"Trace on filtered > [[Image" checkbox:SNT-Reconstruction-Plotter-Colored.png|none|thumb|200px]] </li></ul></div>* {{bc|Compare Reconstructions... Now the path-finding will occur }} Given two input reconstruction files, runs ''Quick Measurements'' on the filtered imageboth and generates a plot with summary statistics, allowing for quick morphometric comparisons.<div align="centerleft">
<ul>
<li style="display:inline-block;"> [[Image:filteredSNT-imageCompare-load.png|none|thumb|300px|Step 1]] </li><li style="display:inline-block;"> [[Image:filtered-imageReconstructions-toggleTable.png|none|thumb|300px600px|Step 2Comparison of OP_1 and OP_2]] </li>
</ul>
</div>
To display the image, from the SNT dialog go to {{bc | View | Show Filtered Imageclear}}[[File:display===Scripts===TBD===View===Contains commands for organizing tracing views on screen, plus commands for displaying cached data used for auto-filtered-imagetracing.png|center|thumb|500px|Side-by-side original and filtered images]]
====Preprocess Multiple * '''Arrange Views''' Resets the view pane on-screen positions to their default.* '''Hide Tracing Canvas''' Allows toggling of the visibility of the three view panes as well as the Legacy 3D View window.* '''Show Cached ''Filtered Image''''' Displays the cached filtered image in a separate window. Note a filtered image must be loaded in order to use this feature. The process of loading a filtered image is detailed in [[SNT:_Step-By-Step_Instructions#Generating_Filtered_Images|Generating Filtered Images====]].* '''Show Cached ''Hessian Tubeness Image''''' Displays the cached ''Hessian (Tubeness) image'' in a separate window. Note there are two ways to enable this feature. Either 1) enable ''Hessian-based analysis'' then run the ''Cache All Hessian Computations'' command from the "Auto-tracing" gear drop-down menu or 2) use the ''Load Precomputed "Tubeness" Image'' option in the same gear menu. These features are detailed in the "Auto-tracing" section of the [[SNT:_Overview#Main_Dialog|Main Dialog]] overview guide.
The easiest way to preprocess multiple images is to record a macro ==Main Tab==This home tab aggregated widgets for processing a single images, tracing and then wrap it it in a loop to iterate over all the files in a directoryfrequent operations. For example:
<source lang===Cursor Auto-snapping==='''Enable Snapping checkbox''' If active (the default) the cursor snaps to the brightest voxel in its vicinity (Toggling shortcut: {{Key|S}}). To accomplish this, SNT takes the cuboid of the specified dimensions (in pixels) centered on the current cursor position and searches quickly for local maxima in that neighborhood, moving the cursor to that position. The Z-plane in which the maximum was found is automatically selected if the "javaZ">parameter is greater than 0. Noteworthy:* This feature assumes the signal is brighter than the background as typically found in fluorescent images.[[File:cursor-snap.png|right|border]]d = getDirectory* If multiple maxima exist ("Select a directory"e.g., when the signal is saturated);, it snaps to their centroid.files * To streamline the computation: XYZ dimensions are constrained to even numbers and limited range.* Snapping occurs in 2D (i.e., in the active plane) if Z= getFileList0.* The XZ, ZY views are synchronized when 3D snapping is active (di.e., Z>0);.
extension = "==Auto-tracing===[[File:SNT-auto-tracing.png|right|thumb]]'''Enable A* search algorithm''' By default, SNT uses the [https://en.wikipedia.org/wiki/A*_search_algorithm A* search] to automatically trace paths between two manually selected points. To manually place nodes in a path, toggle this feature off. Note that it is also possible to enable other algorithms through the installation of SNT add-ons. See [[SNT: Tubular Geodesics|Tubular Geodesics]] for details.tif";
for'''Hessian-based analysis''' ( i = 0; i < files.length; ++i ) Toggling shortcut: { filename = files[i]; if( endsWith(filename,extension) ) { l = lengthOf(filenameKey|H}}); el = lengthOf(extension); basename = substring(filenameA quick way to improve the quality and efficiency of the pathfinding is to enable this feature, in which paths are computed after filtering the image for tube-like structures. Upon such filtering,0SNT will use a measure of [[Tubeness]] at each point of the image to define the best path through it,l-el); expected_window_name = "vesselness based on eigenvalues and eigenvectors of "+filename; output_filename = d + Filethe [https://en.separator + basename + "wikipedia.tubesorg/wiki/Hessian_matrix Hessian matrix].tif"; open(filename); run("Frangi Vesselness (imglib, experimental)", "number=1 minimum=0The later can be used to infer the likelihood that a point in the image belongs to a tube-like structure.288387 maximum=0This concept is also known as ''vesselness'' or ''neuriteness''.288387"); selectWindow(expected_window_name); saveAs("Tiff", output_filename); }}</source>
'''Hessian options''' (Specified in the ''gear'' drop-down menu) may be chosen ''Manually'' (if you already have a quantitative understanding of the image) or ''Visually'' (generally more intuitive). Hessian analysis requires two parameters to be specified:* '''Sigma''' Controls the spatial scale of the filter. A lower ''sigma'' (σ) will capture small scale structure but is more sensitive to noise. A larger σ will consider larger scale structures but is less sensitive to local shape characteristics. It is generally advised to pick a value which reflects the average radius of the structures to be traced. It corresponds to the standard deviation of the 3D Gaussian kernel used to smooth the image prior to ''Tubeness'' filtering* '''Maximum''' The maximum pixel intensity on the ''Tubeness'' image beyond which the cost function for A* search is minimized.If you choose ''Visually'', the dialog will prompt you to click on a representative region of the image which has meaningful structure. Once you click there, a 9-square palette is generated showing increasing values of sigma (from top-left to bottom-right) applied to that region of the image. The palette is an image stack which can be scrolled through with the mouse wheel.<center>{||-||colspan="3" style="text-align:center;font-size:90%" |Adusting max|-| [[Image:Sigma-palette-location.png|thumb|200px]]| [[Image:Sigma-palette-max.png|none|thumb|200px]]| [[Image:Sigma-palette-mid.png|none|thumb|200px]]| [[Image:Sigma-palette-min.png|none|thumb|200px]]|-|style=Filters for Visibility of Paths"text-align:center;font-size:90%" | |style="text-align:center;font-size:90%" |Oversaturated|style="text-align:center;font-size:90%" |Default|style="text-align:center;font-size:90%" |Undersaturated|-|colspan="4" style="text-align:center;font-size:90%" |Choosing ''sigma'' and ''max.'' parameters visually for hessian analysis from a representative region in the image (orange box). With saturated ''max'', the cost function for A* search is equivalent across the signal. Also, note how lower sigma values cause the axon to be dimmer on the center and brighter on the edges, while higher sigma values eliminate detail from the structure.|-|}</center> Experiment with different ''Adjusted max.'' values to find a setting which captures the structures you are interested in while taking care to avoid over or under-saturation. In the former case, the search might consider pixels outside of the tubular structures, giving a less accurate result. In the latter case, the search might take significantly longer, since each pixel will carry greater cost than is reasonable. It is usually safe to choose a value somewhere near the default. Once you have chosen this value, click on the square in the palette with the sigma that best fits your application (its border will turn green) then press "Apply". The parameters will be transferred to the interface and a Gaussian convolution will be run over the image, which may take some time depending on its size. Once it's done, pathfinding will occur on the Hessian (a.k.a. ''Tubeness'') image. Other options are also available in the ''gear'' drop-down menu:* '''Cached Computations (Main/Secondary Image)''' By default SNT computes the Hessian matrix on a "compute-as-you-go" basis, which saves memory but increases the pathfinding time. If you have enough RAM, you can use this set of options to compute the matrix once for the full image and cache the result, which in certain cases, can lead to almost-instantaneous searches. Note that this computation adopts the current values of sigma and max. reported in the widget, so you should adjust those before running this command.* '''Flush Cached Data''' Removes cached data from memory* '''Show Cached "Tubeness Image"''' Displays the ''Tubeness'' data currently cached. Useful for debugging purposes. Also mirrored in {{bc | View | Show Cached/Loaded Hessian (Tubeness) Image}}.[[File:original-hessian-side-by-side.png|center|thumb|400px|OP_1 "Tubeness" image overlay at 80% opacity]]
By default, the entire path ===Tracing on Secondary Image===This is projected onto the current Zone of SNT's most advanced features. [[#Auto-tracing|Hessian-slice. This is useful based analysis]] provides a convenient and easy way to see how much has been completed, and gives a sense of perform auto-tracing on pre-processed data in which voxels defining the overall traced structure are scored by their likelihood of the reconstruction''belonging'' to a tube-like structure. However, SNT provides 3 additional visibility options it is just one approach for "tubeness" classification. What if your data requires different filtering?, or you want to experiment with other approaches?, or the perfect pre-processing algorithm for pathsyour images is not yet available in ImageJ? ''Tracing on Secondary Image'' is the answer to these questions:[[File:PathIt allows you to feed SNT with pre-visibility-filtersprocessed data on which the A*star search will operate.png|right|thumb|Path visibility dialog in SNT "Main" tab]]Here are two specific usages for this option:# *'''Frangi ''Vesselness''Only selected paths (hide deselected)filtering''' For certain datasets Frangi filtering ([https://link.springer.com/content/pdf/10.1007%252FBFb0056195.pdf Frangi et al. 1998]) is more effective than [[Tubeness]] at enhancing tube- Only show paths that have been manually selected like structures in the Path Manger or with image. However, it is more computation intensive, and thus, less suitable to be adopted by the {{Key|G}} key ({{Key|Shift}}+{{Key|G}} to select multiple paths)"compute-as-needed" approach used in Hessian-based analysis. Thus, one can import a pre-computed Frangi-filtered image using this option.# *'''Only nodes within X nearby ZHessian-slicesanalysis at multiple scales''' - Only show nodes within X number Let's consider a structure formed simultaneously by very thick and very thin processes (e.g. axons and dendrites). To trace it one would need to adjust continuously the sigma parameter while tracing. Instead, to trace structures of Z-slices on either side variable diameters more effectively, one could load a copy of the current sliceimage as ''secondary image'', and assign different hessian parameters to both images.# *'''Only paths from active channel/frameAdopting probability maps''' Pre- If tracing on a multi-channel image or an image with a time axisclassified images (using e.g., only show paths from the active channel/frameAny combination of these options may machine learning) could also be toggled at onceloaded here.
===Default Path Colors===Path color in SNT indicates status of the path. The default color indicators are: [[File:Default-path-colors.png|right|thumb|300px|Path color dialog in SNT "Main" tab]][[File:CMYK-color-model.png|right|thumb|300px|CMYK color model]]* <pre style="color: green;font-size:20px">Green</pre> - Finished pathImportantly, this option can be toggled at will, selected for interactionduring tracing.* <pre style="color: #FF00FF;font-size:20px">Magenta</pre> - Finished pathIndeed, deselected meaning it cannot be extended or edited until selected.* <pre style="color: #00FFFF;font-size:20px">Cyan</pre> one can ping- Temporary path segmentpong between ''secondary image'' and main image simply, unconfirmed.* <pre style="color: red;font-size:20px">Red</pre> - Temporary path segmentby pressing {{key|I}}, confirmedthe shortcut for the ''Trace on Secondary '''I'''mage'' checkbox.
The default colors for finished paths '''Secondary Image options''' can be changed to any color specified in the CMYK model. To do so''gear'' drop-down menu, press including commands for Loading/displaying the "Selected" or "Deselected" button under "Default Path Colors" in image file and the SNT "Main" dialog tab.powerful ''Generate Secondary Image'' command:
The "Enforce default colors [[Image:SNT-Tracing-On-Filtered-Image-Gear-Options.png|right|thumb|200px]][[Image:SNT-Generate-Filtered-Image-Prompt.png|right|thumb|200px]]* '''Load Specified File''' Loads the filtered image specified in the ''File'' textbox. * '''Generate Secondary Image''' Enables processing of the currently open image directly from SNT. Three routines are currently supported: ''Frangi'', ''Frangi (ignore color tagswithout Gaussian)" checkbox'' and ''Tubeness''. Supports saving and display of the resulting image. To use the currently open image as the secondary image, when enabledchoose ''None. Duplicate Primary Image''. Noteworthy: It is assumed that the current sigma value in the Auto-tracing widget reflects the size of structures to be filtered. If that is not the case, will force all paths to conform to the default colors specified sigma should be adjusted before running this command.* '''Adjust Min-Max''' Sets the range of pixel intensities used by A* search. * '''Show Cached image''' Displays the "Selected" and "Deselected" color buttonscurrently loaded filtered image in a separate window. Any custom color tags will be ignored until * '''Show Path in File Explorer''' Opens the directory containing the filtered image specified in the ''File'' textbox in the checkbox is toggled OFFFile Explorer GUI.
Selected paths can be assigned custom color tags from See the Path Manager. To do so, go to {{bc | Tag [[SNT:_Step-By-Step_Instructions#Generating_Filtered_Images| Color}} then choose the desired swatch. Each path can be assigned any color. To change color of all paths, deselect all paths first.{{Tip| id = colorGenerating Filtered Images]] walk-swatches|tip = Hover the mouse cursor over a color swatch to display a tooltip with its RGB valuethrough for more details.}}
{{clear}}
 
===Filters for Visibility of Paths===
By default, all the nodes of a path are projected onto the current Z-slice. This is useful to see how much has been completed and gives a sense of the overall structure of the reconstruction. However, SNT provides three additional visibility options for paths:
[[File:Path-visibility-filters.png|right|thumb|"Filters for visibility of paths" widget]]
# '''Only selected paths (hide deselected)''' Only show paths that have been manually selected in the Path Manager or with the {{Key|G}} key ({{Key|Shift}}+{{Key|G}} to select multiple paths).
# '''Only nodes within X nearby Z-slices''' Only highlight nodes within X number of Z-slices on either side of the current slice. The projected skeletons of all paths remain visible.
# '''Only paths from active channel/frame''' If tracing on a multichannel image or an image with a time axis, only show paths from the active channel or frame.
Any combination of these options may be toggled simultaneously. Note that these options do not apply to [[SNT:_Reconstruction_Viewer|Rec. Viewer]] and [[SciView]].
 
===Default Path Colors===
[[File:Default-path-colors.png|right|thumb|300px|]]
[[File:CMYK-color-model.png|right|thumb|300px|CMYK color selection UI]]
By default, finished paths are colored by their selection status (only selected paths can be edited, or extended). The default colors are <font color="#00FF00">Green</font> (selected paths) and <font color="#FF00FF">Magenta</font> (deselected). Default colors can be customized by pressing the respective button in the widget and using the [https://en.wikipedia.org/wiki/CMYK_color_model CMYK color chooser]. For customizing unconfirmed and temporary paths, see the ''Colors'' option in the [[#UI_Interaction|UI Interaction]] widget.
 
'''Enforce default colors (ignore color tags)''' If active, SNT will force all paths to conform to the default "Selected" and "Deselected" color buttons. Any custom color tags will be ignored until the option is toggled off. Note that this options does not apply to [[SNT:_Reconstruction_Viewer|Rec. Viewer]] and [[SciView]].
 
{{Tip| id = coloring-paths|tip = The [[#Path Manager|Path Manager]] offers several ways to colorize Paths: 1) Using {{bc | Tag | Color}} swatches (custom colors can be temporarily assigned to empty swatches, by right-clinking on them) or 2) Using {{bc|Analyze|Color Coding}}, providing morphometric-based [[SNT:_Overview#Analyze|color mapping]]. Note that Path Manager commands are applied to all paths if no no path(s) are selected.
<div align="center">
<ul>
<li style="display:inline-block;"> [[Image:Path-manager-color-tag.png|none|thumb|260px200px|Color tagging]] </li><li style="display:inline-block;"> [[Image:Color-tag-result-2.png|none|thumb|260px200px|Arbitrary path coloring]] </li><li style="display:inline-block;"> [[Image:Color-tag-result-image.png|none|thumb|340px200px|Result]] </li>
</ul>
</div>
{{clear}}
==OptionsTab==
This tab aggregated widgets for advanced settings.
===Data Source===
[[File:SNT-data-source-widget.png|right|thumb|"Data Source" widget]]
If tracing on a multi-dimensional image (i.e., one with multiple data channels and/or a time axis), a particular channel/frame can be loaded into the views by selecting each and pressing the "Reload" button.
===Views===
[[File:SNT-views-widget.png|right|thumb|]]* '''Overlay MIP(s) at X% opacity''' - Overlays the [https://en.wikipedia.org/wiki/Maximum_intensity_projection Maximum Intensity Projection] of the image onto "over" the current Z-slice image canvas at the specified opacity. Overlaid projection is only used as a visualization aid and is ignored by the auto-tracing algorithms. It is rendered using the LUT of the channel currently being traced. To reload the overlay (e.g., in case the image being traced changes during a tracing session) toggle the checkbox twice.{{clear}}<div align="center"><ul> <li style="display:inline-block;"> [[Image:OP1-without-MIP.png|none|thumb|250px|Image without MIP overlay]] </li><li style="display:inline-block;"> [[Image:OP1-with-MIP.png|none|thumb|250px|Image with MIP overlay at 30%]] </li></ul></div>* '''Draw diameters in XY view''' Displays the stored diameter (if any) in the XY view for all existing nodes. Each diameter is drawn as a line segment with length = diameter, which is bisected by the orthogonal tangent vector to the path at that node.
<div align="center">
<ul>
<li style="display:inline-block;"> [[Image:OP1Draw-withoutdiameters-MIPdisabled.png|none|thumb|300px200px|Image without MIP overlayDraw diameters - disabled]] </li><li style="display:inline-block;"> [[Image:OP1Draw-withdiameters-MIPenabled.png|none|thumb|300px200px|Image with MIP overlay at 30%Draw diameters - enabled]] </li>
</ul>
</div>
* '''Draw diameters Apply zoom changes to all views''' If a zoom change is applied to any one of the XY, ZY or XZ views, apply the same change to the two other views if they are open. Since in XY viewImageJ zooming may resize the image window, you can use {{bc|Views|Arrange Views}} to reset their positions* '''Resize Canvas''' - Displays If using a display canvas to view reconstructions, reset its dimensions to the stored diameter default. (Currently, this command is only available for all existing nodesdisplay canvases, to resize an image go to IJ's command {{ bc | Image | Adjust | Canvas Size... Each diameter is drawn as a line with length = diameter which is bisected by }}* '''Display ZY/XZ views''' If currently using the tangent vector of XY only view, display the path at a particular nodeZY and XZ views as well.
===Temporary Paths===
[[File:SNT-temporary-paths-dialog.png|right|thumb|"Temporary Paths" widget]]
* '''Confirm temporary segments''' If active, prompts for either confirmation or denial of whether or not to keep an unconfirmed path segment. If inactive, automatically confirms the path segment created on each left-click after starting a path (first click). Applies to both auto-traced and manually traced path segments. The following two settings are only toggle-able when this setting is active.
** '''Pressing 'Y' twice finishes path''' Finish a temporary path on two successive {{key|Y}} key presses.
** '''Pressing 'N' twice cancels path''' Discard a temporary or unconfirmed path, including the start node, on two successive {{key|N}} key presses.
===UI Interaction===
[[File:SNT-UI-interaction-widget.png|right|thumb|]]
* '''Colors''' Specifies how components should be rendered, including:
**'''Canvas annotations''' The label shown on the top-left corner of the views indicating the state of the UI ("Tracing Paused", "Choosing Sigma", etc.)
**'''Fills''' The pixels that have been reached by the Fill search
**'''Unconfirmed''' and '''Temporary''' paths.
* '''Path nodes rendering scale''' (default scale is inferred from current zoom level) Adjusts the radius of the circles representing path nodes. A path node is rendered as a circle centered at the XYZ coordinate of the point annotation.
* '''Activate canvas on mouse hovering''' If active, moving the mouse cursor over the any of the views automatically brings the view window into focus, allowing it to receive input.
===Misc===
* '''Skip confirmation dialogs''' If active, forgoes the ''Are you sure?'' prompt preceding major actions. Note that this option does not apply to irreversible actions such as deleting paths.
* '''Debug mode''' If active, logs detailed information about actions in the console.
* '''Preferences...''' Allows setting other options, namely:
** Whether the position of dialogs should be remembered across restarts
** Whether [https://en.wikipedia.org/wiki/Gzip Gzip] compression (lossless) should be used to reduce the storage footprint of ".traces" files.
** "Reset Preferences..." Allows the reset of all options to their defaults. A restart of SNT may be required for changes to take effect.
 
== 3D Tab ==
[[File:SNT-3D-Tab.png|right|thumb|300px|"3D" menu tab]]
This tab aggregates widgets related to 3D interaction.
===Reconstruction Viewer===
The Reconstruction Viewer is an advanced OpenGL visualization tool. For performance reasons, some Path Manager changes may need to be synchronized manually from RV controls. To open Reconstruction Viewer with the currently loaded tracings, press ''Open Reconstruction Viewer''. For more information, see the Reconstruction Viewer wiki page.
===Legacy 3D Viewer===
The Legacy 3D Viewer is a functional tracing canvas but it depends on outdated services that are now deprecated. It may not function reliably on recent operating systems. For usage instructions, see [[SNT:_Step-By-Step_Instructions#Tracing_in_the_Legacy_3D_Viewer|Tracing using the Legacy 3D Viewer]].
===SciView===
[[SciView|SciView]] is IJ2's modern replacement for the Legacy 3D Viewer providing 3D visualization and virtual reality capabilities for both images and meshes. It is not yet available in SNT.
{{clear}}
 
 
=Contextual Menu=
Right-clicking on any of the image views will bring up a menu with various editing tools. The corresponding keyboard shortcuts are shown to the right of each option.
[[Image:SNT-Path-Edit-Right-Click-Menu.png|right|thumb|250px|Contextual menu]]
* '''Select Nearest Path''' {{key|G}} or {{key|Shift}}+{{key|G}} Will select the path closest to the mouse cursor.
* '''Fork at Nearest Node''' {{key|Shift}}+{{key|Alt}}+{{key|Left Click}} Creates a fork point at the node closest to the mouse cursor. Once a fork point is made, the branch may be extended as described in [[SNT:_Step-By-Step_Instructions#Branching:_Start_A_Path_On_An_Existing_Path|Step-By-Step Instructions]].
* '''Continue Extending Path''' Allows continued tracing of previously finished paths. Note only one path may be extended at a time. To extend a path: first select it, choose this option, then place additional nodes as shown in [[SNT:_Step-By-Step_Instructions#II._Pick_A_Subsequent_Point|Step-By-Step Instructions]].
* '''Pause SNT''' Waives all keyboard and mouse inputs to ImageJ, allowing you to interleave image processing routines with tracing operations. Note that if the image contents change while SNT is paused, the image should be reloaded so that SNT is aware of the changes. Tracing views are annotated with the ''SNT Paused'' [[SNT:_Overview#UI_Interaction|label]] to indicate this state.
* '''Pause Tracing''' Disables tracing functions until this option is deselected. Tracing views are annotated with the ''Tracing Paused'' [[SNT:_Overview#UI_Interaction|label]] to indicate this state.
* '''Sholl Analysis at Nearest Node''' {{key|Shift}}+{{key|Alt}}+{{Key|A}} Runs the [[Sholl_Analysis|Sholl Analysis]] plugin found in {{bc|Analyze|Sholl|Sholl Analysis (From Tracings)}}. Note the ''Center'' parameter, which sets the center point of the analysis, is left out as this value is given by the selected node.
===Editing Paths===
[[Image:SNT-Path-Edit-Right-Click-Menu-Active.png|right|thumb|250px]]
Pressing ''Edit Path'' with a single path selected will activate ''Edit Mode'', allowing use of the menu options under the ''Edit Path'' option. When ''Edit Mode'' is active, moving the mouse cursor along the path will activate the nearest node and synchronize the current Z-slice to the location of that node. Note that the ability to create new paths is temporarily disabled when in ''Edit Mode''.
* '''Reset Active Node''' Clears the active node from the cursor.
* '''Delete Active Node''' {{key|D}} or {{key|Backspace}} Permanently removes the active node from the path.
* '''Insert New Node At Cursor Position''' {{key|I}} Inserts a new node at the cursor position. The inserted node is placed between the active node and its parent.
* '''Move Active Node to Cursor Position''' {{key|M}} Moves the active node to the cursor position.
* '''Bring Active Node to Current Z-plane''' {{key|B}} Moves the active node to the active Z-plane. Note that the translation is only done in Z. XY positions are unchanged.
* '''Connect To (Start Join)''' Allows two existing paths to be [[SNT:_Step-By-Step_Instructions#Merging.2FJoining_Paths|merged or joined]].
 
=Path Manager=
[[File:SNT-Path-Manager.png|right|thumb|Path Manager]]
The Path Manager dialog displays all existing paths in a hierarchical structure (tree), where one path is "primary" (path 0) and all other paths (paths 1...N) are children of the primary path. The dialog also contains several menus with various editing, tagging, refinement/fitting, filling and analysis options. Paths can be searched by name and/or tags in the text filter, with more sophisticated search capabilities in the Advanced Filtering Menu.
 
==Menu Commands==
===Edit===
* '''Delete''' Removes selected path(s) from the Path Manager.
* '''Rename''' Renames the selected path.
* '''Make Primary''' Makes the selected path the primary path, moving it to the top of the tree. Note that this will alter the reconstruction topology.
* '''Disconnect''' Disconnects the selected path from all of its connections (Undoable operation)
* '''Merge''' Merges the selected paths (at least two) into one. Note the starting node of path ''i'' is merged to the endpoint of path ''i+1''
* '''Specify Radius''' Assigns a constant radius to all the nodes of selected path(s). This setting only applies to unfitted paths and overrides any existing values.
[[File:SNT-Path-Manager-Edit.png|right|thumb|200px|"Edit" menu]]
* '''Ramer-Douglas-Peuker Downsampling''' Given an inputted maximum permitted distance between adjacent nodes, performs [https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm Ramer-Douglas-Peucker] downsampling on the selected path(s).
 
===Tag===
[[File:SNT-Path-Manager-Tag.png|right|thumb|]]
Assigns tags to Paths. Tags are organized in the following categories:
* '''Type''' Type of neurite compartment (''Axon'', ''(Basal) Dendrite'', etc.), as used by the SWC format. It is also possible to pair each type with a color tag by enabling the respective option in {{bc|Tag|Options..}}<br>These tags are considered to be essential annotations and all paths are assigned the ''Undefined''-type tag when created. For this reason they are not eliminated by the ''Remove All Tags'' command.
* '''Color''' A preset swatch color, a custom one chosen from the color chooser. Note that is also possible to assign mapping LUTs using the {{bc|Analyze|Color Coding}} command.
* '''Image Metadata''' Information on hyperstack position details (e.g., channel or frame on which a path was traced).
* '''Morphology''' Morphometric properties, such as ''Path length'', ''Path mean radius'' or ''[[Strahler Analysis|branch order]]''.
* '''Custom''' Ad-hoc comments.
Note that only SWC-type tags are preserved across restarts when saving traces in the SWC format. All others require data to be saved in SNT's own .Traces format.
 
 
===Refine/Fit===
[[File:Fit-manager.png|right|thumb]]
SNT can use the fluorescent signal around traced paths to optimize curvatures and estimate the thickness of traced structures to sub-voxel accuracy. The optimization algorithm uses pixel intensities to fit circular cross-sections around each node. Once computed, fitted cross-sections can be used to: 1) Infer the radius of nodes, and/or 2) refine node positioning, by snapping their coordinates to the cross-section centroid. The {{bc|Refine/Fit|&nbsp;}} menu contains three entries:
[[File:Explore-fit-preview.png|right|thumb|250px|Slice in "Explore/Preview Fit" image stack]]
* '''Fit Paths/Un-fit paths/Apply Existing Fit''' This option will change depending on which paths are currently selected. You can use it to 1) Fit selected paths, 2) un-fit paths that have already been fitted, or 3) apply a generated preview of the fit.
* '''Explore/Preview Fit''' Carves out a region of the image along and around each path node, generating an animated cross-view "fly-through" with the result of the fitting operation. The generated image is annotated with details of the fit: i) Fitted radius; ii) normalized score quantifying the circularity of a node's cross section, and iii) the angle between a node and its parent.
 
* '''Discard Fit''' Deletes the existing fit(s) for the selected path(s), or all fits if no paths are selected.
 
Before computing the fit, SNT will prompt you to specify two parameters:
* '''Type of Refinement''': Either 1) ''Assign radii of fitted cross-sections to nodes'', 2) ''Snap node coordinates to cross-section centroids'', or 1) & 2) ''Assign fitted radii and snap node coordinates''
* '''Max. Radius''' Defines (in pixels) the largest radius allowed in the fit. It constrains the optimization to minimize fitting artifacts caused by neighboring structures. A good rule of thumb is to use 1.5-2x the largest radius in the traced structure. Default is 40 pixels on each side of the path
 
Assuming you chose to fit both centroids and radii, a fitted path might look like the rightmost image below. Notice how the nodes follow the center line of the structure more closely, and how each node now has a non-zero radius approximating that of the traced axon.
<div align="center">
<ul>
<li style="display:inline-block;"> [[Image:Fit-parameter-prompt.png|none|thumb|334px|Fitting parameters]] </li>
<li style="display:inline-block;"> [[Image:Before-fitting.png|none|thumb|350px|Before fitting]] </li>
<li style="display:inline-block;"> [[Image:After-fitting.png|none|thumb|350px|Fitted path]] </li>
</ul>
</div>
 
===Fill===
[[File:SNT-Path-Manager-Fill.png|right|thumb|"Fill" menu]]
* '''Fill Out''' Begins the filling process for selected paths. For detailed instructions see [[SNT:_Step-By-Step_Instructions#Filling|Filling: Step-By-Step Instructions]].
 
===Analyze===
This menu contains several options which provide quick ways to analyze and visualize numerical properties of paths.
[[File:SNT-Path-Manager-Analyze-Menu.png|right|thumb|"Analyze" menu]]
* '''Color Coding''' Assigns color codes to paths based on the chosen metric.
** ''Color by'' Drop-down menu containing the metrics which inform the color mapping.
** ''LUT'' Drop-down menu containing the LUTs (Look Up Tables) that define the color palettes. The LUTs are those that come packaged with ImageJ. The selected LUT is displayed in the color bar directly underneath.
** ''Rec. Viewer Color Map'' If active, opens an instance of the Reconstruction Viewer with the selected paths color coded with the selected LUT.
** ''Rec. Plotter Color Map'' If active, open an instance of the Reconstruction Plotter with the selected paths color coded with the selected LUT.
** ''Remove Existing Color Coding'' Removes existing color coding from the selected paths.
<center>
{|
|-
|colspan="2" style="text-align:center;font-size:90%" |After choosing metric: Branch Order, LUT: Ice, showing the Reconstruction Viewer with the color-mapped OP_1 tracing.
|-
| [[Image:SNT-Path-Manager-Color-Mapper.png|center|thumb|300px|Color Mapper prompt]]
| [[Image:SNT-Color-Mapped-OP1.png|none|center|thumb|300px|OP_1 color-mapped]]
|-
|}
</center>
 
{{clear}}
* '''Distribution Analysis''' Plots a histogram of the selected metric.
** ''Measurement'' - Drop-down menu with the available metrics.
<center>
{|
|-
|colspan="2" style="text-align:center;font-size:90%" |Choosing Branch Order for the measurement.
|-
| [[Image:SNT-Distribution-Analysis.png|center|thumb|300px|Distribution Analysis prompt]]
| [[Image:SNT-Branch-Order-Histogram.png|none|center|thumb|250px|Branch Order histogram]]
|-
|}
</center>
{{clear}}
* '''Measure''' Shows a table of summary statistics for selected paths. If measuring multiple tracings, the table can be sorted by column.
[[File:SNT-Path-Manager-Measurements.png|center|thumb|1000px|Measurements table for OP_1]]
{{clear}}
* '''Convert to ROIs''' Allows conversion of paths to [https://imagej.nih.gov/ij/docs/guide/146-10.html#sec:Selections-Intro ROIs] (Regions of Interest). Creates an instance of the [https://imagej.nih.gov/ij/docs/guide/146-30.html#fig:The-ROI-Manager ROI Manager]
** ''Convert'' Drop-down menu specifying the compartment to convert.
** ''View'' Drop-down menu specifying which view to overlay the ROIs.
** ''Impose SWC colors''
** ''Adopt path diameter as line thickness''
** ''Discard existing ROIs in ROI Manager''
<center>
{|
|-
|colspan="2" style="text-align:center;font-size:90%" |Converting paths to ROIs with the default parameters.
|-
| [[Image:SNT-Convert-To-ROIs.png|center|thumb|300px|Convert to ROIs prompt]]
| [[Image:SNT-ROI-Manager.png|none|center|thumb|250px|ROI Manager]]
|-
|}
</center>
{{clear}}
* '''Plot Profile''' Uses the pixel intensity values under point annotations to generate a pixel intensity vs. distance plot for selected paths.
<center>
{|
|-
|colspan="2" style="text-align:center;font-size:90%" |Intensity profile for Path 0 of OP_1.
|-
| [[Image:SNT-Path-Profile-Graph.png|center|thumb|400px|]]
|-
|}
</center>
{{clear}}
* '''Skeletonize''' Outputs a binary image that is a topographic skeleton, ie, it generates an empty (zero-filled) image of the same dimensions of the one being traced, then paints a pixel at each node coordinates following the topographic rules of bitmap skeletons in which fork points, tips and slab voxels are determined by voxel connectivity.
** ''Roi filtering''
*** ''None''
*** ''Convert only segments contained by ROI''
** ''Run "Analyze Skeleton" after conversion'' Runs the [[AnalyzeSkeleton]] plugin on the skeletonized output image.
<center>
{|
|-
|colspan="2" style="text-align:center;font-size:90%" |Converting paths to a topographic skeleton with default parameters.
|-
| [[Image:SNT-Path-Manager-Skeletonize.png|center|thumb|300px|Skeletonize prompt]]
| [[Image:SNT-Projected-Skeleton-OP1.png|none|center|thumb|250px|Skeleton of OP_1, Z-projected]]
|-
|}
</center>
{{clear}}
* '''Save as SWC''' Exports selected paths as an [http://www.neuronland.org/NLMorphologyConverter/MorphologyFormats/SWC/Spec.html SWC] file. Note the paths to be exported must include a primary path (i.e., one a the top level in the Path Manager tree).
{{clear}}
 
==Filter Toolbar==
[[File:SNT-Path-Manager-Text-Filter.png|right|thumb|]]
The filter toolbar allows paths to be searched and filtered quickly using tags (colors, annotations, SWC-type, etc.) or morphometric properties. The text field is used for text-based searches (recent searches can be recovered through its drop-down menu). The [[File:SNT-Text-Filter-Up-Arrow-Button.png]] and [[File:SNT-Text-Filter-Down-Arrow-Button.png]] buttons find the next/previous occurrence of the entered phrase (shortcuts: {{key|up}} {{key|down}}), while the [[File:SNT-Text-Filter-Balloon-Button.png]] button highlights all occurrences of the entered phrase. Settings for advance text-based filtering can be accessed through the [[File:SNT-Text-Filter-Advanced-Button.png]], including wildcard support, case sensitive matching, and replace-by-pattern. In addition, the ''Advanced Filtering Menu'' [[File:SNT-Text-Filter-Advanced-Button.png]] provides other sophisticated means of filtering paths:
[[File:SNT-Path-Manager-Text-Filter-Color-Filters.png|right|thumb|"Color Filters" menu]]
* '''Color Filters''' Allows filtering of paths by color tags. Custom colors may be selected by right-clicking an empty swatch, which will bring up the CMYK palette. The chosen color is temporarily saved in that swatch.
* '''Morphology Filters''' Allows filtering of paths by selected morphological properties. Note that these filters do not require paths to be labeled using {{bc|Tag|Morphology|&nbsp;}}.
** ''Branch Order'' Filters for paths of [[Strahler Analysis|branch order]] in the inputted range. Example queries: <tt>1-2</tt>: selects all primary and secondary branches; <tt>max-max</tt>: selects all terminal branches.
** ''Length'' Filters for paths of length within the inputted range. Example queries: <tt>10-20</tt>: selects all paths with lengths between 10 and 20μm; <tt>max-max</tt>: selects the longest path(s).
** ''Mean Radius'' Filters for paths of mean radius within the inputted range.
** ''No. of Nodes'' Filters for paths with node count within the inputted range.
** ''SWC Type'' Filters for paths with the selected SWC type tags. Note that the paths of interest must have been [[SNT:_Overview#Tag|tagged]] using the{{bc|Tag|Type|&nbsp;}} menu.
 
<div align="center">
<ul>
<li style="display:inline-block;"> [[Image:SNT-Path-Manager-Branch-Order-Filter.png|none|thumb|200px|1) Branch Order filter prompt]] </li>
<li style="display:inline-block;"> [[Image:SNT-Path-Manager-Length-Filter.png|none|thumb|200px|2) Length filter prompt]] </li>
<li style="display:inline-block;"> [[Image:SNT-Path-Manager-Mean-Radius-Filter.png|none|thumb|200px|3) Mean Radius filter prompt]] </li>
<li style="display:inline-block;"> [[Image:SNT-Path-Manager-Node-Count-Filter.png|none|thumb|200px|4) No. of Nodes filter prompt]] </li>
<li style="display:inline-block;"> [[Image:SNT-Path-Manager-SWC-Type-Filter.png|none|thumb|200px|5) SWC Type filter prompt]] </li>
</ul>
</div>
 
=Fill Manager=
Provides controls for all filling operations. It is described in more detail in the [[SNT:_Step-By-Step_Instructions#Filling|Filling: Step-By-Step Instructions]].
{{SNTNavBar}}
Emailconfirmed
1,573
edits