Difference between revisions of "SNT: Reconstruction Viewer"

(Reference Brains: Update reference brain menu)
(Analyze and Measure: Update Measurements section)
Line 154: Line 154:
  
 
==Analyze and Measure==  
 
==Analyze and Measure==  
[[Image:reconstruction-viewer-measurement-menu.png|right|thumb|400px|]]
+
[[Image:reconstruction-viewer-measurement-menu.png|right|thumb|300px|]]
 
This menu houses several functions to measure and analyze loaded reconstructions.
 
This menu houses several functions to measure and analyze loaded reconstructions.
*'''Measure''' Shows a table of summary statistics for selected reconstructions. If measuring multiple tracings, the table can be sorted by column.
+
===Tabular Results===
 +
*{{bc|Measure...}} Calls the {{bc|Analysis|Measure...}} command in the main SNT dialog, allowing selection of specific measurements, with the ability to distinguish neurite compartments. If measuring multiple tracings, the table is sortable by column.
 +
*{{bc|Quick Measurements}} Calls the {{bc|Analysis|Quick Measurements}} command in the main SNT dialog, producing a table of summary statistics for the loaded reconstructions.
 +
*{{bc|Save Table...}} Saves all measurements computed during a session to a .csv file.
 
<div align="left">
 
<div align="left">
 
<ul>  
 
<ul>  
Line 162: Line 165:
 
</ul>
 
</ul>
 
</div>
 
</div>
*'''Distribution Analysis...''' Plots a histogram of the selected metric. If multiple reconstructions are selected, a single analysis is conducted on the group.
+
===Distribution Analysis===
 +
*{{bc|Branch Properties...}} Measures all branches of the currently selected reconstructions (without considering cell identity) and plots a histogram of the chosen metric, enabling quantification of branch properties across a population.
 +
*{{bc|Cell Properties...}} Measures each cell in the currently selected reconstructions individually and plots a histogram of the chosen metric, enabling comparison between individual cells.
 
<div align="left">
 
<div align="left">
 
<ul>  
 
<ul>  
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-distribution-analysis.png|none|thumb|200px|AA0100 Branch Order Histogram]] </li>
+
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-distribution-analysis.png|none|thumb|200px|AA0100: Branch Order]] </li>
 +
<li style="display:inline-block;"> [[Image:reconstruction-viewer-OP-distribution-analysis.png|none|thumb|200px|9 OP fibers: # Branch Points]] </li>
 
</ul>
 
</ul>
 
</div>
 
</div>
*'''Sholl Analysis...''' Runs the [[Sholl_Analysis|Sholl Analysis]] plugin found in {{bc|Analyze|Sholl|Sholl Analysis (From Tracings)}}. Note only one reconstruction may be analysed at a time.
+
===Single-Cell Analysis===
 +
[[Image:reconstruction-viewer-brain-area-analysis.png|right|thumb|300px|Brain Area Analyis: Cable Length]]
 +
*{{bc|Brain Area Analysis...}} Measures the amount of cable length, number of terminal nodes, or both that occur in distinct anatomical regions of the brain, with the option to restrict the analysis up to a maximum depth in the ontology hierarchy. Note that only one reconstruction may be selected at a time with this option.
 +
*{{bc|Create Dendrogram...}} Runs the {{bc|Utilities|Create Dendrogram...}} command found in the main SNT dialog. See [[SNT:_Analysis#Dendrogram_Viewer|Dendrogram Viewer]]. Note only one reconstruction may be selected at a time with this option.
 +
*{{bc|Sholl Analysis...}} Runs the [[Sholl_Analysis|Sholl Analysis]] plugin found in {{bc|Analyze|Sholl|Sholl Analysis (From Tracings)}}. Note only one reconstruction may be analysed at a time.
 
<div align="left">
 
<div align="left">
 
<ul>  
 
<ul>  
 
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-sholl-table.png|none|thumb|200px|AA0100 Sholl Table]] </li>
 
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-sholl-table.png|none|thumb|200px|AA0100 Sholl Table]] </li>
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-sholl-plot.png|none|thumb|200px|AA0100 Sholl Plot]] </li>
+
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-sholl-plot.png|none|thumb|221px|AA0100 Sholl Plot]] </li>
 
