Panel Tracing - ekatrukha/BigTrace GitHub Wiki

The panel under the tracing icon icon shows ROI creation/grouping options:

tracing panel

Tracing type

The set of toggle buttons defines, what type of ROI will be added to the ROI manager upon point addition.
button point button polyline button semi-auto button one-click button crossection
For the description of ROI interface please refer to Creating ROIs page.

A general ROI render settings can be configured in settings settings button.

Dialogs showing semi-auto tracing and one-click tracing parameters can be opened by double-clicking on the corresponding button semi-auto and button one-click icons.

There is a possibility to import ROIs from external data using import button button.

ROI Manager

This subpanel contains an interactive list of ROIs. A selected ROI is usually rendered with different colors (they can be defined in these settings, see below).

Double-clicking on the ROI name in the ROI Manager list brings the viewer's focus (zoom) to it. The fraction of screen occupied by ROI after zooming in can be adjusted by Zoom box screen fraction parameter.

A name for a new ROI is generated automatically and can be changed using Rename button.
If an ROI is a member of Groups, its name will contain a prefix in square brackets (first three letters of the group name).

Delete and Deselect buttons will do exactly what one would expect them to do.

Show all toggle button defines if all ROIs in the list are rendered or only the currently selected ROI is displayed.

Properties dialog defines individual ROI's render and measurement parameters:

ROI properties dialog

Time Point field specifies to which time frame the ROI is assigned. Time frames are indexed from zero.

The values of Point size and Line thickness parameters are specified in voxels. They define intensity and volume measurements for this ROI.

The opacity parameter changes ROI opacity only with respect to other ROIs (not the image volume itself). To "see-through" ROI we advise changing the render type to Wire.

Render as: selection box specifies how ROIs are rendered.
In the "Outline" mode only a center line (for curve ROIs) and cross-section border are shown:
outline render
In the "Wire" mode the wireframes of ROIs are rendered:
wireframe render
and in the "Surface" mode, well, the surface is rendered:
surface render
Point3D ROIs are rendered as circles in Outline/Wire modes and as disks in the Surface mode.

These settings are for visualization only, they do not affect ROI measurements.
To change the appearance of a batch of ROIs, a similar dialog of Groups can be used.

Save/Load ROIs buttons work with BigTrace ROIs File format.

In the case of multi-channel images, only the intensity of the channel (source) selected in the Active: box will be used for Creating ROIs.

Newly added/created ROI will be automatically assigned to a group, currently selected in the Groups drop-down menu.
To re-assign ROI to a new group, select it (in the list or on the canvas with the shortcut E) and press "Apply" button.
ROI group visibility can be toggled using button visibility group icon.

Panel Tracing settings

This dialog under the settings button button defines ROI render options.

ROI render

These are global rendering parameters, common for all ROIs.

roi render settings dialog

The first two parameters (Selected ROI point and line color) specify colors of active (selected) ROI.

Clip volume on ROI double-click option adjusts volume clipping to the volume the ROI on its double-click in the list.

Expand clipping by (voxels) related to the previous option, expands the clipping by the specified number of voxels.

ROI shape interpolation option specifies how ROIs are displayed and measured. NB: it is synchronized with the corresponding measurement option.

Trace smoothing window (points) defines a window for smoothing of line traces (LineTrace3D) in Smooth mode and positioning of nodes for the spline fitting (in a Spline mode). In short, the larger the value, the more smooth the trace will be. See the link above for more details on the procedure.

---- Time ----

Show ROIs over time: option available for timelapse data. In the current timepoint mode, only ROIs present at the current time frame will be rendered on canvas.
Backward/forward in time modes allow to render ROIs from previous/next time points specified by the range indicated in Time fade range (frames) parameter. ROIs from adjacent time points are rendered with decreasing opacity, depending on their "time distance" from the current position.

ROI surface

This panel specifies how the surface or ROIs is rendered

# edges at curve cross-section parameter defines how many sectors are created for the visualization of pipe (cylinder) contours around PolyLine3D and LineTrace3D ROIs. It affects only visualization, the intensity measurements will always happen around a circle (up to pixelization rounding).
Here is an example of the same ROI rendered with sectors number 4, 10, and 20:

different sector number

---- Wire mode ----

Distance between curve contours (px) defines the distance between the pipe's contours along the ROI.
It can be useful if you want to "look inside ROI".
Here is the same ROI rendered with the distance of 1, 5, and 20 pixels between contours:

contour distance illustration

Plane/cross-section ROI grid step (px): defines the density of the displayed grid for the CrossSection3D ROI type. The larger the value, the more sparse the grid.
Here is an example with the step of 10 (left) and 50 (right) pixels:

cross-section grid step

In short, it allows tuning the "transparency" of the cross-section plane ROI.

---- Surface mode ----

ROI surface render type parameter defines how the ROI is rendered in the "Surface" mode, it is a copy of the Panel View/Clip#roi-surface choice box.

Importing ROIs

The dialog under the import button button allows importing of ROIs from external sources.

At the current moment only import of Point3D ROIs from Trackmate XML files
produced by executing "Export tracks to XML file" command (in the last panel of Trackmate) are supported.

NB: The size and rendering details of the imported ROIs will be defined by the currently selected Group in the Groups box (by default undefined). So we advise you to adjust these settings beforehand.

The color of imported ROIs can be either selected randomly per track or inherited from the Group settings.
Imported ROIs names reflect track number and point number within in. The visibility of ROIs from previous/next time points can be adjusted in the settings.
Note that since imported ROIs are just a set of points, track's edges are not rendered.