Table Of Contents

This document contains:

The following documents describe the different applications in BioImage Suite Web.

These documents describe how to perform specific tasks in one or more of the applications in the software.

The following documents describes advanced application functionality that is common among most of the applications.

In addition to web applications, BioImage Suite web can be run as desktop applications. This is discussed in the following:

The final document discusses running regression testing:

Note: This document and those linked to it contain the beginnings of the user documentation for BioImage Suite Web. A brief introduction to the software can be found in this presentation. If you are looking for developer documentation, this may be found in the doc directory of the source repository.

This document represents work in progress.

Starting BioImage Suite Web

BioImage Suite Web has three major components:

Introduction Page This is the main page at

BioImage Suite Web is a collection of applications that is likely to grow over time. The list can be accessed under the Applications menu as shown above, and snapshots and brief descriptions of each application can be seen in the slide show in the center of the page.

From the menu you can also navigate to the downloads page, the documentation and the source code repository.

Some Key Information

Download File Location

Most browsers send all downloads to the Downloads directory, which may be inconvenient when trying to manage your data. It is recommended to change this before attempting any analysis in Bio Image Suite.


Chrome Download Settings

Click the triple dot icon at the top-right of the page, directly under the minimize/maximize/close window buttons and to the right of the navigation bar and select ‘Settings’.

Turn the option Ask where to save each file before downloading to ON.


See the description on this web page.

Image Orientations

The Viewers and command line tools can load images in the NIFTI-1 .nii.gz format.

A key component of the image is the image orientation. This relates the internal image coordinates to “world” coordinate space.

Image Orientation

Consider a 3-dimensional image matrix F(i,j,k) where i, j and k are the coordinate axes in the images where i,j are the in-plane directions and k is the slice axis. For example in the image shown above for Axial images, i is often Left->Right, j is Posterior->Anterior. The slice axis k is often Inferior->Superior. Such an image is described as having orientation RAS where the letters stand for the direction of the individual axes i.e

RAS is probably the most common orientation for Neuroimaging research. An alternative orientation that is commonly used (and which the legacy BioImage Suite used) is LPS which is 180 degrees rotated w.r.t. RAS (flip i and flip j).

There are 48 (!) possible combinations of orientations. BioImage Suite Web can display all of these, but also provides the user with the option of converting images to RAS or LPS to standardize. Under the Help menu, if you select the option Set Image Orientation on Load, the following GUI will appear.

Image Orientation on Load

If you select either RAS or LPS then any image load will be repermuted to be in RAS or LPS orientation on load. The settings are stored either in the Browser Database or the text file ${HOME}/.bisweb for commandline and Desktop applications. This is a .JSON key-value database file that may look something likes this:

The Settings File

In this case orientationOnLoad is set to None, which means the image’s orientation will not be changed.

[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.)