</ul>
 
</ul>
 
</div>
 
</div>
*'''Strahler Analysis''' Conducts Strahler Analysis on the selected reconstruction. Note only one reconstruction may be analysed at a time.
+
*{{bc|Strahler Analysis}} Conducts Strahler Analysis on the selected reconstruction. Note only one reconstruction may be analysed at a time.
 
<div align="left">
 
<div align="left">
 
<ul>  
 
<ul>  
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-strahler-table.png|none|thumb|200px|AA0100 Strahler Table]] </li>
+
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-strahler-table.png|none|thumb|227px|AA0100 Strahler Table]] </li>
 
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-strahler-plot.png|none|thumb|200px|AA0100 Strahler Plot]] </li>
 
<li style="display:inline-block;"> [[Image:reconstruction-viewer-AA0100-strahler-plot.png|none|thumb|200px|AA0100 Strahler Plot]] </li>
 
</ul>
 
</ul>

Revision as of 16:55, 23 May 2020

Home Manual Walk-throughs Screencasts Shortcuts Rec. Viewer Analysis Scripting Modeling FAQ

SNT's Reconstruction Viewer is a powerful OpenGL 3D visualization tool for both surface meshes and reconstructions

  • It can be used as a standalone program or from withing SNT
  • Features:
    • Advanced rendering supporting axes, transparency, color interpolation and path smoothing
    • Interactive scenes (controlled rotations, panning, zoom, scaling, animation, "dark"/"light" mode)
    • Tools for management and customization of scene elements
    • Ability to render both local and remote files on the same scene
    • Loading of surface meshes of several template brains (Drosophila and Allen CCF (Allen Mouse Brain Atlas))

Starting the Viewer

The Reconstruction Viewer may be used as either a standalone program or from within SNT. To open Reconstruction Viewer as a standalone program, go to Plugins › NeuroAnatomy › Reconstruction Viewer. To open the program from within SNT, use the "Open Reconstruction Viewer" option in the 3D tab of the SNT dialog. If there are any tracings currently loaded in SNT, they will be displayed in Reconstruction Viewer after opening. Note that, for performance reasons, some Path Manager changes may need to be synchronized manually from RV controls.

Scene Interaction

Reconstruction-viewer-example-scene.png

The display canvas supports multiple modes of interaction, including controlled rotations, panning, zoom, scaling, animation, and alternation between "dark" and "light" modes.

  • Pan Right-Click + Drag
  • Rotate Left-Click + Drag or Left/Right arrow keys
  • Zoom (Scale) Scroll the mouse wheel or use the +/- keys
  • Animate Double Left-Click
  • Snap to Top/Side View ^ Ctrl + Left-Click
  • Full Screen Shift + F ( Esc to exit)
  • Toggle Axes A
  • Toggle Camera Mode C
  • Toggle Dark Mode D
  • Fit to Visible Objects F
  • Log Scene Details L
  • Reset View R
  • Snapshot S
  • Help H (notification) or F1 (list)

RV Controls

Scene Controls

Reconstruction-viewer-scene-controls.png

This menu provides control over the rendered scene.

  • Fit to Visible Objects F Computes a bounding box containing all objects of the scene and adjusts the zoom level to ensure all objects are within the camera view.
  • Stretch-to-Fill Stretches the projection on the whole viewport.
  • Stretch-to-Fill - disabled
  • Stretch-to-Fill - enabled
  • Impose Isotropic Scale ›   Squares the aspect ratio of the selected dimensions, leaving the others unchanged.
  • Impose Isotropic Scale - None
  • Impose Isotropic Scale - ZY
  • Full Screen Shift + F Enters full screen mode. To exit full screen press Esc
  • Reset Scene R
  • Reload Scene ^ Ctrl + R Resets the zoom level to the default, fitting and centering all scene objects into the camera view. The current rotation setting remains unchanged. Note if some drawables in the 3D scene are not being rendered properly when this option is selected, it will prompt to rebuild the scene completely.
  • Rebuild Scene... ^ Ctrl + Shift + R Clears all objects from the scene then rebuilds them from scratch.
  • Wipe Scene... Removes all objects from the scene. Note this action cannot be undone.
  • Sync Path Manager Changes If the 3D scene contains any trees that are currently stored in the Path Manager, re-render these trees to reflect any change in the path structure given by the Path Manager.

