autosigma¶
Strong event parameter processing
Description¶
AUTOSIGMA is an automatic module to compute and visualize ground motion parameters based on SeisComP events. The computed parameters are stored as incidents in the SIGMA database.
Configuration¶
etc/defaults/global.cfg
etc/defaults/autosigma.cfg
etc/global.cfg
etc/autosigma.cfg
~/.seiscomp/global.cfg
~/.seiscomp/autosigma.cfg
autosigma inherits global options.
Note
Modules/plugins may require a license file. The default path to license
files is @DATADIR@/licenses/
which can be overridden by global
configuration of the parameter gempa.licensePath
. Example:
gempa.licensePath = @CONFIGDIR@/licenses
-
magnitudeFilterTable
¶ Type: list:string
Magnitude-dependent filter table. The format is “mag1:fmin1;fmax1, mag2:fmin2;fmax2, mag3:fmin3;fmax3”. If a magnitude falls between two configured magnitudes, the filter of the lower magnitude is used. No interpolation takes place. Magnitude outside the configured range are clipped to the lowest/highest value. Frequency values are given as simple positive doubles (Hz is assumed) or with suffix “fNyquist” which is then multiplied by the Nyquist frequency of the data to get the final corner frequency.
The final frequency values are used as a replacement for the profile filter.loFreq and filter.hiFreq parameters unless the table is empty.
-
profiles
¶ Type: list:string
A list of profiles defining event and region criteria with processing. Provide at least one profile.
Note
cron.* Timing parameters controlling the automatic event processing.
-
cron.wakeupInterval
¶ Type: int
Unit: s
Time interval to test for new events. Default is
10
.
-
cron.eventKeep
¶ Type: int
Unit: s
The time interval to keep events in the buffer. During this interval events are available for processing. Default is
3600
.
-
cron.delayTimes
¶ Type: list:int
Unit: s
List of time intervals to delay the processing of new events. The delayTimes are added to the originTime. delayTimes > 0 s allow to load complete waveforms within the requested time windows. Provide a comma-separated list to repeat the data processing of new events allowing for more complete data from stations with longer data delay or larger epicentral distances.
-
cron.updateDelay
¶ Type: int
Unit: s
Time delay to test for event updates of already loaded events. Default is
60
.
Note
acquisition.* Control parameters for waveform data acquisition.
-
acquisition.maximumEpicentralDistance
¶ Type: double
Unit: km
Maximum epicentral distance for considering stations. Default is
400
.
-
acquisition.magnitudeDistanceTable
¶ Type: list:string
Magnitude dependent maximum epicentral distance table. The format is
mag1:km1, mag2:km2, mag3:km
The distance value is given in km. If a magnitude falls between two configured magnitudes, the distance of the lower magnitude is used then. No interpolation is performed. Magnitude outside the configured range are clipped to the lowest/highest value.
The final value is used as a replacement for acquisition.maximumEpicentralDistance unless the table is empty. Example: 3:400, 4:450, 5:500
-
acquisition.initialTimeout
¶ Type: int
Unit: s
Default is
30
.
-
acquisition.runningTimeout
¶ Type: int
Unit: s
Default is
2
.
-
acquisition.streams.whitelist
¶ Type: list:string
A list of streams considered for processing. If set, no other streams will be used.
-
acquisition.streams.blacklist
¶ Type: list:string
A list of streams excluded from processing. The listed streams will be ignored.
Note
gmpe.* Vs30 grid and definition of external GMPEs.
-
gmpe.vs30grid
¶ Type: path
The path to a Vs30 GeoTIFF or grid file, e.g. the global_vs30.tif GeoTIFF file provided by USGS. Grid files must be in a modified Surfer6 format where dimX and dimY are integers rather than shorts. The magic first 4 bytes contain “GGBB”. The GeoTIFF reader is activated if the file extension is “.tif”.
Note
gmpe.py.* Adds configuration for processing based on Python2 GMPE models. Refer to as “py2gmpe” for the provider configured in profile.$name.
-
gmpe.py.models
¶ Type: list:string
The PyGMPE models available and their corresponding python filename. The format of each list entry is “modelname;filename”. If the semicolon is omitted then the item is expected to be the modelname and a file with the same name and extension .py will be searched for.
-
gmpe.py.basePath
¶ Type: path
The base path for all python model implementations. Default is
@CONFIGDIR@/pygmpe/
.
Note
gmpe.py3.* Adds configuration for processing based on Python3 GMPE models. Refer to as “py3gmpe” for the provider configured in profile.$name.
-
gmpe.py3.models
¶ Type: list:string
The Py3GMPE models available and their corresponding python filename. The format of each list entry is “modelname;filename”. If the semicolon is omitted then the item is expected to be the modelname and a file with the same name and extension .py will be searched for.
-
gmpe.py3.basePath
¶ Type: path
The base path for all python model implementations. Default is
@CONFIGDIR@/pygmpe/
.
Note
output.* Parameters controlling the output of processing products.
-
output.database
¶ Type: string
Configures the URI of the output database containing the SIGMA tables. If nothing is configured, the SeisComP database will be used.
-
output.exportPath
¶ Type: path
The path where all result files are saved. Default is
@LOGDIR@/autosigma
.
-
output.exportScript
¶ Type: path
The script that will be called when an incident is exported. Please ensure that the script is executable. 3 parameters are passed: The eventID, an internal eventID and the export path where all files are stored.
Provided example script: @DATADIR@/sigma/scripts/export-autosigma.sh
-
output.exportTimeout
¶ Type: int
Unit: s
Timeout in seconds for the export script before it will be killed. Default is
60
.
-
output.logfile
¶ Type: path
Name of the logfile containing the processing logs.
-
output.mmi
¶ Type: boolean
Export MMI grids and images. Default is
true
.
-
output.pga
¶ Type: boolean
Export PGA grids and images. Default is
true
.
-
output.pgv
¶ Type: boolean
Export PGV grids and images. Default is
false
.
Note
profile.* Profiles for customized regions and event criteria with specific GMPEs and processing. Internally defined models (“EEWD/CEA2014” and “EEWD/BEA2014”) and external GMPEs, e.g. “py3gmpe/AbrahamsonEtAl2014” can be used. External GMPEs are defined in the gmpe section of the configuration.
Note
profile.$name.*
GMPE, event, image and grid parameters (mandatory).
$name is a placeholder for the name to be used and needs to be added to profiles
to become active.
profiles = a,b
profile.a.value1 = ...
profile.b.value1 = ...
# c is not active because it has not been added
# to the list of profiles
profile.c.value1 = ...
-
profile.$name.gmpe
¶ Type: string
Defines the GMPE model to be used. The format is <provider>/<model>, analogue to SIGMA,e.g. “EEWD/CEA2014” or “py3gmpe/AbrahamsonEtAl2014”.
-
profile.$name.region
¶ Type: string
The region name of a configured region (e.g. with BNA files in @DATADIR@/bna or ~/.seiscomp/bna) for which the processing parameters are valid. Considered events must lie within the region.
-
profile.$name.rect
¶ Type: list:double
Configures an alternative region filter with a rectangle. The 4 expected values are latMin, lonMin, latMax, lonMax. The region parameter takes priority over the rect parameter.
-
profile.$name.minimumMagnitude
¶ Type: double
Defines the minimum magnitude that must be reached to start processing. By default this check is disabled.
-
profile.$name.deltaMagnitude
¶ Type: double
Trigger re-processing when changes in event magnitude exceed deltaMagnitude. Default is
0.5
.
-
profile.$name.deltaLocation
¶ Type: double
Unit: km
Trigger re-processing when changes in hypocenter location exceed deltaLocation. Default is
10
.
Note
profile.$name.capture.* Parameters controlling the image capturing.
-
profile.$name.capture.region
¶ Type: string
Unit: degrees
Defines the region rectangle of the plotted map.
Formats:
+lat0+lon0+lat1+lon1 : region rectangle by minimum and maximum latitude and longitude.
[lat_dim]x[lon_dim]+lat0+lon0 : dimension + origin coordinate.
-
profile.$name.capture.dim.x
¶ Type: int
Unit: px
Defines the X resolution of the output map images in pixels. Default is
512
.
-
profile.$name.capture.dim.y
¶ Type: int
Unit: px
Defines the Y resolution of the output map images in pixels. Default is
512
.
Note
profile.$name.grid.* Parameters controlling the generation of grids for plotting on maps.
-
profile.$name.grid.extent.lat
¶ Type: double
Unit: deg
Defines the latitudinal extent of the processing grid for GMPEs. Default is
5
.
-
profile.$name.grid.extent.lon
¶ Type: double
Unit: deg
Defines the longitudinal extent of the processing grid for GMPEs. Default is
5
.
-
profile.$name.grid.dim.x
¶ Type: int
Unit: cnt
Defines the X (longitude) resolution of the processing grid. Default is
512
.
-
profile.$name.grid.dim.y
¶ Type: int
Unit: cnt
Defines the Y (latitude) resolution of the processing grid. Default is
512
.
Note
profile.$name.processing.* Processing parameters.
-
profile.$name.processing.targetDistricts
¶ Type: list:string
A list of Shapefile paths used as target districts for GMPE/intensity computation used for GeoJSON export.
-
profile.$name.processing.preEventWindowLength
¶ Type: int
Unit: s
The pre event time window length in seconds. Default is
60
.
-
profile.$name.processing.postEventWindowLength
¶ Type: string
Unit: s
Default value of time window length after the event onset in seconds. This value is an numerical expression and can include four symbols: d (distance in km), D (distance in degree), az (azimuth clockwise from North) and M (magnitude value). Default is
(0.36*d)+60
.
-
profile.$name.processing.eventCutOff
¶ Type: boolean
Enables/disables pre event cut-off. A hardcoded sta/lta algorithm (with sta=0.1s, lta=2s, sta/lta threshold=1.2) is run on the time window defined by (expected_P_arrival_time - 15 s). The pre event window is hence defined as [t(sta/lta =1.2) - 15.5s, t(sta/lta =1.2) - 0.5s]. Default is
true
.
-
profile.$name.processing.afterShockRemoval
¶ Type: boolean
Enables/disables aftershock removal (Figini, 2006; Paolucci et al., 2008) Default is
true
.
-
profile.$name.processing.durationScale
¶ Type: double
Defines the factor applied to the signigicant duration to define the processing spetra time window. If that value is <= 0, the totalTimeWindowLength is used. Default is
1.5
.
-
profile.$name.processing.STAlength
¶ Type: double
Unit: s
The STA length in seconds of the applied STA/LTA check. Default is
1
.
-
profile.$name.processing.LTAlength
¶ Type: double
Unit: s
The LTA length in seconds of the applied STA/LTA check. Default is
60
.
-
profile.$name.processing.STALTAratio
¶ Type: double
The minimum STALTA ratio to be reached to further process a station. Default is
3
.
-
profile.$name.processing.STALTAmargin
¶ Type: double
Unit: s
The number of seconds around P to be used to check the STA/LTA ratio. Default is
5
.
Note
profile.$name.processing.filter.* Parameters of the 1st stage filter.
-
profile.$name.processing.filter.order
¶ Type: int
The order of the 1st stage filter. Default is
4
.
-
profile.$name.processing.filter.loFreq
¶ Type: double
Unit: Hz
Specifies the frequency of the 1st stage hi-pass filter. If this parameter is equal to 0 the hi-pass filter is not used. If negative, then the absolute value is multiplied by the Nyquist frequency of the data to get the final corner frequency of the filter. Default is
0.025
.
-
profile.$name.processing.filter.hiFreq
¶ Type: double
Unit: Hz
Specifies the frequency of the 1st stage lo-pass filter. If this parameter is equal to 0 the lo-pass filter is not used. If negative, then the absolute value is multiplied by the Nyquist frequency of the data to get the final corner frequency of the filter. Default is
40
.
Note
profile.$name.processing.spectra.* Parameters controlling the calculation of Fourier spectra.
-
profile.$name.processing.spectra.taperLength
¶ Type: double
Unit: s
Defines the cosine taper length in seconds if non-causal filters are activated applied on either side of the waveform. If a negative length is given 10 percent of the pre event window length is used on either side of the waveform. Default is
-1
.
-
profile.$name.processing.spectra.padLength
¶ Type: double
Unit: s
The length of the zero padding window in seconds applied on either side of the waveform. If negative, it is computed following Boore (2005) as 1.5*order/corner_freq and applied half at the beginning and half at the end of the waveform. Default is
-1
.
Note
profile.$name.processing.prs.* Parameters controlling the calculation of Pseudo Response Spectra.
-
profile.$name.processing.prs.damping
¶ Type: double
Unit: %
The damping value (in percent) for computation of the pseudo absolute acceleration elastic response spectrum. Default is
5
.
-
profile.$name.processing.prs.periods
¶ Type: list:double
Unit: s
The natural periods for computation of the pseudo absolute acceleration elastic response spectrum. Default is
0.3,1,3
.
-
profile.$name.processing.prs.Tmin
¶ Type: double
Unit: s
The lower bound of the period range to compute response spectra for. A negative value disables the range and only the list of periods is used. Default is
-1
.
-
profile.$name.processing.prs.Tmax
¶ Type: double
Unit: s
The upper bound of the period range to compute response spectra for. A negative value disables the range and only the list of periods is used. Default is
-1
.
-
profile.$name.processing.prs.naturalPeriods
¶ Type: int
The number of natural periods that are created with linear spacing between Tmin and Tmax. Default is
0
.
Note
capture.* Parameters controlling the image capturing. They are overridden if defined in profiles.
-
capture.region
¶ Type: string
Unit: degrees
Defines the region rectangle of the plotted map.
Formats:
+lat0+lon0+lat1+lon1 : region rectangle by minimum and maximum latitude and longitude.
[lat_dim]x[lon_dim]+lat0+lon0 : dimension + origin coordinate.
-
capture.dim.x
¶ Type: int
Unit: px
Defines the X resolution of the output map images in pixels. Default is
512
.
-
capture.dim.y
¶ Type: int
Unit: px
Defines the Y resolution of the output map images in pixels. Default is
512
.
Note
grid.* Parameters controlling the generation of grids for plotting on maps. They are overridden if defined in profiles.
-
grid.extent.lat
¶ Type: double
Unit: deg
Defines the latitudinal extent of the processing grid for GMPEs. Default is
5
.
-
grid.extent.lon
¶ Type: double
Unit: deg
Defines the longitudinal extent of the processing grid for GMPEs. Default is
5
.
-
grid.dim.x
¶ Type: int
Unit: cnt
Defines the X (longitude) resolution of the processing grid. Default is
512
.
-
grid.dim.y
¶ Type: int
Unit: cnt
Defines the Y (latitude) resolution of the processing grid. Default is
512
.
Note
map.* Parameters controlling the map features.
-
map.grayscale
¶ Type: boolean
Whether to render the map grayscale or coloured. Default is
false
.
-
map.grid.composition
¶ Type: string
Sets the mode of the GMPE grid map overlay. Possible values are: default, src, src-over, xor, plus, multiply. Default is
default
.
-
map.grid.triangle
¶ Type: boolean
If enabled then station symbols are being rendered as triangles. Otherwise a diamond shape is being used. Default is
false
.
-
map.station.annotation
¶ Type: boolean
Whether to show station annotations (codes) or not. Default is
true
.
-
map.station.triangle
¶ Type: boolean
If enabled then station symbols are being rendered as triangles. Otherwise a diamond shape is being used. Default is
false
.
-
map.event.legend
¶ Type: boolean
Whether to show the event legend or not. Default is
false
.
Note
scheme.colors.* Define colors.
-
scheme.colors.sigma.intensity
¶ Type: gradient
The intensity color gradient for ground motion values. This gradient will be used without normalization.
-
scheme.colors.sigma.gradient
¶ Type: gradient
The base color gradient for ground motion values. This gradient will be scaled to the final value range unless absolute scale is enabled in sigma.
-
scheme.colors.sigma.normalize
¶ Type: boolean
Whether to normalize the base color gradient to the current value range or not. Default is
true
.
Bindings¶
-
enable
¶ Type: boolean
Enables/disables the station for strong motion processing. Default is
true
.
-
channels
¶ Type: list:string
Defines a list of preferred channels that are activated by default for that station. If this option is undefined, the highest sample rate channels for acceleration and velocity are used by default. If the list is empty (which is a different state than undefined), then no channels are selected by default.
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.
Verbosity¶
-
--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
-
--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
-
--log-file
arg
¶ Use alternative log file.
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
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.