Configuration

<note tip>You may have a look at the new Configure Panel of the main GUI that gives a rather convenient access to the configuration settings.</note>

• All config files are located in one central directory.
• The config files follow mainly the scheme familiar from Windows ini files.
• The archives with the sources of the toolbox contain only example files for the configuration. (These files are used at the same time to document the config files.)
  • For getting a real configuration, the user needs to create his own config files from these templates (see below). At the same time, that prevents updates from overwriting local configurations.
  • Note: Currently, at least the GUI windows do check at start whether there is a local configuration file, and if not, they create it “on the fly”.

As the configuration currently only exists for the GUI, the config file directory is a subdirectory of the GUI functions:

$TOOLBOXDIR/GUI/private/conf

Here, $TOOLBOXDIR is the root directory of the toolbox, i.e. the directory the toolbox got installed into.

To automatically generate a valid set of config files from the distributed files (.dist.ini), and in a long run to perform other config-related tasks as well, there is a function:

trEPRconf

Called without arguments, this function displays its own help. Currently (as of 2011-12) there is only one “action”:

trEPRconf('create');

This will create a set of valid configuration files from the distributed templates (ini.dist), but only if there is no valid config file already. Thus, no configuration gets overwritten.

A more comfortable way that includes additional functions is the panel “Configuration” in the main GUI. There, you can directly edit config files (in the MATLAB® editor), create or reset them.

Following a few examples for config files.

Note: The config files are currently under development.

Shown here is not the valid config file, but rather the commmented version (trEPRgui.ini.dist) as distributed. This version serves as documentation at the same time. For how to automatically create a valid config file from that, see above.

% Sample configuration file for the trEPRgui function of the trEPR toolbox
%
% (c) 2012, Till Biskup <till@till-biskup.de>
%
% This file serves as an example and documentation for the real
% configuration in the file "trEPRgui.ini" in the same directory.
%
% To automatically generate a valid config file from this file, 
% use trEPRconf('create') at the MATLAB(r) command line.
% Alternatively, you may use the functions provided by the "Configuration" 
% panel of the GUI.
 
% Configuration of the behaviour of the toolbox when started
%
% welcome - Whether to show the "Welcome panel" at start.
%           Alternatively, directly the "Load panel" is displayed.
% tip     - Whether to show a "Did you know...?" message at start.
[start]
welcome = 1
tip = 1
 
% Configuration for the load panel
%
% The first lines, "combine/loaddir/POC/BGC/labels", are switches settin
% the respective checkboxes of the load panel.
% The "format" field controls which file format gets selected. For a list
% of available formats see the file "trEPRload.ini" in the same directory as
% the trEPRload function. The string of interest is the string in the field
% "name" of the respective file format.
% The file formats (that are displayed in the popupmenu) are automatically
% read from trEPRload.ini as well.
[load]
combine = 0
loaddir = 0
AVG = 0
POC = 0
BGC = 0
labels = 1
format = automatic 
 
% Configuration for the measure panel
[measure]
setslider = 1
 
% Configuration for the display panel
[display]
axislimitsauto = 1
grid.zero.visible = 1
grid.zero.color = [0.5 0.5 0.5]
grid.zero.width = 1
grid.zero.style = --
grid.x = 0
grid.y = 0
grid.minor = 0
legend.location = none
legend.box = 1
legend.FontName = Helvetica
legend.FontSize = 12
legend.FontWeight = normal
legend.FontAngle = normal
normalise = none
highlightactive = 1
export1Dincludeaxis = 1
display3DoffsetAuto = 1
thresholdMin = 0
thresholdMax = 0
 
% Configuration for the configuration panel
[configuration]
overwriteLocal = 0