Configuration¶
The SeisComP3 configuration uses a unified schema to configure modules. Modules which use the SeisComP3 libraries can read this configuration directly and share global configuration options like messaging connections, database configurations, logging and much more. There are still some modules that do not use the libraries and are called standalone modules such as seedlink, arclink or slarchive. They need wrappers to generate their native configuration when seiscomp update-config is run.
Though it is easy to create the configuration by directly editing the configuration files, it is even more convenient to use a configurator. SeisComP3 ships with a graphical configurator and management tool (scconfig) which makes it easy to maintain module configurations and station bindings even for large networks. It has built-in functionality to check the state of all registered modules and to start and stop them.
The configuration is divided into three parts: stations, bindings and modules.
Configuration files¶
The trunk configuration files are simple text files where each line is a name-value pair.
Warning
In contrast to previous versions of SeisComP3 the parameter names are now case-sensitive. To check configurations from previous versions regarding case-sensitivity, scchkcfg can be used.
A simple example to assign a parameter “skyColor” the value “blue”:
skyColor = blue
Everything following an un-escaped ‘#’ (hash) is a comment and ignored. Blank lines and white spaces are ignored by the parser as well unless quoted or escaped.
skyColor = yellow # This is a comment
# The preceding empty line is ignored and previous setting "yellow"
# is replaced by "blue":
skyColor = blue
Later assignments overwrite earlier ones so the order of lines in the configuration file is important. The file is parsed top-down.
Values can be either scalar values or lists. List items are separated by commas.
# This is a list definition
rainbowColors = red, orange, yellow, green, blue, indigo, violet
If a value needs to include a comma, white space or any other interpretable character it can either be escaped with backslash (\) or quoted using double quotes (“). Whitespaces are removed in unquoted and un-escaped values.
# This is a comment
# The following list definitions have 2 items: 1,2 and 3,4
# quoted values
tuples = "1,2", "3,4"
# escaped values
tuples = 1\,2, 3\,4
Values can extend over multiple lines if a backslash is appended to each line
# Multi-line string
text = "Hello world. "\
"This text spawns 3 lines in the configuration file "\
"but only one line in the value."
# Multi-line list definition
rainbowColors = red,\
orange,\
yellow,\
green, blue,\
indigo, violet
Environment or preceding configuration variables can be used with ${var}
.
homeDir = ${HOME}
myPath = ${homeDir}/test
Note
Values are not type-checked. Type checking is part of the application logic and will be handled there. The configuration file parser will not raise an error if a string is assigned to a parameter that is expected to be an integer.
Namespaces¶
A basic usage of variable names is to organize them in namespaces. A common habit is to separate namespaces and variable names with a period character:
colors.sky = blue
colors.grass = green
Here a namespace called colors
is used. The configuration file parser does
not care about namespaces at all. The final name (including the periods) is what
counts. But to avoid repeating namespaces again and again, declarations can
be wrapped in a namespace block. See the following example:
colors {
sky = blue
grass = green
}
Application code will still access colors.sky
and colors.grass
.
Namespaces can be arbitrarily nested and even survive includes.
A {
B1 {
var1 = 123
}
B2 {
var1 = 456
}
}
The final list of parameter names is:
- A.B1.var1
- A.B2.var1
Stations¶
Station meta-data is a fundamental requirement for a seismic processing system and for SeisComP3. Older version used key files to configure available networks and stations. Because the support of response meta-data was very limited, tools were build to add this functionality. In this version the concept of key files for station meta-data has been completely removed from the system. SeisComP3 only handles station meta-data in its own XML format called inventory ML. The task of supporting old key files, dataless SEED and other formats has been out-sourced to external applications (see Inventory synchronization is a two-stage process:).
External formats are first converted into inventory ML,
and then merged and synchronized with the database using
seiscomp update-config.
All station meta-data are stored in etc/inventory
and can be organized as needed. Either one file per network, a file containing the complete inventory
or one file for all instruments and one file per station. The update script loads the existing inventory
from the database and merges each file in etc/inventory
. Finally it removes all unreferenced
objects and sends all updates to the database.
The SeisComP3 configuration does not deal with station meta-data anymore. It only configures parameters for modules and module-station associations. The management of the inventory can and should be handled by external tools.
Bindings¶
A binding is always connected to a module. The binding configuration directory
for each module is etc/key/modulename
. It contains either station bindings or profiles.
Bindings are configured and stored in etc/key
.
To bind a station (identified by net_sta) to a module with a set of parameters the first step is to register a module for that station. For that a station key file needs to be created or modified.
Note
To reflect the old framework, a station binding is prefixed with station_ and a profile with profile_.
Let’s suppose we have two stations, GE.MORC and GE.UGM and both stations should be configured for
SeedLink. Two station key files need to be created (or modified later): etc/key/station_GE_MORC
and
etc/key/station_GE_UGM
.
Both files must contain a line with the module the station is configured for, e.g.:
seedlink
which uses the binding at etc/key/seedlink/station_GE_UGM
. When a profile should
be used, append it to the module with a colon.
seedlink:geofon
Then the binding at etc/key/seedlink/profile_geofon
is read for station GE.UGM.
To list all modules a particular station is configured for is very simple by printing the content
of the station key file:
$ cat etc/key/station_GE_MORC
seedlink:geofon
global:BH
scautopick
The other way round is a bit more complicated but at least all information is there. To show all stations configured for SeedLink could be done this way:
$ for i in `find etc/key -type f -maxdepth 1 -name "station_*_*"`; do
> egrep -q '^seedlink(:.*){0,1}$' $i && echo $i;
> done
etc/key/station_GE_MORC
etc/key/station_GE_UGM
Storage¶
Where are bindings stored? For standalone modules: nobody knows. It is the task of a standalone module’s initialization script to convert the bindings to the module’s native configuration.
For all trunk (non-standalone) modules the bindings are written to the SeisComP3 database following the configuration schema. This is done when seiscomp update-config is called. Each module reads the configuration database and fetches all station bindings registered for that module. The database schema used consists of five tables: ConfigModule, ConfigStation, Setup, ParameterSet and Parameter.
Now an example is shown how the tables are actually linked and how the station bindings are finally stored in the database. To illustrate the contents of the objects, the XML representation is used.
<Config>
<module publicID="Config/trunk" name="trunk" enabled="true">
...
</module>
</Config>
A ConfigModule with publicID Config/trunk is created with name trunk. This
ConfigModule is managed by the global initialization script (etc/init/trunk.py
)
and will be synchronized with configured bindings of all trunk modules. The
ConfigModule trunk is the one that is actually used by all configurations unless
configured otherwise with:
scapp --config-module test
Here scapp would read ConfigModule test. Because a ConfigModule test is not managed by seiscomp update-config it is up to the user to create it.
For each station that has at least one binding, a ConfigStation object is attached to the ConfigModule:
<Config>
<module publicID="Config/trunk" name="trunk" enabled="true">
<station publicID="Config/trunk/GE/UGM"
networkCode="GE" stationCode="UGM" enabled="true">
...
</station>
</module>
</Config>
and finally one Setup per module:
<Config>
<module publicID="Config/trunk" name="trunk" enabled="true">
<station publicID="Config/trunk/GE/UGM"
networkCode="GE" stationCode="UGM" enabled="true">
<setup name="default" enabled="true">
<parameterSetID>
ParameterSet/trunk/Station/GE/UGM/default
</parameterSetID>
</setup>
<setup name="scautopick" enabled="true">
<parameterSetID>
ParameterSet/trunk/Station/GE/UGM/scautopick
</parameterSetID>
</setup>
</station>
</module>
</Config>
Here two setups have been created: default (which is a special case for module global to be backwards compatible) and scautopick where each refers to a ParameterSet by its publicID. The next XML fragment shows the ParameterSet referred by the scautopick setup of station GE.UGM:
<Config>
<parameterSet publicID="ParameterSet/trunk/Station/GE/UGM/scautopick"
created="...">
<baseID>ParameterSet/trunk/Station/GE/UGM/default</baseID>
<moduleID>Config/trunk</moduleID>
<parameter publicID="...">
<name>timeCorr</name>
<value>-0.8</value>
</parameter>
<parameter publicID="...">
<name>detecFilter</name>
<value>
RMHP(10)>>ITAPER(30)>>BW(4,0.7,2)>>STALTA(2,80)
</value>
</parameter>
<parameter publicID="...">
<name>trigOff</name>
<value>1.5</value>
</parameter>
<parameter publicID="...">
<name>trigOn</name>
<value>3</value>
</parameter>
</parameterSet>
</Config>
The mapping to the binding configuration files is 1:1. Each parameter in the configuration file is exactly one parameter in the database and their names are matching exactly.
The concept of global bindings which are specialized for each application is reflected by the baseID of the ParameterSet which points to setup default of station GE.UGM:
<Config>
<parameterSet publicID="ParameterSet/trunk/Station/GE/UGM/default"
created="...">
<moduleID>Config/trunk</moduleID>
<parameter publicID="...">
<name>detecStream</name>
<value>BH</value>
</parameter>
</parameterSet>
</Config>
This ends up with a final configuration for scautopick and station GE.UGM:
Name | Value |
---|---|
detecStream | BH |
timeCorr | -0.8 |
detecFilter | RMHP(10)>>ITAPER(30)>>BW(4,0.7,2)>>STALTA(2,80) |
trigOff | 1.5 |
trigOn | 3 |
which is the concatenation of the two files etc/key/global/station_GE_UGM
and etc/key/scautopick/station_GE_UGM
.
Modules¶
A module is configured by its configuration files either to be used directly or to generate its native configuration. Modules that need to convert the configuration or do not use the default configuration options (see below) are called standalone modules.
Each standalone module tries to read from three configuration files whereas trunk modules try to read six files. Note that configuration parameters defined earlier are overwritten if defined in files read in later:
File | Standalone | Trunk |
---|---|---|
etc/defaults/global.cfg | X | |
etc/defaults/module.cfg | X | X |
etc/global.cfg | X | |
etc/module.cfg | X | X |
~/.seiscomp3/global.cfg | X | |
~/.seiscomp3/module.cfg | X | X |
The configuration section describes all available configuration parameters for a trunk module. Not all modules make use of all available parameters because they may be disabled, e.g. the messaging component. So the configuration of the messaging server is disabled too.
Extensions¶
Extensions add new configuration options to modules. It does not matter how those extensions are used. Commonly a module loads a plugin, which requires additional configuration parameters - these are provided by an extension.
There are currently extensions for the following modules, corresponding to the plugins shown:
Module | Plugin’s |
---|---|
scm | text ncurses email |
kernel | syncarc messaging |
seedlink | caps q330 mseedfifo chain |
arclink | reqhandler |
global | GUI MLr FX-DFX MLv ML Ms_20 ML_IDC mb_IDC RecordStream LOCSAT FixedHypocenter MN Hypo71 Md NonLinLoc MLh |
scevent | RegionCheck |
See the documentation for each module for further information about its extensions.
Plugins¶
-
The GUI configuration plugin extends the configuration of graphical user interfaces to various options to adjust the look and feel.
-
The MLr plugin is designed to use the MLv station amplitudes and provides a GNS/Geonet local magnitude. The magnitude uses a station correction term and the hypocentral distance. Hard coded range are 0-20 degrees maximum distance and 800 km maximum depth. (Reference:”A Revised Local Magnitude (ML) Scale for New Zealand Earthquakes” J. Ristau, D. Harte, J. Salichon, BSSA Mar 2016, DOI: 10.1785/0120150293)
-
MLv is the Richter (1935) magnitude measured on the vertical component.
-
ML is the Richter (1935) magnitude.
-
Ms_20 is the surface wave magnitude measured on the vertical component at around 20 s period in accordance with the IASPEI standards.
-
CTBTO/IDC local magnitude.
-
Body wave magnitude computed at CTBTO/IDC (mb) is calculated for seismic events from the time-defining primary body waves recorded at seismic stations at an epicentral distance between 20 and 105 degrees from the event.
-
RecordStream interface for SeisComP.
-
LOCSAT locator in SeisComP for computing source time and hypocenter coordinates from phase picks.
-
Locator for re-computing source time with fixed hypocenter
-
The MN plugin is designed to compute the Canadian Nuttli magnitude according to the Geological Survey of Canada.
-
This plugin allows the use of the traditional Hypo71PC locator with SeisComP3.
-
Duration magnitude plugin
-
NonLinLoc locator wrapper plugin for SeisComP. NonLinLoc was written by Anthony Lomax (http://alomax.free.fr/nlloc).
-
The MLh plugin (previously MLsed) is designed to compute amplitudes and magnitudes according to the Swiss Seismological Service (SED) standards.
Configuration¶
-
datacenterID
¶ Type: string
Sets the datacenter ID which is primarily used by Arclink and its tools. Should not contain spaces.
-
agencyID
¶ Type: string
Defines the agency ID used to set creationInfo.agencyID in data model objects. Should not contain spaces. Default is
GFZ
.
-
organization
¶ Type: string
Organization name used mainly by ArcLink and SeedLink. Default is
Unset
.
Type: string
Defines the author name used to set creationInfo.author in data model objects.
-
plugins
¶ Type: list:string
Defines a list of modules loaded at startup.
-
cityXML
¶ Type: string
Path to the cities.xml file. If undefined the data is read from @CONFIGDIR@/cities.xml@ or @DATADIR@/cities.xml@.
-
loadCities
¶ Type: boolean
Enables loading of cities from file configured by cityXML parameter. Default is
false
.
-
loadRegions
¶ Type: boolean
Enables loading of custom fep regions from @CONFIGDIR@/fep or @DATADIR@/fep. Default is
false
.
-
publicIDPattern
¶ Type: string
Defines a custom pattern for generation of public object ids. The following variables are resolved: @classname@ (class name of object), @id@ (public object count), @globalid@ (general object count), @time@ (current time, use ‘/’ to supply custom format, e.g. @time/%FT%T.%fZ@
-
configModule
¶ Type: string
Name of the configuration module. Default is
trunk
.
-
database
¶ Type: string
Defines the database connection. If no database is configured (which is the default) and a messaging connection is available the application will receive the parameters after the connection is established. Override these values only if you know what you are doing.
The format is: service://user:pwd@host/database. “service” is the name of the database driver which can be queried with “–db-driver-list”.
Note that this parameter overrides ‘database.type’ and ‘database.parameters’ if present.
-
recordstream
¶ Type: string
SeisComP3 applications access waveform data through the RecordStream interface. Please consult the SeisComP3 documentation for a list of supported services and their configuration.
This parameter configures recordstream source URL, format: [service://]location[#type]. “service” is the name of the recordstream implementation. If “service” is not given “file://” is implied.
This parameter overrides recordstream.service and recordstream.source and has been added as a shortcut.
-
certStore
¶ Type: path
Path to cerificate store where all certificates and CRLs are stored. The store used the OpenSSl store format. From the offical OpenSSL documentation:
“The directory should contain one certificate or CRL per file in PEM format, with a file name of the form hash.N for a certificate, or hash.rN for a CRL. The .N or .rN suffix is a sequence number that starts at zero, and is incremented consecutively for each certificate or CRL with the same hash value. Gaps in the sequence numbers are not supported, it is assumed that there are no more objects with the same hash beyond the first missing number in the sequence.The .N or .rN suffix is a sequence number that starts at zero, and is incremented consecutively for each certificate or CRL with the same hash value. Gaps in the sequence numbers are not supported, it is assumed that there are no more objects with the same hash beyond the first missing number in the sequence.” The hash value can be obtained as follows:
openssl x509 -hash -noout -in <file> Default is
@ROOTDIR@/var/lib/certs
.
-
logging.level
¶ Type: int
Sets the logging level between 1 and 4 where 1=ERROR, 2=WARNING, 3=INFO and 4=DEBUG. Default is
2
.
-
logging.file
¶ Type: boolean
Enables logging into a log file. Default is
true
.
-
logging.syslog
¶ Type: boolean
Enables logging to syslog if supported by the host system. Default is
false
.
-
logging.components
¶ Type: list:string
Limit the logging to the specified list of components, e.g. ‘Application, Server’
-
logging.component
¶ Type: boolean
For each log entry print the component right after the log level. By default the component output is enabled for file output but disabled for console output.
-
logging.context
¶ Type: boolean
For each log entry print the source file name and line number. Default is
false
.
-
logging.utc
¶ Type: boolean
Use UTC instead of localtime in logging timestamps.
-
logging.file.rotator
¶ Type: boolean
Enables rotation of log files. Default is
true
.
-
logging.file.rotator.timeSpan
¶ Type: int
Unit: s
Time span after which a log file is rotated. Default is
86400
.
-
logging.file.rotator.archiveSize
¶ Type: int
How many historic log files to keep. Default is
7
.
-
logging.file.rotator.maxFileSize
¶ Type: int
Unit: byte
The maximum size of a logfile in byte. The default value is 100 megabyte. If a logfile exceeds that size then it is rotated. To disable the size limit give 0 or a negative value. Default is
104857600
.
-
logging.objects.timeSpan
¶ Type: int
Unit: s
Timespan for counting input/output of objects. Default is
60
.
-
logging.syslog.facility
¶ Type: string
Defines the syslog facility to be used according to the defined facility names in syslog.h. The default is local0. If the given name is invalid or not available, initializing logging will fail and the application quits. Default is
local0
.
-
connection.server
¶ Type: host-with-port
Defines the Spread server name to connect to. Format is host[:port]. Default is
localhost
.
-
connection.username
¶ Type: string
Defines the username to be used. The length is limited to 10 characters with Spread. By default the module name (name of the executable) is used but sometimes it exceeds the 10 character limit and access is denied. To prevent errors set a different username. An empty username will let Spread generate one.
-
connection.timeout
¶ Type: int
Unit: s
The connection timeout in seconds. 3 seconds are normally more than enough. If a client needs to connect to a remote system with a slow connection a larger timeout might be needed. Default is
3
.
-
connection.primaryGroup
¶ Type: string
Defines the primary group of a module. This is the name of the group where a module sends its messages to if the target group is not explicitely given in the send call.
-
connection.encoding
¶ Type: string
Defines the message encoding for sending. Allowed values are “binary” or “xml”. XML has more overhead in processing but is more robust when schema versions between client and server are different. Default is
binary
.
-
connection.subscriptions
¶ Type: list:string
Defines a list of message groups to subscribe to. The default is usually given by the application and does not need to be changed.
Note
database.* Defines the database connection. If no database is configured (which is the default) and a messaging connection is available the application will receive the parameters after the connection is established. Override these values only if you know what you are doing.
-
database.type
¶ Type: string
Defines the database backend to be used. The name corresponds to the defined name in the database plugin. Examples are: mysql, postgresql or sqlite3. Note that this parameter is deprecated. Please use ‘database = mysql://localhost/seiscomp3’ instead.
-
database.parameters
¶ Type: string
The database connection parameters. This value depends on the used database backend. E.g. sqlite3 expects the path to the database file whereas MYSQL or PostgreSQL expect an URI in the format user:pwd@host/database?param1=val1¶m2=val2. Note that this parameter is deprecated. Please use ‘database = mysql://localhost/seiscomp3’ instead.
-
database.inventory
¶ Type: string
Load the inventory database from a given XML file if set. This overrides the inventory definitions loaded from the database backend.
-
database.config
¶ Type: string
Load the configuration database from a given XML file if set. This overrides the configuration definitions loaded from the database backend.
-
processing.whitelist.agencies
¶ Type: list:string
Defines a whitelist of agencies that are allowed for processing separated by comma.
-
processing.blacklist.agencies
¶ Type: list:string
Defines a blacklist of agencies that are not allowed for processing separated by comma.
-
inventory.whitelist.nettype
¶ Type: list:string
List of network types to include when loading the inventory.
-
inventory.whitelist.statype
¶ Type: list:string
List of station types to include when loading the inventory.
-
inventory.blacklist.nettype
¶ Type: list:string
List of network types to exclude when loading the inventory.
-
inventory.blacklist.statype
¶ Type: list:string
List of station types to exclude when loading the inventory.
Note
recordstream.* SeisComP3 applications access waveform data through the RecordStream interface. Please consult the SeisComP3 documentation for a list of supported services and their configuration. Note that this set of parameters is deprecated and will be removed in future versions. Please use the short form (recordstream = slink://localhost) in future.
-
recordstream.service
¶ Type: string
Name of the recordstream service implementation. Default is
slink
.
-
recordstream.source
¶ Type: string
Service specific parameters like a IP address or a file name to use. Default is
localhost:18000
.
-
scripts.crashHandler
¶ Type: path
Path to crash handler script
-
core.plugins
¶ Type: list:string
Defines a list of core modules loaded at startup. Default is
dbmysql
.
-
client.startStopMessage
¶ Type: boolean
Enables sending of an application start- and stop message to the STATUS_GROUP. Default is
false
.
-
client.autoShutdown
¶ Type: boolean
Enablgs automatic application shutdown triggered by a status message. Default is
false
.
-
client.shutdownMasterModule
¶ Type: string
Triggers shutdown if the module name of the received messages match
-
client.shutdownMasterUsername
¶ Type: string
Triggers shutdown if the user name of the received messages match
-
commands.target
¶ Type: string
A regular expression of all clients that should handle a command message usually send to the GUI messaging group. Currently this flag is only used by GUI applications to set an artificial origin and to tell other clients to show this origin. To let all connected clients handle the command, “.*$” can be used.
Note
ttt.* Travel time table related configuration. Travel time tables can be added via plugins. Built-in interfaces are libtau and LOCSAT. For each loaded interface a list of supported models must be provided. The default list of tables for libtau is ak135 and iasp91. LOCSAT’s default tables are iasp91 and tab.
Note
ttt.$name.* $name is a placeholder for the name to be used.
-
ttt.$name.tables
¶ Type: list:string
The list of supported model names per interface.
GUI extension¶
The GUI configuration plugin extends the configuration of graphical user interfaces to various options to adjust the look and feel.
Note
groups.* Configures the target messaging groups for various object types. These parameters should only be touched if you know what you are doing.
-
groups.pick
¶ Type: string
Defines the target messaging group for manual picks, e.g. made in scolv. Default is
PICK
.
-
groups.amplitude
¶ Type: string
Defines the target messaging group for amplitudes, e.g. computed in scolv. Default is
AMPLITUDE
.
-
groups.magnitude
¶ Type: string
Defines the target messaging group for magnitudes. scolv does not use this group but sends magnitudes together with the origin to the origin group. Default is
MAGNITUDE
.
-
groups.location
¶ Type: string
Defines the target messaging group for origins created in e.g. scolv. Default is
LOCATION
.
-
groups.focalMechanism
¶ Type: string
Defines the target messaging group for focal mechanisms created in e.g. scolv. Default is
FOCMECH
.
-
groups.event
¶ Type: string
Defines the target messaging group for events and event journal entries. Default is
EVENT
.
-
map.location
¶ 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
.
-
map.format
¶ Type: string
Projection of the map tiles. Supported formats are: rectangular and mercator. Default is
rectangular
.
-
map.cacheSize
¶ Type: int
Unit: bytes
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
.
-
map.type
¶ Type: string
Used to distinguish tile store implementations provided by plug-ins.
-
map.customLayers
¶ Type: list:string
Allows to add custom layers that are included via plugins. This is a list of layer names. A plugin must implement the layer interface and register itself with the name used in this list. The order of layers is the default order. The custom layers are prepended to the maps defaults layers such as the grid and the cities.
-
map.layers
¶ Type: string
Defines the order of all configured layers. This includes the standard layers (grid, cities) as well as custom layers. The name of the grid layer is “grid” and the name of the cities layer is “cities”.
Note
map.layers.events.* Configuration options for the events layer that shows all events on the map that are loaded in the event list.
-
map.layers.events.visible
¶ Type: boolean
Default is
false
.
-
map.layers.cities.topPopulatedPlaces
¶ Type: int
Maximum number of cities to be rendered. If cityPopulationWeight is less or equal than 0 then all cities are rendered ordered by population count, highest first. To show the N most populated places in the visible map region, set “scheme.map.cityPopulationWeight” to 0 and set this parameter to N. Default is
-1
.
-
map.zoom.sensitivity
¶ Type: double
Zoom sensitivity of the map Default is
0.5
.
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.
-
scheme.showMenu
¶ Type: boolean
Show menu bar. Default is
true
.
-
scheme.showStatusBar
¶ Type: boolean
Show status bar. Default is
true
.
-
scheme.tabPosition
¶ 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
-
scheme.map.stationSize
¶ Type: int
Unit: px
The station symbol size (e.g. in scmv). Default is
8
.
-
scheme.map.originSymbolMinSize
¶ Type: int
Unit: px
The origin symbol minimum size. The formula to compute the size of the origin symbol is: 4.9*(M-1.2). Default is
9
.
-
scheme.map.vectorLayerAntiAlias
¶ Type: boolean
Should the vector layer in the map use antialiasing? This improves the visual quality but decreases performance. Default is
false
.
-
scheme.map.bilinearFilter
¶ 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
.
-
scheme.map.showGrid
¶ Type: boolean
Should the map display the grid? Default is
true
.
-
scheme.map.showCities
¶ Type: boolean
Should the map display the cities? Default is
true
.
-
scheme.map.cityPopulationWeight
¶ 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
.
-
scheme.map.showLayers
¶ Type: boolean
Should the map display the custom layers? Default is
true
.
-
scheme.map.showLegends
¶ Type: boolean
Show map legends initially. Some applications provide controls to toggle the visibility in addition to this option. Default is
false
.
-
scheme.map.projection
¶ Type: string
SeisComP ships with the rectangular projection built-in. Other projections may be provided through plugins. Default is
Rectangular
.
-
scheme.map.toBGR
¶ Type: boolean
Converts map colors from RGB color scheme to BGR. Default is
false
.
-
scheme.map.polygonRoughness
¶ Type: int
Unit: px
Minimum screen distance to plot a polygon or polyline line segment. Default is
3
.
-
scheme.colors.background
¶ Type: color
A general application background color. Can be used to give each application a different background color. An unset value lets Qt decide.
-
scheme.colors.map.lines
¶ Type: color
The color of lines in the map (e.g. lines connecting the origin and a station).
-
scheme.colors.map.outlines
¶ Type: color
The color of station outlines in the map.
-
scheme.colors.map.stationAnnotations
¶ Type: color
The color of station annotations.
-
scheme.colors.map.cityLabels
¶ Type: color
The color of city labels.
-
scheme.colors.map.cityOutlines
¶ Type: color
The color of city outlines.
-
scheme.colors.map.cityCapital
¶ Type: color
The color of a capital.
-
scheme.colors.map.cityNormal
¶ Type: color
The color of a “normal” city.
Note
scheme.colors.map.grid.* Defines the pen of the latitude/longitude grid of the map.
-
scheme.colors.map.grid.color
¶ Type: color
The color of the pen. Default is
FFFFFF
.
-
scheme.colors.map.grid.style
¶ Type: string
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. Default is
DotLine
.
-
scheme.colors.map.grid.width
¶ Type: double
The width of the pen. Default is
1
.
-
scheme.colors.records.foreground
¶ Type: color
The general color of records/traces. Default is
808080
.
-
scheme.colors.records.alternateForeground
¶ Type: color
A general trace color of the alternate trace (eg scheli). Default is
808080
.
-
scheme.colors.records.background
¶ Type: color
The general background color of records/traces.
-
scheme.colors.records.alternateBackground
¶ Type: color
A general background color of the alternate trace.
-
scheme.colors.records.spectrogram
¶ Type: color
The trace color used on top of a spectrogram. Default is
000000
.
-
scheme.colors.records.gaps
¶ Type: color
The color of data gaps in trace views. Default is
FFFF0040
.
-
scheme.colors.records.overlaps
¶ Type: color
The color of data overlaps in trace views. Default is
FF00FF40
.
-
scheme.colors.records.alignment
¶ Type: color
The color of the alignment marker in trace views. Default is
FF0000
.
Note
scheme.colors.records.offset.* Defines the pen of the record offset line.
-
scheme.colors.records.offset.color
¶ Type: color
The color of the pen. Default is
C0C0FF
.
-
scheme.colors.records.offset.style
¶ Type: string
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. Default is
SolidLine
.
-
scheme.colors.records.offset.width
¶ Type: double
The width of the pen. Default is
0.0
.
Note
scheme.colors.records.gridPen.* Defines the pen of the record grid.
-
scheme.colors.records.gridPen.color
¶ Type: color
The color of the pen. Default is
00000020
.
-
scheme.colors.records.gridPen.style
¶ Type: string
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. Default is
DashLine
.
-
scheme.colors.records.gridPen.width
¶ Type: double
The width of the pen. Default is
1.0
.
Note
scheme.colors.records.subGridPen.* Defines the pen of the secondary record grid.
-
scheme.colors.records.subGridPen.color
¶ Type: color
The color of the pen. Default is
00000000
.
-
scheme.colors.records.subGridPen.style
¶ Type: string
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. Default is
DotLine
.
-
scheme.colors.records.subGridPen.width
¶ Type: double
The width of the pen. Default is
1.0
.
Note
scheme.colors.records.states.* Defines the background color of records depending on their state.
-
scheme.colors.records.states.unrequested
¶ Type: color
Additional data which was not requested. Default is
00000080
.
-
scheme.colors.records.states.requested
¶ Type: color
Requested data Background color of requested data. Default is
ffff0080
.
-
scheme.colors.records.states.inProgress
¶ Type: color
Data currently loading. Default is
00ff0010
.
-
scheme.colors.records.states.notAvailable
¶ Type: color
Data which was requested but is not available. Default is
ff000080
.
-
scheme.colors.picks.manual
¶ Type: color
The color of manual picks. Default is
00FF00
.
-
scheme.colors.picks.automatic
¶ Type: color
The color of automatic picks. Default is
FF0000
.
-
scheme.colors.picks.undefined
¶ Type: color
The color of picks with undefined state. Default is
A0A0A4
.
-
scheme.colors.picks.disabled
¶ Type: color
The color of disabled picks. Default is
A0A0A4
.
-
scheme.colors.arrivals.manual
¶ Type: color
The color of manual arrivals (arrivals that bind manual picks, e.g. residual plot of scolv, manual picker, …) Default is
00A000
.
-
scheme.colors.arrivals.automatic
¶ Type: color
The color of automatic arrivals, Default is
A00000
.
-
scheme.colors.arrivals.theoretical
¶ Type: color
The color of theoretical arrivals. Default is
0000A0
.
-
scheme.colors.arrivals.undefined
¶ Type: color
The color of arrivals binding picks with undefined state. Default is
A00000
.
-
scheme.colors.arrivals.disabled
¶ Type: color
The color of disabled arrivals. Default is
A0A0A4
.
-
scheme.colors.arrivals.residuals
¶ 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)”, …
-
scheme.colors.magnitudes.set
¶ Type: color
The color of active magnitudes. Default is
00A000
.
-
scheme.colors.magnitudes.unset
¶ Type: color
The color of inactive magnitudes. Default is
000000
.
-
scheme.colors.magnitudes.disabled
¶ Type: color
The color of disabled magnitudes. Default is
A0A0A4
.
-
scheme.colors.magnitudes.residuals
¶ Type: gradient
The gradient of magnitude residuals.
-
scheme.colors.stations.text
¶ Type: color
The color of the station name. Default is
ffffff
.
-
scheme.colors.stations.associated
¶ Type: color
The color of associated stations (e.g. in scmv). Default is
82AD58
.
-
scheme.colors.stations.triggering
¶ Type: color
The color of triggered stations.
-
scheme.colors.stations.triggered0
¶ Type: color
No description available
-
scheme.colors.stations.triggered1
¶ Type: color
No description available
-
scheme.colors.stations.triggered2
¶ Type: color
No description available
-
scheme.colors.stations.disabled
¶ Type: color
The color of disabled stations.
-
scheme.colors.stations.idle
¶ Type: color
The color of idle stations.
Note
scheme.colors.qc.* The color of QC.delay thresholds in scmv.
-
scheme.colors.qc.delay0
¶ Type: color
Default is
00ffff
.
-
scheme.colors.qc.delay1
¶ Type: color
Default is
00ff00
.
-
scheme.colors.qc.delay2
¶ Type: color
Default is
fffd00
.
-
scheme.colors.qc.delay3
¶ Type: color
Default is
ff6633
.
-
scheme.colors.qc.delay4
¶ Type: color
Default is
ff0000
.
-
scheme.colors.qc.delay5
¶ Type: color
Default is
cccccc
.
-
scheme.colors.qc.delay6
¶ Type: color
Default is
999999
.
-
scheme.colors.qc.delay7
¶ Type: color
Default is
666666
.
-
scheme.colors.qc.qcWarning
¶ Type: color
Default is
ffff00
.
-
scheme.colors.qc.qcError
¶ Type: color
Default is
ff0000
.
-
scheme.colors.qc.qcOk
¶ Type: color
Default is
00ff00
.
-
scheme.colors.qc.qcNotSet
¶ Type: color
Default is
000000
.
Note
scheme.colors.gm.* The color of ground motion amplitudes in scmv.
-
scheme.colors.gm.gm0
¶ Type: color
No description available
-
scheme.colors.gm.gm1
¶ Type: color
No description available
-
scheme.colors.gm.gm2
¶ Type: color
No description available
-
scheme.colors.gm.gm3
¶ Type: color
No description available
-
scheme.colors.gm.gm4
¶ Type: color
No description available
-
scheme.colors.gm.gm5
¶ Type: color
No description available
-
scheme.colors.gm.gm6
¶ Type: color
No description available
-
scheme.colors.gm.gm7
¶ Type: color
No description available
-
scheme.colors.gm.gm8
¶ Type: color
No description available
-
scheme.colors.gm.gm9
¶ Type: color
No description available
-
scheme.colors.gm.gmNotSet
¶ Type: color
No description available
-
scheme.colors.recordView.selectedTraceZoom
¶ Type: color
The color of the selected zoom area (e.g. manual picker). Default is
C0C0FFC0
.
-
scheme.colors.legend.background
¶ Type: color
The map legend background color.
-
scheme.colors.legend.border
¶ Type: color
The map legend border color.
-
scheme.colors.legend.text
¶ Type: color
The map legend text color.
-
scheme.colors.legend.headerText
¶ Type: color
The map legend header color.
-
scheme.colors.originSymbol.classic
¶ Type: boolean
Default is
false
.
-
scheme.colors.originSymbol.depth.gradient
¶ Type: gradient
The depth gradient. Default is
0:FF0000,50:ffA500,100:FFFF00,250:00FF00,600:0000FF
.
-
scheme.colors.originSymbol.depth.discrete
¶ 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).
-
scheme.colors.originStatus.automatic
¶ Type: color
No description available
-
scheme.colors.originStatus.manual
¶ Type: color
No description available
Note
scheme.colors.splash.* Defines colors used in the splash screen shown at application startup.
-
scheme.colors.splash.message
¶ Type: color
Text color of the message string. Default is
808080
.
-
scheme.colors.splash.version
¶ Type: color
Text color of the version string. Default is
02589e
.
-
scheme.marker.lineWidth
¶ Type: int
The line width of the marker (e.g. picks of manual picker).
-
scheme.records.lineWidth
¶ Type: int
The line width of the records / traces. Default is
1
.
-
scheme.records.antiAliasing
¶ Type: boolean
Configures antialiasing of records / traces. Antialiasing needs more two times to storage space as non antialiasing but it improves visual quality. Default is
true
.
-
scheme.records.optimize
¶ Type: boolean
Configures optimization of trace polylines. If activated then lines on the same pixel line or same pixel row collapse into single lines. Default is
true
.
Note
scheme.fonts.base.* The general base font of an application. This overrides the default Qt4 application font.
-
scheme.fonts.base.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.base.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.base.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.base.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.base.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.base.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.small.* The smallest available font. If undefined the point size is 2 points smaller than the base font.
-
scheme.fonts.small.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.small.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.small.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.small.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.small.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.small.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.normal.* The default text font. If undefined the point size is 2 points larger than the base font.
-
scheme.fonts.normal.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.normal.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.normal.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.normal.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.normal.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.normal.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.large.* The largest text font. If undefined the point size is 6 points larger than the base font.
-
scheme.fonts.large.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.large.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.large.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.large.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.large.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.large.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.highlight.* Font used to highlight text. If undefined it equals the normal font except for a bold font face.
-
scheme.fonts.highlight.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.highlight.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.highlight.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.highlight.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.highlight.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.highlight.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.heading1.* The largest heading font. If undefined it uses a bold font face and a font size twice as large as the normal font.
-
scheme.fonts.heading1.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.heading1.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.heading1.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading1.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading1.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading1.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.heading2.* The second largest heading font. If undefined it uses a bold font face and a font size twice as large as the base font.
-
scheme.fonts.heading2.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.heading2.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.heading2.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading2.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading2.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading2.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.heading3.* The smallest heading font. If undefined it uses a bold font face and a font size 4 points larger than the base font.
-
scheme.fonts.heading3.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.heading3.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.heading3.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading3.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading3.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.heading3.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.cityLabels.* Font used for city labels. If undefined it equals the base font.
-
scheme.fonts.cityLabels.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.cityLabels.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.cityLabels.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.cityLabels.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.cityLabels.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.cityLabels.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.splashVersion.* Font used for version string in the splash dialog shown at application startup. If undefined it equals the base font with a bold font face and a font size of 12.
-
scheme.fonts.splashVersion.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.splashVersion.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.splashVersion.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashVersion.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashVersion.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashVersion.overline
¶ Type: boolean
Default is
false
.
Note
scheme.fonts.splashMessage.* Font used for the message text in the splash dialog shown at application startup. If undefined it equals the base font with a font size of 12.
-
scheme.fonts.splashMessage.family
¶ Type: string
Sets the family name of the font. The name is case insensitive and may include a foundry name.
-
scheme.fonts.splashMessage.size
¶ Type: int
Defines the point size of the font
-
scheme.fonts.splashMessage.bold
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashMessage.italic
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashMessage.underline
¶ Type: boolean
Default is
false
.
-
scheme.fonts.splashMessage.overline
¶ Type: boolean
Default is
false
.
-
scheme.precision.depth
¶ Type: int
The precision of depth values. Default is
0
.
-
scheme.precision.distance
¶ Type: int
The precision of distance values. Default is
1
.
-
scheme.precision.location
¶ Type: int
The precision of lat/lon values. Default is
2
.
-
scheme.precision.magnitude
¶ Type: int
The precision of magnitude values. Default is
2
.
-
scheme.precision.pickTime
¶ Type: int
The precision of pick times. Default is
1
.
-
scheme.precision.traceValues
¶ Type: int
Precision of displayed offset/amp in all trace widgets. Default is
1
.
-
scheme.precision.rms
¶ Type: int
Precision of RMS values. Default is
1
.
-
scheme.precision.uncertainties
¶ Type: int
Precision of uncertainty values, e.g. latitude errors. Default is
0
.
-
scheme.unit.distanceInKM
¶ Type: boolean
Display distances in km? Default is
false
.
-
scheme.dateTime.useLocalTime
¶ Type: boolean
Display times in localtime or UTC (default). Default is
false
.
Note
scheme.splash.* Defines the appearance of the splash screen shown at application startup.
Note
scheme.splash.message.* Position of the message text.
-
scheme.splash.message.align
¶ Type: int
Qt::Alignment bit mask. Default: AlignHCenter | AlignBottom Default is
44
.
Note
scheme.splash.message.pos.* Position in screen coordinates.
-
scheme.splash.message.pos.x
¶ Type: int
Horizontal position. Default is
200
.
-
scheme.splash.message.pos.y
¶ Type: int
Vertical position. Default is
260
.
Note
scheme.splash.version.* Position of the version string
-
scheme.splash.version.align
¶ Type: int
Qt::Alignment bit mask. Default: AlignRight | AlignBottom Default is
34
.
Note
scheme.splash.version.pos.* Position in screen coordinates.
-
scheme.splash.version.pos.x
¶ Type: int
Horizontal position. Default is
362
.
-
scheme.splash.version.pos.y
¶ Type: int
Vertical position. Default is
190
.
Note
events.timeAgo.* Defines maximum age of events to load. The value of all parameters are aggregated.
-
events.timeAgo.days
¶ Type: int
Unit: d
Age in days. Default is
1
.
-
events.timeAgo.hours
¶ Type: int
Unit: h
Age in hours. Default is
0
.
-
events.timeAgo.minutes
¶ Type: int
Unit: m
Age in minutes. Default is
0
.
-
events.timeAgo.seconds
¶ Type: int
Unit: s
Age in seconds. Default is
0
.
Note
mode.* Configuration of special applications modes.
-
mode.interactive
¶ Type: boolean
Defines if application interaction is allowed. Default is
true
.
-
mode.fullscreen
¶ Type: boolean
Defines if the application should be launched in fullscreen mode hiding title bar, main menu and status bar. Default is
false
.
-
picker.filters
¶ 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)"
.
-
eventlist.visibleColumns
¶ 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, MTYPE, Phases, Lat, Lon, Depth, Stat, FM, Agency, Region, ID. Default is
M, MType, Phases, Lat, Lon, Depth, Stat, Agency, Region, ID
.
-
eventlist.regions
¶ Type: list:string
Configured a list of regions that can be used as filter of the result set.
-
eventlist.customColumn
¶ Type: string
Name of an additional custom column which displays the value of certain origin and event comments.
-
eventlist.customColumn.originCommentID
¶ Type: string
ID of the origin comment to look up.
-
eventlist.customColumn.eventCommentID
¶ Type: string
ID of the event comment to look up.
-
eventlist.customColumn.pos
¶ Type: int
Position of the column. If the configured position is less than 0 or if it exceeds the total number of columns then the column is appended to the right. Default is
-1
.
-
eventlist.customColumn.default
¶ Type: string
Default value to display if the specified origin or event comment id was not found.
-
eventlist.customColumn.colors
¶ Type: list:string
Mapping of comment values to colors used as text color. E.g. “foo:#000,bar:red”.
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 = ...
-
eventlist.region.$name.name
¶ Type: string
Defines the name of the region that shows up in the listbox.
-
eventlist.region.$name.rect
¶ Type: list:double
Defines a rectangular region with a list of 4 values: latmin, lonmin, latmax, lonmax.
-
eventlist.filter.agencies.label
¶ Type: string
Defines the text of the option “Show only own events”. Default is
Show only own events
.
-
eventlist.filter.agencies.whitelist
¶ Type: list:string
Sets a list of preferred agencies. Events from preferred agencies are defined as “own” events.
-
eventlist.filter.agencies.type
¶ 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
.
-
eventlist.filter.agencies.enabled
¶ Type: boolean
Sets the default state of the “Show only own events” option. Default is
false
.
-
eventlist.filter.types.label
¶ Type: string
Defines the text of the option “Hide other/fake events”. Default is
Hide other/fake events
.
-
eventlist.filter.types.blacklist
¶ Type: list:string
List of event type to be hidden if the “Hide other/fake events” option is ticked.
-
eventlist.filter.types.enabled
¶ Type: boolean
Sets the default state of the “Hide other/fake events” option. Default is
false
.
-
eventlist.filter.regions.enabled
¶ Type: boolean
Sets the default state of the “Hide events outside” option. Default is
false
.
Note
eventlist.filter.database.* Pre-set options to filter an event list request.
-
eventlist.filter.database.minlat
¶ Type: double
Unit: deg
No description available
-
eventlist.filter.database.maxlat
¶ Type: double
Unit: deg
No description available
-
eventlist.filter.database.minlon
¶ Type: double
Unit: deg
No description available
-
eventlist.filter.database.maxlon
¶ Type: double
Unit: deg
No description available
-
eventlist.filter.database.mindepth
¶ Type: double
Unit: km
No description available
-
eventlist.filter.database.maxdepth
¶ Type: double
Unit: km
No description available
-
eventlist.filter.database.minmag
¶ Type: double
No description available
-
eventlist.filter.database.maxmag
¶ Type: double
No description available
-
eventlist.scripts.columns
¶ Type: list:string
Registration of custom event list columns.
Note
eventlist.scripts.column.* Definition of custom event list column whose values are filled by external scripts.
Note
eventlist.scripts.column.$name.* $name is a placeholder for the name to be used.
-
eventlist.scripts.column.$name.script
¶ Type: path
External script to invoke for each event list entry. The object represented by the list entry is serialized to XML and passed to the script on stdin. If the return code of the script is 0 (‘success’) then the script result is read from stdout and displayed in the corresponding event list cell.
-
eventlist.scripts.column.$name.pos
¶ Type: int
Position of the column. If the configured position is less than 0 or if it exceeds the total number of columns then the column is appended to the right. Default is
-1
.
-
eventlist.scripts.column.$name.label
¶ Type: string
Column name shown in header of event list table.
-
eventlist.scripts.column.$name.types
¶ Type: list:string
Object types this script should be invoked for. Supported values are ‘Event’ and ‘Origin’.
Note
eventsummary.* Parameters controlling the event summary view used e.g. in scolv.
-
eventsummary.alertTimer.commentId
¶ Type: string
Set an alert for every event comment that ID matches the specified regular expression, e.g. “alert_.*”.
-
eventsummary.alertTimer.commentBlacklist
¶ Type: list:string
List of comments to ignore, e.g. “nil”.
-
eventsummary.alertTimer.alertGradient
¶ Type: list:string
Unit: s:color
Discrete mapping of time values in seconds to colors used as text color in case of an active alert. E.g. “0:00FF00,900:FF0000”.
-
eventsummary.alertTimer.textSize
¶ Type: int
Unit: pt
The text size of the time ago label in case of an active alert.
LOCSAT extension¶
LOCSAT locator in SeisComP for computing source time and hypocenter coordinates from phase picks.
Note
LOCSAT.* Locator parameters: LOCSAT
-
LOCSAT.profiles
¶ Type: list:string
Defines a list of available LOCSAT travel-time tables. Default is
iasp91,tab
.
-
LOCSAT.enableConfidenceEllipsoid
¶ Type: boolean
Compute the confidence ellipsoid. Default is
false
.
-
LOCSAT.depthInit
¶ Type: double
Unit: km
The initial depth estimate for LOCSAT. Default is
20.0
.
-
LOCSAT.defaultTimeError
¶ Type: double
Unit: s
The default pick time uncertainty assigned to LOCSAT’s arrival deltim attribute if pick uncertainties are not going to be used or if they are absent. A time uncertainty of 0 s may result in errors of the SVD decomposition in LOCSAT. Default is
1.0
.
-
LOCSAT.usePickUncertainties
¶ Type: boolean
Whether to use pick time untertainties for arrival deltim rather than a fixed time error. If true then the uncertainties are retrieved from each individual pick object. If they are not defined then the default pick time uncertainty will be used as fallback. Default is
false
.
-
LOCSAT.degreesOfFreedom
¶ Type: int
Number of degrees of freedom. Default is
9999
.
-
LOCSAT.confLevel
¶ Type: double
Confidence level between 0.5 and 1. Default is
0.9
.
FixedHypocenter extension¶
Locator for re-computing source time with fixed hypocenter
Note
FixedHypocenter.* Locator parameters: FixedHypocenter
-
FixedHypocenter.profiles
¶ Type: list:string
Defines a list of available travel time tables. Each item is a tuple separated by a slash with format “[interface]/[model]”. Built-in interfaces are “LOCSAT” and “libtau”. Other interfaces might be added via plugins. Please check their documentation for the required interface name. Default is
LOCSAT/iasp91,LOCSAT/tab
.
-
FixedHypocenter.usePickUncertainties
¶ Type: boolean
Whether to use pick time uncertainties rather than a fixed time error. If true, then the uncertainties are retrieved from each individual pick object. If they are not defined, then the default pick time uncertainty as defined by defaultTimeError will be used instead. Default is
false
.
-
FixedHypocenter.defaultTimeError
¶ Type: double
Unit: s
The default pick time uncertainty if pick uncertainties are not going to be used or if they are absent. Default is
1.0
.
-
FixedHypocenter.degreesOfFreedom
¶ Type: int
Number of degrees of freedom used for error estimate. Default is
8
.
-
FixedHypocenter.confLevel
¶ Type: double
Confidence level between 0.5 and 1. Default is
0.9
.
MN extension¶
The MN plugin is designed to compute the Canadian Nuttli magnitude according to the Geological Survey of Canada.
-
amplitudes.MN.velocityModel
¶ Type: string
The travel time table set compiled for LocSAT. The tables are located in “share/locsat/tables/[vmodel].*”. Default is
iasp91
.
-
magnitudes.MN.region
¶ Type: path
The path to the BNA file which defines the valid region for the MN magnitude. Note that the entire path from source to receiver must lie entirely within the polygon(s). Default is
@DATADIR@/magnitudes/MN/MN.bna
.
Hypo71 extension¶
This plugin allows the use of the traditional Hypo71PC locator with SeisComP3.
Note
hypo71.* General Hypo71 configuration parameters.
-
hypo71.logFile
¶ Type: string
Temporary file used by Hypo71 to store calculation logs. Default is
@LOGDIR@/HYPO71.LOG
.
-
hypo71.inputFile
¶ Type: string
Temporary file to write Hypo71 input data to. Default is
@DATADIR@/hypo71/HYPO71.INP
.
-
hypo71.outputFile
¶ Type: string
Temporary output file to read Hypo71 location data from. Default is
@DATADIR@/hypo71/HYPO71.PRT
.
-
hypo71.defaultControlFile
¶ Type: string
Hypo71 default profile. If no custom profile is specified, this profile will be used by the plugin when proceeding to a localization. Default is
@DATADIR@/hypo71/profiles/default.hypo71.conf
.
-
hypo71.hypo71ScriptFile
¶ Type: string
Bash script executed when calling the Hypo71 locator plugin for locating the earthquake. Default is
@DATADIR@/hypo71/run.sh
.
-
hypo71.profiles
¶ Type: list:string
Hypo71 profile name. Multiples names may be set. They must be separated by comma. Each profile can have different velocity or parameters.
-
hypo71.publicID
¶ Type: string
Custom patternID to use when generating origin publicID
-
hypo71.useHypo71PatternID
¶ Type: boolean
Specifies if the given publicD should be used for generating origin publicID
Note
hypo71.profile.* Profiles containing the profile-specific velocity model and the Hypo71 parameters.
Note
hypo71.profile.$name.*
$name is a placeholder for the name to be used and needs to be added to hypo71.profiles
to become active.
hypo71.profiles = a,b
hypo71.profile.a.value1 = ...
hypo71.profile.b.value1 = ...
# c is not active because it has not been added
# to the list of hypo71.profiles
hypo71.profile.c.value1 = ...
-
hypo71.profile.$name.earthModelID
¶ Type: string
Profile’s velocity model name.
-
hypo71.profile.$name.methodID
¶ Type: string
Profile’s method. It is generally the locator’s name (Hypo71). Default is
Hypo71
.
-
hypo71.profile.$name.controlFile
¶ Type: string
File containing the profile parameters.
-
hypo71.profile.$name.fixStartDepthOnly
¶ Type: boolean
If the depth is requested to be fixed (e.g. by ticking the option in scolv) the plugin performs only one location starting at specified depth but with free depth evaluation. This option defines whether it should really fix the depth (false) or use this fixed depth only as starting point (true). Default is
false
.
NonLinLoc extension¶
NonLinLoc locator wrapper plugin for SeisComP. NonLinLoc was written by Anthony Lomax (http://alomax.free.fr/nlloc).
-
NonLinLoc.publicID
¶ Type: string
PublicID creation pattern for an origin created by NonLinLoc. Default is
NLL.@time/%Y%m%d%H%M%S.%f@.@id@
.
-
NonLinLoc.outputPath
¶ Type: path
Defines the output path for all native NonLinLoc input and output files. Default is
/tmp/sc3.nll
.
-
NonLinLoc.saveInput
¶ Type: boolean
Save input files *.obs in outputPath for later processing. Setting to false reduces file i/o and saves disk space. Default is
true
.
-
NonLinLoc.saveIntermediateOutput
¶ Type: boolean
Save output files in outputPath for later processing or for viewing by the Seismicity Viewer. Setting to false reduces file i/o and saves disk space. Default is
true
.
-
NonLinLoc.controlFile
¶ Type: path
The default NonLinLoc control file to use.
-
NonLinLoc.defaultPickError
¶ Type: double
The default pick error in seconds passed to NonLinLoc if a SC3 pick object does not provide pick time uncertainties. Default is
0.5
.
-
NonLinLoc.fixedDepthGridSpacing
¶ Type: double
Since NLL does not support fixing the depth natively so this feature is emulated by settings the Z grid very tight around the depth to be fixed. This value sets the Z grid spacing. Default is
0.1
.
-
NonLinLoc.allowMissingStations
¶ Type: boolean
Picks from stations with missing configuration will be ignored. The origin will be relocated without that pick if possible.
If set to false, the plug-in throws an excepection without locating. Default is
true
.
-
NonLinLoc.profiles
¶ Type: list:string
Defines a list of active profiles to be used by the plugin.
Note
NonLinLoc.profile.$name.*
Defines a regional profile that is used if a prelocation falls
inside the configured region.
$name is a placeholder for the name to be used and needs to be added to NonLinLoc.profiles
to become active.
NonLinLoc.profiles = a,b
NonLinLoc.profile.a.value1 = ...
NonLinLoc.profile.b.value1 = ...
# c is not active because it has not been added
# to the list of NonLinLoc.profiles
NonLinLoc.profile.c.value1 = ...
-
NonLinLoc.profile.$name.earthModelID
¶ Type: string
earthModelID that is stored in the created origin.
-
NonLinLoc.profile.$name.methodID
¶ Type: string
methodID that is stored in the created origin. Default is
NonLinLoc
.
-
NonLinLoc.profile.$name.tablePath
¶ Type: path
Path to travel time tables (grids).
-
NonLinLoc.profile.$name.controlFile
¶ Type: path
Control file of the current profile. If not set, the default control file will be used instead.
-
NonLinLoc.profile.$name.transform
¶ Type: string
Transformation type of the configured region. If not set, GLOBAL is assumed.
-
NonLinLoc.profile.$name.region
¶ Type: list:double
Defines the region values. If transform is GLOBAL 4 values (min_lat, min_lon, max_lat, max_lon) are expected. If transform is SIMPLE then 4 values are expected (xmin, ymin, xmax, ymax).
-
NonLinLoc.profile.$name.origin
¶ Type: list:double
Only used for transformation SIMPLE. Expects 2 values (lat,lon).
-
NonLinLoc.profile.$name.rotation
¶ Type: double
Unit: deg
Only used for transformation SIMPLE. Defines the rotation around the origin of the defined region.
Bindings¶
Configuration¶
-
MLr.params
¶ Type: string
Defines Stations Corrections parameters for MLr (GNS/Geonet Local magnitude). Format: “UpToKilometers A ; UpToNextKilometers A ;”. Example: “30 nomag; 60 0.018 ; 700 0.0038 “. The first parameter set “30 nomag” means that up to 30km from the sensor the magnitude should not be calculated. A is used as station correction. “nomag” is used to disable station magnitudes.
Note: No MLr computation if params is empty.
Note
fx.DFX.* Three component feature extraction algorithm ported from the automatic processing system implemented at CTBTO/IDC. The documentation of the methods is not publically available. In case of questions and comments, please contact support@ctbto.org.
Note
fx.DFX.filter.* Butterworth filter options of the bandpass.
-
fx.DFX.filter.order
¶ Type: int
The order of the filter. Default is
3
.
-
fx.DFX.filter.loFreq
¶ Type: double
Unit: Hz
The lower cut-off frequency. A negative value or zero will disable a lower cut-off frequency. Default is
1
.
-
fx.DFX.filter.hiFreq
¶ Type: double
Unit: Hz
The upper cut-off frequency. A negative value or zero will disable a upper cut-off frequency. Default is
3
.
-
fx.DFX.polar.window
¶ Type: double
Unit: s
Length of the covariance window in seconds. Default is
1.5
.
-
fx.DFX.polar.overlap
¶ Type: double
The fraction of the covariance window to overlap. Default is
0.5
.
-
fx.DFX.polar.alpha
¶ Type: double
A station-dependent parameter used to compute a polarization slowness estimate. Default is
0.3
.
-
fx.DFX.polar.ds
¶ Type: double
A station-dependent parameter used to compute the back azimuth and slowness errors. Default is
0.03
.
-
fx.DFX.polar.dk
¶ Type: double
A station-dependent parameter used to compute the back azimuth and slowness errors. Default is
0.1
.
-
MLv.logA0
¶ Type: string
Defines the calibration function log(A0) for computing MLv. Format: any number of distance-value pairs separated by semicolons Example: “0 -1.3;60 -2.8;400 -4.5;1000 -5.85” specifies 3 distance intervals from 0…60, 60…400 and 400…1000 km distance. Within these intervals logA0 is interpolated linearly between -1.3…-2.8, -2.8…-4.5 and -4.5…-5.8, respectively
Note: The distances of the first and last sample specify the distance range within which MLv shall be computed. Default is
0 -1.3;60 -2.8;400 -4.5;1000 -5.85
.
-
MLv.maxDistanceKm
¶ Type: double
Unit: km
Maximum epicentral distance for computing MLv. No distance limitation for maxDistanceKm=-1 Default is
-1.0
.
-
ML.logA0
¶ Type: string
Defines the calibration function log(A0) for computing ML. Format: any number of distance-value pairs separated by semicolons Example: “0 -1.3;60 -2.8;400 -4.5;1000 -5.85” specifies 3 distance intervals from 0…60, 60…400 and 400…1000 km distance. Within these intervals logA0 is interpolated linearly between -1.3…-2.8, -2.8…-4.5 and -4.5…-5.8, respectively
Note: The distances of the first and last sample specify the distance range within which ML shall be computed. Default is
0 -1.3;60 -2.8;400 -4.5;1000 -5.85
.
-
ML.maxDistanceKm
¶ Type: double
Unit: km
Maximum epicentral distance for computing MLv. No distance limitation for maxDistanceKm=-1 Default is
-1.0
.
-
Ms_20.lowerPeriod
¶ Type: double
Unit: s
Lower period limit of the signal for computing Ms_20. Default is
18
.
-
Ms_20.upperPeriod
¶ Type: double
Unit: s
Upper period limit of the signal for computing Ms_20. Default is
22
.
-
Ms_20.minimumDistance
¶ Type: double
Unit: deg
Minimum epicentral distance for computing Ms_20. Default is
2
.
-
Ms_20.maximumDistance
¶ Type: double
Unit: deg
Maximum epicentral distance for computing Ms_20. Default is
160
.
-
Ms_20.maximumDepth
¶ Type: double
Unit: km
Maximum depth for computing Ms_20. Default is
100
.
-
magnitudes.ML(IDC).A
¶ Type: path
Location of the station specific attenuation table. If not specified then @DATADIR@/magnitudes/IDC/global.ml will be used as fallback. {net}, {sta} and {loc} are placeholders which will be replaced with the concrete network code, station code and location code.
-
magnitudes.mb(IDC).Q
¶ Type: path
Location of the station specific Q table. If not specified then @DATADIR@/magnitudes/IDC/qfvc.ml will be used as fallback. {net}, {sta} and {loc} are placeholders which will be replaced with the concrete network code, station code and location code.
-
detecStream
¶ Type: string
Defines the channel code of the preferred stream used by e.g. scautopick and scrttv. If no component code is given, the vertical component will be fetched from inventory. For that the channel orientation (azimuth, dip) will be used. If that approach fails, ‘Z’ will be appended and used as fallback.
-
detecLocid
¶ Type: string
Defines the location code of the preferred stream used eg by scautopick and scrttv.
Note
amplitudes.* Defines general parameters for amplitude of a certain type, e.g. time windows to derive magnitudes.
-
amplitudes.saturationThreshold
¶ Type: string
Unit: counts; %
Defines the saturation threshold for the optional saturation check. By default the saturation check is disabled but giving a value above 0 will enable it. Waveforms that are saturated are not used for amplitude calculations.
This value can either be an absolute value of counts such as “100000” counts or a relative value (optionally in percent) with respect to the number of effective bits, e.g. “0.8@23” or “80%@23”. The first version uses 1**23 * 0.8 whereas the latter uses 1**23 * 80/100.
The boolean value “false” explicitly disables the check. Default is
false
.
-
amplitudes.enable
¶ Type: boolean
Defines if amplitude calculation is enabled. If disabled then this station will be skipped for amplitudes and magnitudes. Default is
true
.
-
amplitudes.enableResponses
¶ Type: boolean
Activates deconvolution for this station. If no responses are configured an error is raised and the data is not processed. Default is
false
.
Note
amplitudes.$name.* An amplitude profile configures global parameters for a particular amplitude type. The available amplitude types are not fixed and can be extended by plugins. The name of the type must match the one defined in the corresponding AmplitudeProcessor. $name is a placeholder for the name to be used.
-
amplitudes.$name.saturationThreshold
¶ Type: string
Unit: counts; %
Defines the saturation threshold for the optional saturation check. By default the saturation check is disabled but giving a value above 0 will enable it. Waveforms that are saturated are not used for amplitude calculations.
This value can either be an absolute value of counts such as “100000” counts or a relative value (optionally in percent) with respect to the number of effective bits, e.g. “0.8@23” or “80%@23”. The first version uses 1**23 * 0.8 whereas the latter uses 1**23 * 80/100.
The boolean value “false” explicitly disables the check. Default is
false
.
-
amplitudes.$name.enable
¶ Type: boolean
Defines if amplitude calculation of certain type is enabled. Default is
true
.
-
amplitudes.$name.enableResponses
¶ Type: boolean
Activates deconvolution for this amplitude type. If not set the global flag “amplitudes.enableResponses” will be used instead. Default is
false
.
-
amplitudes.$name.minSNR
¶ Type: double
Defines the mininum SNR to be reached to compute the amplitudes. This value is amplitude type specific and has no global default value.
-
amplitudes.$name.noiseBegin
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the noise window used to compute the noise offset and noise amplitude. Each amplitude processor sets its own noise time window and this option should only be changed if you know what you are doing.
-
amplitudes.$name.noiseEnd
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the end of the noise window used to compute the noise offset and noise amplitude. Each amplitude processor sets its own noise time window and this option should only be changed if you know what you are doing.
-
amplitudes.$name.signalBegin
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the signal window used to compute the final amplitude. Each amplitude processor sets its own signal time window and this option should only be changed if you know what you are doing.
-
amplitudes.$name.signalEnd
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the end of the signal window used to compute the final amplitude. Each amplitude processor sets its own signal time window and this option should only be changed if you know what you are doing.
-
amplitudes.$name.minDist
¶ Type: double
Unit: deg
The minimum distance required to compute an amplitude. This settings has no effect with e.g. scautopick as there is no information about the source of the event to compute the distance. The default value is implementation specific.
-
amplitudes.$name.maxDist
¶ Type: double
Unit: deg
The maximum distance allowed to compute an amplitude. This settings has no effect with e.g. scautopick as there is no information about the source of the event to compute the distance. The default value is implementation specific.
-
amplitudes.$name.minDepth
¶ Type: double
Unit: km
The minimum depth required to compute an amplitude. This settings has no effect with e.g. scautopick as there is no information about the source of the event to retrieve the depth. The default value is implementation specific.
-
amplitudes.$name.maxDepth
¶ Type: double
Unit: km
The maximum depth allowed to compute an amplitude. This settings has no effect with e.g. scautopick as there is no information about the source of the event to retrieve the depth. The default value is implementation specific.
Note
amplitudes.$name.resp.* Several parameters if usage of full responses is enabled.
-
amplitudes.$name.resp.minFreq
¶ Unit: Hz
After data are converted in to the frequency domain that minimum frequency defines the end of the left-side cosine taper for the frequency spectrum. The taper applies from 0Hz to {minFreq}Hz. A value of 0 or lower disables that taper. Default is
0.00833333
.
-
amplitudes.$name.resp.maxFreq
¶ Unit: Hz
After data are converted in to the frequency domain that maximum frequency defines the start of the right-side cosine taper for the frequency spectrum. The taper applies from {maxFreq}Hz to {fNyquist}Hz. A value of 0 or lower disables that taper. Default is
0
.
Note
amplitudes.WoodAnderson.* Allows to configure the Wood-Anderson seismometer response. The default values are according to the version of Gutenberg (1935). The newer version by Uhrhammer and Collins (1990) is part of the IASPEI Magnitude Working Group recommendations of 2011 September 9. This version uses gain=2800, T0=0.8, h=0.8.
-
amplitudes.WoodAnderson.gain
¶ Type: double
The gain of the Wood-Anderson response. Default is
2800
.
-
amplitudes.WoodAnderson.T0
¶ Type: double
Unit: s
The eigen period of the Wood-Anderson seismometer. Default is
0.8
.
-
amplitudes.WoodAnderson.h
¶ Type: double
The damping constant of the Wood-Anderson seismometer. Default is
0.8
.
-
amplitudes.ML.absMax
¶ Type: boolean
Whether to use the absolute maximum of the filtered WA trace or the difference of the maximum and minimum value of the signal window. Default is
true
.
-
amplitudes.ML.measureType
¶ Type: string
This parameter allows to set how the amplitude is measured. Either by finding the absolute maximum of the demeaned trace (AbsMax), the difference of maximum and minimum of the signal window (MinMax) or the maximum peak-trough of one cycle (PeakTrough).
Note that if absMax is already explicitly configured, this parameter has no effect. Default is
AbsMax
.
-
amplitudes.ML.combiner
¶ Type: string
Defines the combiner operation for the amplitudes measured on either both horizontal component. The default is to use the average. Allowed values are: “average”, “min”, “max” and “geometric_mean”. “geometric_mean” corresponds to averaging single-trace magnitudes instead of their amplitudes. Default is
average
.
-
amplitudes.MLv.absMax
¶ Type: boolean
Whether to use the absolute maximum of the filtered WA trace or the difference of the maximum and minimum value of the signal window. Default is
true
.
-
amplitudes.MLv.measureType
¶ Type: string
This parameter allows to set how the amplitude is measured. Either by finding the absolute maximum of the demeaned trace (AbsMax), the difference of maximum and minimum of the signal window (MinMax) or the maximum peak-trough of one cycle (PeakTrough).
Note that if absMax is already explicitly configured, this parameter has no effect. Default is
AbsMax
.
Note
mag.* Defines correction parameters for magnitudes, e.g. station corrections.
Note
mag.$name.* A magnitude profile configures global parameters for a particular magnitude type. The available magnitude types are not fixed and can be extended by plugins. The name of the type must match the one defined in the corresponding MagnitudeProcessor. $name is a placeholder for the name to be used.
-
mag.$name.multiplier
¶ Type: double
Part of the magnitude station correction. The final magnitude value is multiplier*M+offset. This value is usually not required but is here for completeness. Default is
1
.
-
mag.$name.offset
¶ Type: double
Part of the magnitude station correction. The final magnitude value is multiplier*M+offset. This value can be used to correct station magnitudes. Default is
0
.
Note
picker.BK.* Bkpicker is an implementation of the Baer/Kradolfer picker adapted to SeisComP3. It was created by converting Manfred Baers from Fortran to C++ and inserting it as a replacement for the picker algorithm. The picker interface name to be used in configuration files is “BK”.
-
picker.BK.noiseBegin
¶ Type: double
Unit: s
Overrides the relative data acquisition time (relative to the triggering pick). This adds a margin to the actual processing and is useful to initialize the filter (e.g. bandpass). The data is not used at all until signalBegin is reached. The data time window start is the minimum of noiseBegin and signalBegin. Default is
0
.
-
picker.BK.signalBegin
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the signal window used to pick. Default is
-20
.
-
picker.BK.signalEnd
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the signal window used to pick. Default is
80
.
-
picker.BK.filterType
¶ Type: string
BP (Bandpass) is currently the only option. Default is
BP
.
-
picker.BK.filterPoles
¶ Type: int
Number of poles. Default is
2
.
-
picker.BK.f1
¶ Type: double
Unit: Hz
Bandpass lower cutoff freq. in Hz. Default is
5
.
-
picker.BK.f2
¶ Type: double
Unit: Hz
Bandpass upper cutoff freq. in Hz. Default is
20
.
-
picker.BK.thrshl1
¶ Type: double
Threshold to trigger for pick (c.f. paper), default 10 Default is
10
.
-
picker.BK.thrshl2
¶ Type: double
Threshold for updating sigma (c.f. paper), default 20 Default is
20
.
Note
picker.AIC.* AIC picker is an implementation using the simple non-AR algorithm of Maeda (1985), see paper of Zhang et al. (2003) in BSSA. The picker interface name to be used in configuration files is “AIC”.
-
picker.AIC.noiseBegin
¶ Type: double
Unit: s
Overrides the relative data acquisition time (relative to the triggering pick). This adds a margin to the actual processing and is useful to initialize the filter (e.g. bandpass). The data is not used at all until signalBegin is reached. The data time window start is the minimum of noiseBegin and signalBegin. Default is
0
.
-
picker.AIC.signalBegin
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the signal window used to pick. Default is
-30
.
-
picker.AIC.signalEnd
¶ Type: double
Unit: s
Overrides the default time (relative to the trigger time) of the begin of the signal window used to pick. Default is
10
.
-
picker.AIC.filter
¶ Type: string
Overrides the default filter which is “raw”. The typical filter grammar can be used.
-
picker.AIC.minSNR
¶ Type: double
Defines the mininum SNR. Default is
3
.
Note
spicker.L2.* L2 is an algorithm to pick S-phases based on existing P-phases. The picker interface name to be used in configuration files is “S-L2”.
-
spicker.L2.noiseBegin
¶ Type: double
Unit: s
Overrides the relative data processing start time (relative to the triggering pick). This adds a margin to the actual processing and is useful to initialize the filter (e.g. bandpass). The data is not used at all until signalBegin is reached. The data time window start is the minimum of noiseBegin and signalBegin. Default is
-10
.
-
spicker.L2.signalBegin
¶ Type: double
Unit: s
Overrides the relative start time (relative to the triggering pick) of the begin of the signal processing. Default is
0
.
-
spicker.L2.signalEnd
¶ Type: double
Unit: s
Overrides the relative end time (relative to the triggering pick) of the end of the signal window used to pick. Default is
60
.
-
spicker.L2.filter
¶ Type: string
Configures the filter used to compute the L2 and to pick the onset (with AIC) after the detector triggered. Default is
BW(4,0.3,1.0)
.
-
spicker.L2.detecFilter
¶ Type: string
Configures the detector in the filtered L2. This filter is applied on top of the base L2 filter. Default is
STALTA(1,10)
.
-
spicker.L2.threshold
¶ Type: double
The detector threshold that triggers the AIC picker. Default is
3
.
-
spicker.L2.timeCorr
¶ Type: double
Unit: s
The time correction (in seconds) added to the detection time before AIC time window is computed. Default is
0
.
-
spicker.L2.marginAIC
¶ Type: double
Unit: s
The AIC time window around the detection used to pick. If 0 AIC is not used. Default is
5
.
-
spicker.L2.minSNR
¶ Type: double
Defines the mininum SNR as returned from AIC. Default is
15
.
-
amplitudes.MN.rms
¶ Type: boolean
Whether to use RMS ratio of signal and noise window for SNR computation or the ration of the peak-trough amplitudes of either window. Default is
false
.
-
amplitudes.MN.filter
¶ Type: string
The configurable filter such that the V measurement is made on a filtered trace. By default, filtering is not enabled.
See https://docs.gempa.de/seiscomp3/current/base/filter-grammar.html for how to specify the filter.
-
amplitudes.MN.Vmin
¶ Type: double
Unit: km/s
The minimum phase velocity used to determine the signal window end. Default is
3.2
.
-
amplitudes.MN.Vmax
¶ Type: double
Unit: km/s
The maximum phase velocity used to determine the signal window start. Default is
3.6
.
-
amplitudes.MN.snrWindowSeconds
¶ Type: double
Unit: s
The length of the SNR window. Default is
10
.
-
amplitudes.MN.noiseWindowPreSeconds
¶ Type: double
Unit: s
The offset of the noise window. A positive value will move the computed noise window to the left on the time axis, a negative value will move it to the right on the time axis. Default is
0
.
-
amplitudes.MN.signalStartPriorities
¶ Type: list:string
The priority list of phase onsets to compute the signal start window. Except for Vmin and Vmax, associated phases (arrivals) must be present in the origin for this particular phase. Picked phases are only considered if the origin is a manual origin or the pick is a manual pick. The first value in the list which can be retrieved or computed, is selected.
Allowed tokens: Pg, Pn, P, Sg, Sn, S, Lg, Rg, Vmin, Vmax Default is
Lg,Sg,Sn,S,Vmax
.
-
amplitudes.MN.signalEndPriorities
¶ Type: list:string
The priority list of phase onsets to compute the signal end window. Except for Vmin and Vmax, associated phases (arrivals) must be present in the origin for this particular phase. Picked phases are only considered if the origin is a manual origin or the pick is a manual pick. The first value in the list which can be retrieved or computed, is selected.
Allowed tokens: Pg, Pn, P, Sg, Sn, S, Lg, Rg, Vmin, Vmax Default is
Rg,Vmin
.
-
magnitudes.MN.minSNR
¶ Type: double
The minimum SNR required for a magnitude to pass the QC check. The station magnitude will be computed anyway but if the SNR is below this threshold it will be associated with weight zero and will not contribute to the network magnitude. Default is
2
.
-
magnitudes.MN.minPeriod
¶ Type: double
Unit: s
The minimum period required for a magnitude to pass the QC check. The station magnitude will be computed anyway but if the period is below this threshold it will be associated with weight zero and will not contribute to the network magnitude. Default is
0.01
.
-
magnitudes.MN.maxPeriod
¶ Type: double
Unit: s
The maximum period allowed for a magnitude to pass the QC check. The station magnitude will be computed anyway but if the period is above this threshold it will be associated with weight zero and will not contribute to the network magnitude. Default is
1.3
.
-
magnitudes.MN.minDist
¶ Type: double
Unit: deg
The minimum distance required for a magnitude to pass the QC check. The station magnitude will be computed anyway but if the distance is below this threshold it will be associated with weight zero and will not contribute to the network magnitude. Default is
0.5
.
-
magnitudes.MN.maxDist
¶ Type: double
Unit: deg
The maximum distance allowed for a magnitude to be computed. If the distance exceeds this threshold then the computation will be canceled and no station magnitude will be available at all. Default is
30
.
-
md.seismo
¶ Type: int
Default filter type to use before processing and after deconvolution. It’s possible to set : 1 for a Wood-Anderson seismometer 2 for a 5sec generic Seismometer 3 for a WWSSN LP seismometer 4 for a WSSN SP seismometer 5 for a Generic Seismometer 6 for a Butterworth Low pass filter 7 for a Butterworth High pass filter 8 for a Butterworth Band pass filter 9 for a 1Hz eigen-frequency L4C seismometer Default is
9
.
-
md.taper
¶ Type: double
Unit: s
taper applied to the signal Default is
5
.
-
md.signal_length
¶ Type: double
Unit: s
signal length used to compute the duration magnitude Default is
150
.
-
md.butterworth
¶ Type: string
Butterworth filter parameter applied to the signal Default is
"3,1.5"
.
-
md.depthmax
¶ Type: double
Unit: km
Maximum depth at which duration magnitude is valid Default is
200
.
-
md.deltamax
¶ Type: double
Unit: km
Maximum distance between earthquake and station at which duration magnitude is valid Default is
400
.
-
md.snrmin
¶ Type: double
Signal to noise ratio below which the coda is reached Default is
1.2
.
-
md.mdmax
¶ Type: double
Maximum expected duration magnitude value This is used to find how much data should be loaded for a given station by reversing the formula Default is
5.0
.
-
md.fma
¶ Type: double
FMA regional coefficient See Hypo2000 manual Default is
-0.87
.
-
md.fmb
¶ Type: double
FMB regional coefficient See Hypo2000 manual Default is
2.0
.
-
md.fmd
¶ Type: double
FMD regional coefficient See Hypo2000 manual Default is
0.0035
.
-
md.fmf
¶ Type: double
FMF regional coefficient See Hypo2000 manual Default is
0.0
.
-
md.fmz
¶ Type: double
FMZ regional coefficient See Hypo2000 manual Default is
0.0
.
-
MLh.maxavg
¶ Type: string
Define combiner operation for both horizontals (min, max, avg). Default is
max
.
-
MLh.ClippingThreshold
¶ Type: double
MLh clipping level, in raw counts, eg. 80% of 2^23 = 6710886.
-
MLh.params
¶ Type: string
Defines attenuation parameters for MLh. Format: “UpToKilometers A B; UpToNextKilometers A B;”. Example: “30 nomag; 60 0.018 2.17; 700 0.0038 3.02”. The first parameter set “30 nomag” means that up to 30km from the sensor the magnitude should not be calculated.
Note: No MLh computation if params is empty.
Command-line¶
Generic¶
-
-h
,
--help
¶
show help message.
-
-V
,
--version
¶
show version information
-
--config-file
arg
¶ Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick -> scautopick2.
-
--plugins
arg
¶ Load given plugins.
-
-D
,
--daemon
¶
Run as daemon. This means the application will fork itself and doesn’t need to be started with &.
-
--auto-shutdown
arg
¶ Enable/disable self-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message (enabled with –start-stop-msg for the master module).
-
--shutdown-master-module
arg
¶ Sets the name of the master-module used for auto-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application.
-
--shutdown-master-username
arg
¶ Sets the name of the master-username of the messaging used for auto-shutdown. If “shutdown-master-module” is given as well this parameter is ignored.
Verbose¶
-
--verbosity
arg
¶ Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
-
-v
,
--v
¶
Increase verbosity level (may be repeated, eg. -vv)
-
-q
,
--quiet
¶
Quiet mode: no logging output
-
--print-component
arg
¶ For each log entry print the component right after the log level. By default the component output is enabled for file output but disabled for console output.
-
--print-context
arg
¶ For each log entry print the source file name and line number.
-
--component
arg
¶ Limits the logging to a certain component. This option can be given more than once.
-
-s
,
--syslog
¶
Use syslog logging back end. The output usually goes to /var/lib/messages.
-
-l
,
--lockfile
arg
¶ Path to lock file.
-
--console
arg
¶ Send log output to stdout.
-
--debug
¶
Debug mode: –verbosity=4 –console=1
-
--trace
¶
Trace mode: –verbosity=4 –console=1 –print-component=1 –print-context=1
-
--log-file
arg
¶ Use alternative log file.
Messaging¶
-
-u
,
--user
arg
¶ Overrides configuration parameter
connection.username
.
-
-H
,
--host
arg
¶ Overrides configuration parameter
connection.server
.
-
-t
,
--timeout
arg
¶ Overrides configuration parameter
connection.timeout
.
-
-g
,
--primary-group
arg
¶ Overrides configuration parameter
connection.primaryGroup
.
-
-S
,
--subscribe-group
arg
¶ A group to subscribe to. This option can be given more than once.
-
--encoding
arg
¶ Overrides configuration parameter
connection.encoding
.
-
--start-stop-msg
arg
¶ Sets sending of a start- and a stop message.
Database¶
-
--db-driver-list
¶
List all supported database drivers.
-
-d
,
--database
arg
¶ The database connection string, format: service://user:pwd@host/database. “service” is the name of the database driver which can be queried with “–db-driver-list”.
-
--config-module
arg
¶ The configmodule to use.
-
--inventory-db
arg
¶ Load the inventory from the given database or file, format: [service://]location
-
--config-db
arg
¶ Load the configuration from the given database or file, format: [service://]location
Records¶
-
--record-driver-list
¶
List all supported record stream drivers
-
-I
,
--record-url
arg
¶ The recordstream source URL, format: [service://]location[#type]. “service” is the name of the recordstream driver which can be queried with “–record-driver-list”. If “service” is not given “file://” is used.
-
--record-file
arg
¶ Specify a file as record source.
-
--record-type
arg
¶ Specify a type for the records being read.