Manage and Customize Neuronal Arbors

This menu relates to the import, customization and management of rendered reconstructions.

Add

Reconstruction-manage-arbors-menu.png
  • Import File... Imports and renders a single reconstruction file (".swc" or ".traces"). A color may be chosen on import or applied later using the "Customize & Adjust" sub-menu. Note that loaded files will not be listed in the Path Manager.
  • Import Directory... Imports and renders all reconstruction files in a directory. A single color may be applied to all reconstructions or they may be colored uniquely. Note that loaded files will not be listed in the Path Manager.
  • Import & Compare Groups... Calls the Utilities › Compare Reconstructions... command found in the main SNT dialog, allowing import, rendering and comparison of multiple groups of reconstructions.
  • Load from Database ›   Allows import and rendering of reconstruction files fetched from the FlyCircuit, MouseLight and NeuroMorpho remote databases.

Customize & Adjust

  • All Parameters... Allows customization of color, transparency and thickness parameters by neurite compartment in a single dialog.
  • Color... Assigns the chosen homogeneous color to all selected reconstructions.
  • Color Coding › Individual Cells... Applies morphometric color mapping to selected reconstructions. The chosen LUT is used to assign a metric-based color gradient to each reconstruction.
  • Branch Order and Ice LUT
  • Color Coding › Group of Cells... Applies morphometric color coding to a selected group of reconstruction. Note that this option uses the chosen LUT to assign a homogeneous color to each reconstruction in the group based on the chosen metric.
  • No. Branch Points and Ice LUT
  • Color Coding › Color Each Cell Uniquely Applies a unique homogeneous color to each selected reconstruction. Note this option will override any previously applied color mapping to the selected reconstructions.
  • Unique Color Coding
  • Thickness... Specifies a constant thickness to be applied to the selected reconstructions. Note this value will only affect how Paths are displayed in the Reconstruction Viewer.
  • Thickness = 1.0
  • Thickness = 5.0
  • Translate... Specifies a translation to be applied to the selected reconstructions. To avoid overwriting data from a tracing session, this command is only available in the standalone viewer.

Remove

  • Remove Selected... Deletes the selected reconstructions from the scene.
  • Remove All... Deletes all reconstructions from the scene.

Manage and Customize 3D Meshes

Reconstruction-viewer-mesh-controls.png
Customize › All Parameters...

Add

  • Import OBJ File(s)... Allows import and rendering of Wavefront OBJ files, commonly used to represent surface meshes of anatomical structures.

Customize

  • All Parameters... Allows adjustment of the color and transparency of the selected mesh(es) and/or their computed bounding boxes in a single menu.
  • Color... Allows choice of mesh color from a generic CMYK profile.
  • Transparency... Sets mesh transparency as a percentage value.

Remove

  • Remove Selected... Deletes the selected mesh(es) from the scene.
  • Remove All... Deletes all imported mesh(es) from the scene.
  • Transparency = 5%
  • Transparency = 95%


Reference Brains

This menu allows import of several Drosophila, Zebrafish and Mouse reference brains and anatomical compartments.

Reconstruction-reference-brains-menu.png

Mouse

  • Allen CCF Navigator (Adult) Import and navigation system for the Allen Adult Mouse Common Coordinate Framework v3. Selecting this option imports the Whole Brain reference mesh, and presents a GUI allowing search, metadata retrieval, and import/rendering of ontologies contained in the Allen Common Coordinate Framework v3.
  • Allen CCF Navigator
  • Allen CCF Ontology Info

Zebrafish

  • Max Planck ZBA Max Planck Zebrafish Brain Atlas

