All BioImage Suite web applications share components and have a similar user interface. All viewers in BioImage Suite Web can display two images:
- The “underlay” or “background” image — This is often the anatomical image and can be loaded and saved from the
- The “overlay” or “objectmap” image — This is often a functional image or segmentation image. This can be loaded and saved from the
Figure 1: The Orthagonal Viewer Tool
The application consists of the following parts:
- A. The Menu Bar — This provides access to all I/O and algorithmic functionality in the application.
File— Functionality for loading and saving the underlay anatomical image
Overlay— Functionality for loading, saving, and clearing the overlay functional image.
Edit— Typically contains Undo and Redo functionality for image manipulation operations and tools to move images from overlay to image, etc.
Image Processing— Standard image processing and maniuplations tools. Details can be found here.
Segmentation— Modules to perform image segmentation. Details can be found here.
Registration— Modules to perform image registration. Details can be found here (scroll about halfway down the page, note that these tools are only available in the dual viewer).
Help— Contains the usual
About this Applicationoption plus options for setting user preferences.
B. The Viewer can display the underlay and the overlay images in either single slice or three-linked slice views. There is also a viewer component which displays multiple parallel sections of the same image (see Overlay Viewer). Pressing the orange arrows next to each view will show the next or previous slice. If the image is ‘4D’ then movie controls will appear at the bottom of the screen.
C. Information about the currently selected voxel. This includes the coordinates (i,j,k) of the image, the intensity of the image under the cursor, and the intensity of the overlay under the cursor if one is present. They are displayed in the format
(i,j,k) = itensity (overlay intensity)
D. The side panel containing viewer and algorithm functionality controls.
- E & F. The
Viewer Controlsallow the user to control how the underlay and overlay images are displayed. Arrows on the left can be used to collapse or expand these controls as desired.
Mode— Selects single slice or three orthogonal slice view.
K-Coord— Select the
i,j,kcoordinates of the viewer crosshairs.
Frame— Selects the currently displayed image frame in the viewer. Only appears for 4D data.
Labels— Shows or hides labels in the viewer.
Disable Mouse— Locks the viewer from mouse input. The cross-hairs may only be changed using the
I,J,K-coordsliders if enabled.
Reset Slices— Resets the viewer to default zoom.
Z+— Zooms the viewers in and out. You may also zoom using the mouse wheel in the usual way.
?— Shows the current image information (see H).
Moviecontrols how to play the movie if 4D data is loaded:
Frames/s—Sets the movie frame rate in frames/second.
Play Movie— Toggle to enable movie playback of the data.
Image Color Mappingadjusts the windowing of the background image.
Min Int— Intensity values below this value are set to black and made fully transparent.
Max Int— Intensity values above this value are saturated to white.
Interpolate— Whether or not to use WebGL interpolation or not. WebGL images will be smoother, but raw images will let you see the individual voxels.
Auto-Contrast— If enabled, this will set the windowing automatically.
Overlay Color Mappingadjusts the overlay/functional image display properties. See the Overlay Viewer Application for more details. Will only appear if an overlay is loaded.
Viewer Informationcontains technical information about the image and the overlay, including the name, file format, dimensions, spacing, orientation, and underlying data type, e.g.
float32. The arrow on the left side of the box will display an example script to convert a BioImage Suite Web image to the legacy BioImage Suite format.
Viewer Snapshottool. It can be used to save a snapshot of the current viewer in a
.pngfile. The three sub controls are:
Scale— Sets the size of the image in voxels relative to the size of the viewer. For publication quality set this to ‘x5’ (five times) or higher.
White Bkgd— Sets the viewer background to white instead of black.
Crop— If turned on automatically crops empty space in the viewer to give a more pleasing snapshot.
Take Snapshot— Takes the picture.
- J. The double arrow icon at the top right of the sidebar can be used to minimize and restore the sidebar.
4D Images and Movie Display
Figure 2: An example of a 4D underlay image using a synthetic motion image.
The figure above shows the viewer displaying two images. The underlay image is a 4D image and the overlay is the average frame of the 4D image resampled to a lower resolution (for purposes of illustration). Take note of the following elements:
A — The movie controls. When either under or overlay is a 4D image, the movie controls automatically appear. You can use these to manually advance or rewind the frame, play the movie, or pause the movie.
B — Image information. This shows the intensity of both the image and the overlay under the cross-hairs. Since the images have different resolution, the coordinates are different, e.g. for the Image (
Img) we get the value at (32,28,21,2) (frame = 2, all coordinates including frame begin at zero), whereas for the lower resolution overlay (
Ovr) we get the value at (24,21,14,0) (the last number is capped to the number of frames in the overlay). Compare this to item
Cof the previous figure.
C — The
Coreviewer controls with a
Framecontrol. This allows us to set the 4th dimension of the image. While the range of the
K-coord sliders correspond to the dimensions of the underlay image, the Frame slider has range equal to the maximum of the the number of frames in the two images.
D — The
Moviecontrols. This last set of controls allows us to set the frame rate at which a movie will play and provides a secondary means to start and stop the movie in addition to the controls in A.
Figure 3: The viewer information popup from the
If at any point, you are curious what images are being displayed and their characteristics, simply click on the
? button under Viewer Controls as shown in the figure above. This will provide information about both images, including names, dimensions, voxel size, and orientation. The viewer information screen can make details about the image and overlay clearer, for example, it is easy to notice that the two images in the previous two figures have different resolution from the info screen (note the different dimensions).
[BioImage Suite Web Manual Table Of Contents] [BioImage Suite Web Main Page]
This page is part of BioImage Suite Web. We gratefully acknowledge support from the NIH Brain Initiative under grant R24 MH114805 (Papademetris X. and Scheinost D. PIs, Dept. of Radiology and Biomedical Imaging, Yale School of Medicine.)