Configuring BrainVISA

The Preferences menu allows to customize user settings in several aspects of BrainVISA. Depending on the installed toolboxes, the preferences window may show a variable number of items. It is not necessary to complete all the fields to use BrainVISA, however they do allow you to optimally configure your user profile. The mandatory fields, such as user level or language contain a default value. Some fields become mandatory when you want to use processes that start up external programs such as Matlab (matlabExecutable field).

Figure 6.2. Preferences window

Preferences window

Configuring the main options

The general BrainVISA sub-panel is used to configure several options for customizing your BrainVISA platform (see figure above).

Mandatory parameters:

  • userLevel: this field can contain any one of 3 values: Basic for a standard user (access to top-level processes) or Advanced/Expert for more experienced users (access to lower level processes or processes undergoing validation/implementation).

  • language: this field can contain any one of 3 values: System default which is the default language in your operating system, English or French.

Optional parameters (or parameters for an advanced use of BrainVISA including the setting of Matlab software):

  • processesPath: this optional field is used to configure the path to BrainVISA processes program files. It is for experienced users.

  • temporaryDirectory : parameter is used to configure a path to temporary files.

  • textEditor is the external editor program used to show or edit text files when needed. It is used by several viewer or editor processes.
  • HTMLBrowser: list of browsers available on your workstation. you can specify the browser you wish to use.

  • remoteExecutable is only used by the still experimental distributed processing tool. It specifies how BrainVISA should be run when it needs to be started again on a different machine. For now, you should not use it.
  • removeTemporary determines if temporary files created within BrainVISA should be deleted immediately to free disk space, or only when exiting BrainVISA. Such deletion delay is useful for processes developers when debugging processes.

SPM parameters

  • SPM99_compatibility tells AIMS applications and Anatomist if it should read/write SPM/Analyze format images like SPM99 did, or rather like SPM2 does. See AIMS and SPM documentations for more details.
  • radiological_orientation: for SPM format images, tells wheter they are considered to be in radiological (right to left) or neurological (left to right) convention when no further information is available in the image files.

Support parameters

The Support settings section is used to configure the automatic electronic mail system for sending bug reports. This configuration is only relevant if you have access to the internet, and if you are familiar with all the mail transfer parameters. If in doubt, contact your network administrator.

  • userEmail: e-mail address of the sender, i.e. the user who sends the bug report.

  • supportEmail: destination, i.e. the address to which the bug report is sent. The default destination address is: support@brainvisa.info

  • SMTP_server_name: address/name of the server that manages the SMTP (Simple Mail Transfer Protocol).

Databases

Databases configuration panel

The Databases configuration item is used to configure one or more databases. Each database is associated with a directory and a database organization description (ontology).

The database configuration window provides several functions (cf. figure below):

  • Edit: Provides access to the parameters of a database, and allows the user to modify them.

  • Add: Used to configure a new database.

  • Remove: This removes the database entry in BrainVISA, but does not delete the database file and directory (no data is lost).

Figure 6.3. Databases configuration panel

Databases configuration panel

Creating a database

We are now going to create a database. Please follow the instructions below:

  1. Open the Preferences window.

    and select the Databases item.
  2. Click the Add button.

    Figure 6.4. Adding a database

    Adding a database
  3. Complete the following fields (only directory is mandatory) :

    • directory: mandatory field. Enter the path of the folder that will contain your database.
    • Expert mode ontology: optional field. This ontology describes the database organization. The default organization, brainvisa-3.1, should be OK for most usage. However, custom organizations may be defined and used.
    • Expert mode activate_history: optional field. This is an experimental option which allows to record in the database directory all processes which have been run to write data in the specified database. This tool is bound to further evolutions, so it is not really an "official" feature yet.
    • Expert mode automatic_update: when using old (obsolete) databases not working with a databse engine, determines whether directories and files should be checked for changes on the fly.
    • Expert mode check_directory_time_only: when using old (obsolete) databases not working with a database engine, this option tells if checking a directory modification time is enough to know if at least one file has changed within it. It is actually filesystem-dependent (OK on Unix/linux filesystems, not OK on Windows FAT filesystems).

    Figure 6.5. Creating a database

    Creating a database
  4. Click Ok when you have finished entering your parameters.

    Figure 6.6. List of database

    List of database

Anatomist configuration panel

  • executable: this parameter is used to configure the command for starting up Anatomist.

R panel

  • executable: command used for starting up the R program.

  • options: R software options passed to the R commandline.

Matlab panel

  • executable: this parameter is used to configure the command for starting up MatLab.

  • version: Matlab release version, used to assume a specific version and avoid the automatic detection which may take a few seconds.
  • options: used to configure options for MatLab.

  • path: used to configure the path from which matlab files will be loaded.

  • startup: run this matlab command when starting up matlab.

Figure 6.7. Example of a Linux configuration : here we have changed the temporaryDirectory and Matlab executable fields.

Example of a Linux configuration : here we have changed the temporaryDirectory and Matlab executable fields.
Example of a Linux configuration : here we have changed the temporaryDirectory and Matlab executable fields.

User configuration

When configuration is done, the configuration data is stored in the user .brainvisa folder. There are actually 2 profile types: a general one (options.minf) and named profiles that can be used to store or use alternative configurations (options-<userprofile>.minf)

These different profiles are particularly useful when you must use a shared user connection.

Locating configuration files

If your user name is user, for instance the general configuration file will be placed in:

  • Unix / MacOS: $(HOME)/.brainvisa/options.minf, typically /home/user/.brainvisa/options.minf

  • Windows: generally something like C:\Documents and Settings\user\.brainvisa\options.minf

Customized configuration files for named profiles are placed in the same directory.

The general profile is automatically used when BrainVISA is launched.

Using / configuring a specific profile

To use and configure a specific profile, for example toto, follow the instructions below:

  1. Start BrainVISA with a profile name (even if it does not exist yet), for instance

    brainvisa -u toto
    .

  2. Customize this profile with the configuration interface: Preferences menu.

  3. Validate them with the OK button

  4. Exit BrainVISA.

  5. To start BrainVISA with this profile:

    brainvisa -u toto 

Bug report: setup and use

Setup of Support

The Support section if the Preferences is used to configure the automatic electronic mail system for sending bug reports. This configuration is only relevant if you have access to the internet, and if you are familiar with all the mail transfer parameters. If in doubt, contact your network administrator.

Below is a configuration example:

Figure 6.8. Configuration of the Support function

Configuration of the Support function

Using the Support function

Use the Support -> Bug report menu. Parameter details:

  • From: mandatory, sender e-mail address, i.e. the user who sends the bug report.

  • To: mandatory, destination address, i.e. the address to which the bug report is sent. The default destination address is: support@brainvisa.info.

  • Cc: optional, to send a carbon copy to someone.

  • Bcc: optional, to send a blind carbon copy to someone.

  • Attach log file: use this option to attach the log file.

  • Send: to validate the sending of the e-mail.

  • Cancel: to cancel the sending of the e-mail.

Example of an e-mail send operation:

Figure 6.9. Sending of bug report

Sending of bug report