Difference between revisions of "SNT: Reconstruction Viewer"
(→Analyze and Measure: Update Measurements section)
(→Tool and Utilities: Update Utilities menu)
|Line 193:||Line 193:|
*Take SnapshotSaves a PNG image of the current scene to disk. The default directory may be changed in the Reconstruction Viewer ''Preferences''.
*Record RotationAnimates 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 LegendsContains options relating to the adding and management of LUT-based color legends.
*...of . Note of .
*Script This ViewerOpens 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)
|}} the .
Revision as of 17:22, 23 May 2020
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
- 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))
- 1 Starting the Viewer
- 2 Scene Interaction
- 3 RV Controls
- 3.1 Scene Controls
- 3.2 Manage and Customize Neuronal Arbors
- 3.3 Manage and Customize 3D Meshes
- 3.4 Reference Brains
- 3.5 Analyze and Measure
- 3.6 Utilities
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 . 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. › ›
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)
This menu provides control over the rendered scene.
- 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.
- Stretches the projection on the whole viewport.
- Squares the aspect ratio of the selected dimensions, leaving the others unchanged. ›
- ⇧ Shift + F Enters full screen mode. To exit full screen press ⎋ Esc
- ^ 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.
- ^ Ctrl + ⇧ Shift + R Clears all objects from the scene then rebuilds them from scratch.
- Removes all objects from the scene. Note this action cannot be undone.
- 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.
- 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.
- 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.
- Calls the command found in the main SNT dialog, allowing import, rendering and comparison of multiple groups of reconstructions. ›
- Allows import and rendering of reconstruction files fetched from the FlyCircuit, MouseLight and NeuroMorpho remote databases. ›
Customize & Adjust
- Allows customization of color, transparency and thickness parameters by neurite compartment in a single dialog.
- Assigns the chosen homogeneous color to all selected reconstructions.
- Applies morphometric color mapping to selected reconstructions. The chosen LUT is used to assign a metric-based color gradient to each reconstruction. ›
- 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. ›
- Applies a unique homogeneous color to each selected reconstruction. Note this option will override any previously applied color mapping to the selected reconstructions. ›
- 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.
- 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.
- Deletes the selected reconstructions from the scene.
- Deletes all reconstructions from the scene.
Manage and Customize 3D Meshes
- Allows import and rendering of Wavefront OBJ files, commonly used to represent surface meshes of anatomical structures.
- Allows adjustment of the color and transparency of the selected mesh(es) and/or their computed bounding boxes in a single menu.
- Allows choice of mesh color from a generic CMYK profile.
- Sets mesh transparency as a percentage value.
- Deletes the selected mesh(es) from the scene.
- Deletes all imported mesh(es) from the scene.
This menu allows import of several Drosophila, Zebrafish and Mouse reference brains and anatomical compartments.
- 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.
- Max Planck Zebrafish Brain Atlas
- FlyCircuit Drosophila reference brain
- Janelia Farm Research Campus 2018 Drosophila reference brain
- Janelia Farm Research Campus Virtual Fly Brain
- Janelia Farm Research Campus Drosophila reference brain (Version 3)
- Adult Drosophila ventral nervous system reference
- Drosophila 1st instar larval stage
- Drosophila 3rd instar larval stage
Analyze and Measure
This menu houses several functions to measure and analyze loaded reconstructions.
- Calls the 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. ›
- Calls the command in the main SNT dialog, producing a table of summary statistics for the loaded reconstructions. ›
- Saves all measurements computed during a session to a .csv file.
- 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.
- Measures each cell in the currently selected reconstructions individually and plots a histogram of the chosen metric, enabling comparison between individual cells.
- 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.
- Runs the command found in the main SNT dialog. See › Dendrogram Viewer. Note only one reconstruction may be selected at a time with this option.
- Runs the Sholl Analysis plugin found in . Note only one reconstruction may be analysed at a time. › ›
- Conducts Strahler Analysis on the selected reconstruction. Note only one reconstruction may be analysed at a time.
Actions & Utilities
- S Saves a PNG image of the current scene to disk. The default directory may be changed in the Reconstruction Viewer Preferences.
- 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.
- Contains options relating to the adding and management of LUT-based color legends. ›
- Adjustments of light and shadows. Note these are currently experimental features, some of which are un-doable.
- 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 Scripting Reconstruction Viewer. A related script template can also be found in the Script Editor at . › › ›
- Prompts for selection of scripting language before running the previous command.
- L Logs detailed information about the current scene (e.g., currently visible objects, API calls, etc.) to the Console. This facilitates programmatic control over the Viewer's scene.
- Logs detailed information about plugin usage, including warnings and errors to the Console.