The GUI configuration plugin extends the configuration of graphical user interfaces to various options to adjust the look and feel.
All SeisComP3 graphical user interfaces are based on a common libraries. This chapter describes what configuration and styling options are available for all GUI applications. The GUI specific configuration options are additional to the standard application options. Setup the e.g. messaging connection and database is equal to the CLI (command line interface) applications.
To adjust the look-and-feel to the host desktop system and the personal taste several styling options are available. Since all GUI applications are using the Qt4 library the tool "qtconfig-qt4" can used to adjust the widget theme and the colors. If KDE is used as desktop system the same style is used since KDE bases on Qt as well.
The style options supported by SC3 (and not covered by the general Qt setup) have to be given in the applications (or global) configuration file. The parameters are prefixed with scheme..
Beside the usual integer, float, boolean and string parameters GUI applications support also color, color gradient, pen, brush and font parameters. The syntax is explained below:
color = RRGGBBAA | "rgb(red,green,blue)" | "rgba(red,green,blue,alpha)"
Colors are specified either in a hexadecimal notation or in a rgb(a) notation. When using the rgb(a) notation it should be quoted. Otherwise the configuration parser would tokenize the value into 3 or 4 strings due to the comma.
gradient = 1:FF0000, 2:00FF00, 3:0000FF
This defines a gradient from red through green to blue for the nodes 1, 2 and 3. Values out of range are clipped to the lower or upper bound.
# The font family
font.family = "Arial"
# Point size
font.size = 12
# Bold?
# Default: false
font.bold = false
# Italic?
# Default: false
font.italic = false
# Underline?
# Default: false
font.underline = false
# Overline?
# Default: false
font.overline = false
An example to configure the SC3 base font:
scheme.fonts.base.family = "Arial"
scheme.fonts.base.size = 10
Pens are used in the vector layer configuration. Pens have three attributes: color, style and width. Color follows the described color definition, width is a double and the styles are:
|
|
|
| nopen | solidline | dotline |
|
|
|
| dashline | dashdotline | dashdotdotline |
| Images from Qt 4.1 documentation: http://doc.qt.digia.com/4.1/qt.html#PenStyle-enum | ||
Example:
# Blue dotted pen
pen.color = 0000ff
pen.style = dotline
Brushes are also used in the vector layer configuration. Brushes are used to fill a polygon. They have two attributes: color and pattern. Color followes the described color definition and patterns are:
Example:
# Red solid brush
brush.color = ff0000
brush.pattern = solid
SeisComP3 supports drawing of arbitrary polygons/polylines. Currently the FEP (share/fep or ~/.seiscomp3/fep) and BNA (share/bna or ~/.seiscomp3/bna) data sets are loaded and may be visualized. While the FEP layer is configured through the layer 'fep', the layer (resp. category) of the BNA data is derived from the directory structure of the BNA folder.
In fact the depth of the BNA directory tree is arbitrary and subfolders form subcategories.
E.g. the directory tree bna/coastline/europe/germany will generate the categories coastline, coastline.europe and coastline.europe.germany which all may be configured individually. Every undefined property is inherited from the parent category. Due to its recursive structure the configuration options have not been added to the description xml file.
The general configuration parameter format is prefix.category.param. If global layer properties are configured then just prefix.param.
The prefix for layer configuration is map.layers.
Available configuration options per category are:
Type: boolean
Show/hide the layer Default is true.
Type: boolean
Draws the segment name in the center of the bounding box. For segments read from BNA files the name is extracted from the first part of the header. Default is false.
Type: int
Set or override the rank of the segment. The rank defines the zoom level at which drawing of the segment starts. For segments read from BNA files the name is extracted from the second part of the header if it has the form "rank VALUE", e.g. rank 12. Default is 1.
Type: int
Sets the roughness of a polyline or polygon while zooming. The roughness is somehow defined in pixels and removes successive vertices if the distance in pixel is less than roughness. The higher the value the less vertices a rendered polyline or polygon will finally have and the faster the rendering. If set to 0 then the feature is disabled. Default is 3.
Type: boolean
If enabled, the bounding box of the segment is drawn. Default is false.
Type: double
Pen width. Default is 1.0.
Type: color
Pen color. Default is 000000ff.
Type: string
Line style. Supported values are: dashdotdotline, dashdotline, dashline, dotline, nopen and solidline. Default is solidline.
Type: color
Fill color. Default is 000000ff.
Type: color
Fill pattern. Supported values are: nobrush, solid, dense1, dense2, dense3, dense4, dense5, dense6, dense7, horizontal, vertical, cross, bdiag, fdiag and diagcross. Default is nobrush.
Type: int
Type: string
Type: boolean
Type: boolean
Type: boolean
Type: boolean
Example:
# Set global layer boundary color to black
map.layers.pen.color = 000000
# Set coastline boundary color to orange and pen width to 2
map.layers.coastline.pen.color = ff8000
map.layers.coastline.pen.width = 2
# Set boundary of Germany to red. Pen width is still 2 (inherited from
# coastline)
map.layers.coastline.europe.germany = ff0000
# Set river color to blue
map.layers.river.pen.color = 0000ff
Type: string
Specified the location and the structure of the map tiles to be used. This path is composed of zero or more directives and must include at least one conversion specification which starts with is introduced by the character % followed by a conversion specifier. Valid specifiers are s (replaced by tile ID), l (tile level), c (tile column) and r (tile row). An example for using the OpenStreetMap file structure is /path/to/maps/%l/%c/%r.png. Default is @DATADIR@/maps/world%s.png.
Type: string
Projection of the map tiles. Supported formats are: rectangular and mercator. Default is rectangular.
Type: int
Cache size of the map tiles. If 0 is specified a default cache size of 32mb is used. The higher the cache size the better the performance in higher resolutions. A higher cache size causes less image loader calls but requires more client memory. Default is 0.
Note
scheme.* This group defines various color and font options for SeisComp3 graphical user interfaces. There are various conventions to define colors, fonts and gradients. A color is defined in HTML convention. If rgb or rgba is used it must be quoted because the comma is handled as list separator by the configuration. Gradients are configured as lists of tuples where each tuple is colon separated in the form value:color. Color is again a color definition and value is either int or double.
Type: boolean
Show menu bar. Default is true.
Type: boolean
Show status bar. Default is true.
Type: string
Set position if tab bar. An unset value lets the application decide where to place the tab bar. This option might not be supported by all applications. Valid positions are: off, north, south, east, west
Type: color
A general application background color. Can be uses to give each application a different background color. An unset value lets Qt decide.
Type: color
The general color of records/traces. Default is 808080.
Type: color
A general trace color of the alternate trace (eg scheli). Default is 808080.
Type: color
The color of data gaps in trace views. Default is FFFF0032.
Type: color
The color of manual picks. Default is 00FF00.
Type: color
The color of automatic picks. Default is FF0000.
Type: color
The color of picks with undefined state. Default is A0A0A4.
Type: color
The color of disabled picks. Default is A0A0A4.
Type: color
The color of manual arrivals (arrivals that bind manual picks, e.g. residual plot of scolv, manual picker, ...) Default is 00A000.
Type: color
The color of automatic arrivals, Default is A00000.
Type: color
The color of theoretical arrivals. Default is 0000A0.
Type: color
The color of arrivals binding picks with undefined state. Default is A00000.
Type: color
The color of disabled arrivals. Default is A0A0A4.
Type: gradient
The gradient of arrivals residuals. A gradient is defined as a list of tuples separated by colon where the first item is the value and the second is the color. Colors can be given in rgb notation or hex. when rgb is used double quotes are needed to protect the comma inside the rgb definition, e.g. -8:"rgb(0,0,100)", -4:"rgb(0,0,255)", -3:"rgb(100,100,255)", ...
Type: color
The color of active magnitudes. Default is 00A000.
Type: color
The color of inactive magnitudes. Default is 000000.
Type: color
The color of disabled magnitudes. Default is A0A0A4.
Type: gradient
The gradient of magnitude residuals.
Type: color
The color of associated stations (e.g. in scmv). Default is 82AD58.
Type: color
The color of triggered stations.
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
The color of disabled stations.
Type: color
The color of idle stations.
Note
scheme.colors.qc.* The color of QC.delay thresholds in scmv.
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Note
scheme.colors.gm.* The color of ground motion amplitudes in scmv.
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
No description available
Type: color
The color of the selected zoom area (e.g. manual picker). Default is C0C0FFC0.
Type: color
The color of lines in the map (e.g. lines connecting the origin and a station).
Type: color
The color of station outlines in the map.
Type: color
The color grid line color of the map.
Type: color
The color of station annotations.
Type: color
The color of city labels.
Type: color
The color of city outlines.
Type: color
The color of a capital.
Type: color
The color of a "normal" city.
Type: color
The map legend background color.
Type: color
The map legend border color.
Type: color
The map legend text color.
Type: color
The map legend header color.
Type: gradient
The depth gradient. Default is 0:FF0000,50:ffA500,100:FFFF00,250:00FF00,600:0000FF.
Type: boolean
Setting this parameter to true will not interpolate between the depth steps and the color for a depth <= input is used. Default is true.
Note
scheme.colors.originStatus.* The origin status colors (e.g. in event list).
Type: color
No description available
Type: color
No description available
Type: color
The line width of the marker (e.g. picks of manual picker).
Type: font
The general base font of an application. This overrides the default Qt4 application font.
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: font
No description available
Type: int
The station symbol size (e.g. in scmv). Default is 8.
Type: int
The origin symbol minimum size. The formula to compute the size of the origin symbol is: 4.9*(M-1.2). Default is 9.
Type: boolean
Should the vector layer in the map use antialiasing? This improves the visual quality but decreases performance. Default is false.
Type: boolean
Should the map use a bilinear filter? The bilinear filter improves the visual quality but decreases performance slightly. It is only used for static map images. Not while dragging. Default is true.
Type: boolean
Should the map display the grid? Default is true.
Type: boolean
Should the map display the cities? Default is true.
Type: int
Controls at which zoom level a city will be visible. The following formula is used: screen_width (km) * weight >= population Default is 150.
Type: boolean
Should the map display the custom layers? Default is true.
Type: string
SeisComP ships with the rectangular projection build in. Other projections may be provided through plug-ins. Default is Rectangular.
Type: int
The precision of depth values. Default is 0.
Type: int
The precision of distance values. Default is 1.
Type: int
The precision of lat/lon values. Default is 2.
Type: int
The precision of pick times. Default is 1.
Type: int
Precision of displayed offset/amp in all trace widgets. Default is 1.
Type: int
Precision of RMS values. Default is 1.
Type: boolean
Display distances in km? Default is false.
Type: list:string
Configures the default filters selectable in manual picker. The entry with a leading "@" is selected as default filter. Default is "BP 0.1 - 1 Hz 3rd order;BW(3,0.1,1)","BP 0.1 - 2 Hz 3rd order;BW(3,0.1,2)","BP 0.4 - 1 Hz 3rd order;BW(3,0.4,1)","@BP 0.7 - 2 Hz 3rd order;BW(3,0.7,2)""BP 1 - 3 Hz 3rd order;BW(3,1.0,3)","BP 2 - 4 Hz 3rd order;BW(3,2.0,4)","BP 3 - 6 Hz 3rd order;BW(3,3.0,6)","BP 4 - 8 Hz 3rd order;BW(3,4.0,8)","BP 1 - 5 Hz 3rd order;BW(3,1.0,5)","BP 0.7 - 2 Hz + STA/LTA(1,50);RMHP(10)->ITAPER(30)->BW(3,0.7,2)->STALTA(1,50)".
Type: list:string
Configure the columns of the event list that are visible initially. The first column containing the origin time is always visible and cannot be hidden. Possible values are: Type, M, TP, Phases, Lat, Lon, Depth, Stat, FM, Agency, Region, ID. Default is M, TP, Phases, Lat, Lon, Depth, Stat, Agency, Region, ID.
Type: list:string
Configured a list of regions that can be used as filter of the result set.
Note
eventlist.region.$name.* Defines a rectangular region that can be used as a result set filter on client side. $name is a placeholder for the name to be used and needs to be added to eventlist.regions to become active.
eventlist.regions = a,b
eventlist.region.a.value1 = ...
eventlist.region.b.value1 = ...
# c is not active because it has not been added
# to the list of eventlist.regions
eventlist.region.c.value1 = ...
Type: string
Defines the name of the region that shows up in the listbox.
Type: list:double
Defines a rectangular region with a list of 4 values: latmin, lonmin, latmax, lonmax.
Type: string
Defines the text of the option "Show only own events". Default is Show only own events.
Type: list:string
Sets a list of preferred agencies. Events from preferred agencies are defined as "own" events.
Type: string
Sets the type of the filter. If type is "events" the agency of the preferred origin of the event is checked. If type is "origins" the agency of all origins of an event is checked and if at least one origins agency is part of the whitelist it will pass the filter. Or in other words, the event is hidden if no origin is from a preferred agency. Default is events.
Type: boolean
Sets the default state of the "Show only own events" option. Default is false.
Type: string
Defines the text of the option "Hide other/fake events". Default is Hide other/fake events.
Type: list:string
List of event type to be hidden if the "Hide other/fake events" option is ticked.
Type: boolean
Sets the default state of the "Hide other/fake events" option. Default is false.
Type: boolean
Sets the default state of the "Hide events outside" option. Default is false.
Type: list:string
Configures the default filters selectable in manual picker. The entry with a leading "@" is selected as default filter. Default is "BP 0.1 - 1 Hz 3rd order;BW(3,0.1,1)","BP 0.1 - 2 Hz 3rd order;BW(3,0.1,2)","BP 0.4 - 1 Hz 3rd order;BW(3,0.4,1)","@BP 0.7 - 2 Hz 3rd order;BW(3,0.7,2)""BP 1 - 3 Hz 3rd order;BW(3,1.0,3)","BP 2 - 4 Hz 3rd order;BW(3,2.0,4)","BP 3 - 6 Hz 3rd order;BW(3,3.0,6)","BP 4 - 8 Hz 3rd order;BW(3,4.0,8)","BP 1 - 5 Hz 3rd order;BW(3,1.0,5)","BP 0.7 - 2 Hz + STA/LTA(1,50);RMHP(10)->ITAPER(30)->BW(3,0.7,2)->STALTA(1,50)".
Type: list:string
Configure the columns of the event list that are visible initially. The first column containing the origin time is always visible and cannot be hidden. Possible values are: Type, M, TP, Phases, Lat, Lon, Depth, Stat, FM, Agency, Region, ID. Default is M, TP, Phases, Lat, Lon, Depth, Stat, Agency, Region, ID.
Type: list:string
Configured a list of regions that can be used as filter of the result set.
Note
eventlist.region.$name.* Defines a rectangular region that can be used as a result set filter on client side. $name is a placeholder for the name to be used and needs to be added to eventlist.regions to become active.
eventlist.regions = a,b
eventlist.region.a.value1 = ...
eventlist.region.b.value1 = ...
# c is not active because it has not been added
# to the list of eventlist.regions
eventlist.region.c.value1 = ...
Type: string
Defines the name of the region that shows up in the listbox.
Type: list:double
Defines a rectangular region with a list of 4 values: latmin, lonmin, latmax, lonmax.
Type: string
Defines the text of the option "Show only own events". Default is Show only own events.
Type: list:string
Sets a list of preferred agencies. Events from preferred agencies are defined as "own" events.
Type: string
Sets the type of the filter. If type is "events" the agency of the preferred origin of the event is checked. If type is "origins" the agency of all origins of an event is checked and if at least one origins agency is part of the whitelist it will pass the filter. Or in other words, the event is hidden if no origin is from a preferred agency. Default is events.
Type: boolean
Sets the default state of the "Show only own events" option. Default is false.
Type: string
Defines the text of the option "Hide other/fake events". Default is Hide other/fake events.
Type: list:string
List of event type to be hidden if the "Hide other/fake events" option is ticked.
Type: boolean
Sets the default state of the "Hide other/fake events" option. Default is false.
Type: boolean
Sets the default state of the "Hide events outside" option. Default is false.