Drosophila

  • Adult Brain: FlyCircuit FlyCircuit Drosophila reference brain
  • Adult Brain: JFRC 2018 Janelia Farm Research Campus 2018 Drosophila reference brain
  • Adult Brain: JRFC2 (VFB) Janelia Farm Research Campus Virtual Fly Brain
  • Adult Brain: JFRC3 Janelia Farm Research Campus Drosophila reference brain (Version 3)
  • Adult VNS Adult Drosophila ventral nervous system reference
  • Larva L1 Drosophila 1st instar larval stage
  • Larva L3 Drosophila 3rd instar larval stage


  • FlyCircuit Drosophila (Adult)
  • Allen Adult Mouse Whole Brain + Thalamus
  • Max Planck ZBA


Analyze and Measure

Reconstruction-viewer-measurement-menu.png

This menu houses several functions to measure and analyze loaded reconstructions.

Tabular Results

  • Measure... Calls the Analysis › Measure... command in the main SNT dialog, allowing selection of specific measurements, with the ability to distinguish neurite compartments. If measuring multiple tracings, the table is sortable by column.
  • Quick Measurements Calls the Analysis › Quick Measurements command in the main SNT dialog, producing a table of summary statistics for the loaded reconstructions.
  • Save Table... Saves all measurements computed during a session to a .csv file.
  • AA0100 Measurements

Distribution Analysis

  • Branch Properties... Measures all branches of the currently selected reconstructions (without considering cell identity) and plots a histogram of the chosen metric, enabling quantification of branch properties across a population.
  • Cell Properties... Measures each cell in the currently selected reconstructions individually and plots a histogram of the chosen metric, enabling comparison between individual cells.
  • AA0100: Branch Order
  • 9 OP fibers: # Branch Points

Single-Cell Analysis

Brain Area Analyis: Cable Length
  • Brain Area Analysis... Measures the amount of cable length, number of terminal nodes, or both that occur in distinct anatomical regions of the brain, with the option to restrict the analysis up to a maximum depth in the ontology hierarchy. Note that only one reconstruction may be selected at a time with this option.
  • Create Dendrogram... Runs the Utilities › Create Dendrogram... command found in the main SNT dialog. See Dendrogram Viewer. Note only one reconstruction may be selected at a time with this option.
  • Sholl Analysis... Runs the Sholl Analysis plugin found in Analyze › Sholl › Sholl Analysis (From Tracings). Note only one reconstruction may be analysed at a time.
  • AA0100 Sholl Table
  • AA0100 Sholl Plot
  • Strahler Analysis Conducts Strahler Analysis on the selected reconstruction. Note only one reconstruction may be analysed at a time.
  • AA0100 Strahler Table
  • AA0100 Strahler Plot

Tool and Utilities

Reconstruction-viewer-tools-menu.png
  • Debug Mode Logs detailed information about plugin usage to the Console.
  • Take Snapshot Saves a PNG image of the current scene to disk. The default directory may be changed in the Reconstruction Viewer Preferences.
  • Record Rotation Animates a rotation of the current scene and saves each frame to disk. The save directory, rotation degree, duration and frames per second may be adjusted in the Reconstruction Viewer Preferences.
  • Color Legends Contains options relating to the adding and management of LUT-based color legends.
  • Keyboard & Mouse Sensitivity A sub-menu with options for sensitivity of mouse and keyboard scene interaction. Note that a default shared sensitivity parameter can be specified for panning, zooming and rotating (using hotkeys) in the Reconstruction Viewer Preferences.
    • Pan Accuracy Sets the responsiveness of panning. A lower step size is more responsive.
    • Rotation StepsSets the number of degrees of a single rotation step. Note this preference only applies to rotations made with the Left/Right Arrow keys.
    • Zoom Steps Sets the percentage of a single zoom step.
  • Keyboard Shortcuts... Shows a list of all Reconstruction Viewer keyboard shortcuts.
  • Preferences... Configurable preferences for snapshot recordings, keyboard and mouse controls, and the preferred scripting language for the Viewer. Preferences persist across plugin sessions.
  • Script This Viewer... Opens an instance of the Script Editor with pre-loaded extensible boilerplate code for advanced scripting of Reconstruction Viewer. For an example of the scripting capabilities of Reconstruction Viewer, see Reconstruction Viewer Demo (Python) at Templates › Neuroanatomy › Analysis in the Script Editor.