.. highlight:: rst .. _sigma: ##### sigma ##### **Strong event parameter GUI** Description =========== SIGMA is a graphical user interface to compute and visualize strong motion event parameters and to store them in a database. Module Configuration ==================== | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/sigma.cfg` | :file:`etc/global.cfg` | :file:`etc/sigma.cfg` | :file:`~/.seiscomp/global.cfg` | :file:`~/.seiscomp/sigma.cfg` sigma inherits :ref:`global options`. .. note:: Modules/plugins may require a license file. The default path to license files is :file:`@DATADIR@/licenses/` which can be overridden by global configuration of the parameter :confval:`gempa.licensePath`. Example: :: gempa.licensePath = @CONFIGDIR@/licenses .. confval:: fdsnwsUrl Default: ``http://localhost`` Type: *string* Configures the base URL of the FDSN web services. Provide the full URL before \"event\/1\/query\". .. confval:: gmpe.groups Type: *list:string* Allows to configure GMPE groups for models. Ungrouped models will be added to a groups called \"Ungrouped\". This holds a list of group identifiers which need to be configured in the corresponding group structure. .. confval:: gmpe.vs30grid Type: *path* Specifies 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.group.$name.\*** $name is a placeholder for the name to be used. .. confval:: gmpe.group.$name.name Type: *string* The name of the group. .. confval:: gmpe.group.$name.members Type: *list:string* The group members. Each member is a concatenation of the GMPE provider and its model name separated with a slash. E.g. \"pygme\/AbrahamsonEtAl2014\". .. note:: **gmpe.py.\*** *Adds configuration for Python2 GMPE processing.* .. confval:: 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. .. confval:: gmpe.py.basePath Default: ``@CONFIGDIR@/pygmpe/`` Type: *path* The base path for all python model implementations. .. note:: **gmpe.py3.\*** *Adds configuration for Python3 GMPE processing.* .. confval:: 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. .. confval:: gmpe.py3.basePath Default: ``@CONFIGDIR@/pygmpe/`` Type: *path* The base path for all python model implementations. .. confval:: processing.targetDistricts Type: *list:string* A list of Shapefile paths used as target districts for GMPE\/intensity computation. .. confval:: processing.maximumEpicentralDistance Default: ``400`` Unit: *km* Type: *int* The maximum epicentral distance in km of a station being considered for processing. This value is used if wfparam.magnitudeDistanceTable is not specified. .. confval:: processing.firstPhaseVelocity Default: ``8`` Unit: *km/s* Type: *double* Velocity for predicting the P\-wave arrival time from epicentral distance. This is a fallback if the time cannot be retrieved from the travel\-time interface. .. confval:: processing.preEventWindowLength Default: ``60`` Unit: *s* Type: *int* The pre event time window length in seconds. .. confval:: processing.postEventWindowLength Default: ``(0.36*d)+60`` Unit: *s* Type: *string* Default value of time window length after the event onset in seconds. This value is an numerical expression and can include three symbols: d \(distance in km\), D \(distance in degree\) and az \(azimuth clockwise from North\). .. confval:: processing.eventCutOff Default: ``true`` 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]. .. confval:: processing.afterShockRemoval Default: ``true`` Type: *boolean* Enables\/disables aftershock removal \(Figini, 2006; Paolucci et al., 2008\) .. confval:: processing.durationScale Default: ``1.5`` Type: *double* Defines the factor applied to the significant duration to define the processing spectra time window. If that value is <\= 0, the totalTimeWindowLength is used. .. confval:: processing.STAlength Default: ``1`` Unit: *s* Type: *double* Specifies the STA length in seconds of the applied STA\/LTA check. .. confval:: processing.LTAlength Default: ``60`` Unit: *s* Type: *double* Specifies the LTA length in seconds of the applied STA\/LTA check. .. confval:: processing.STALTAratio Default: ``3`` Type: *double* Specifies the minimum STALTA ratio to be reached to further process a station. .. confval:: processing.STALTAmargin Default: ``5`` Unit: *s* Type: *double* Specifies the number of seconds around P to be used to check the STA\/LTA ratio. .. confval:: processing.minSnrPd Default: ``-1.0`` Type: *double* Minimum snrPd amplitude for sending pdPvR and any other amplitude. .. note:: **processing.filter.\*** *Parameters of the 1st stage filter.* .. confval:: processing.filter.order Default: ``4`` Type: *int* Specifies the order of the 1st stage filter. .. confval:: processing.filter.loFreq Default: ``0.025`` Type: *double* 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. .. confval:: processing.filter.hiFreq Default: ``40`` Type: *double* 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. .. confval:: processing.spectra.taperLength Default: ``-1`` Unit: *s* Type: *double* 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. .. confval:: processing.spectra.padLength Default: ``-1`` Unit: *s* Type: *double* 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. .. confval:: processing.prs.damping Default: ``5`` Unit: *%* Type: *double* Specifies the damping value \(in percent\) for computation of the pseudo absolute acceleration elastic response spectrum. .. confval:: processing.prs.periods Default: ``0.3,1,3`` Unit: *s* Type: *list:double* Specifies the natural periods for computation of the pseudo absolute acceleration elastic response spectrum. .. confval:: processing.prs.Tmin Default: ``-1`` Unit: *s* Type: *double* 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. .. confval:: processing.prs.Tmax Default: ``-1`` Unit: *s* Type: *double* 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. .. confval:: processing.prs.naturalPeriods Default: ``0`` Type: *int* The number of natural periods that are created with linear spacing between Tmin and Tmax. .. note:: **output.\*** *Parameters controlling the output of processing products.* .. confval:: output.database Type: *string* Configures the URI of the output database containing the SIGMA tables. If nothing is configured, the seiscomp3 database will be used. .. confval:: output.exportPath Type: *path* The path where all result files are saved. .. confval:: 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. .. confval:: output.exportOpenDirectory Default: ``false`` Type: *boolean* If enabled then the systems file browser will be started with the configured output directory after a successful export. .. confval:: scheme.colors.heatmap.gradient Type: *gradient* The color gradient of the heatmap, e.g. the events heatmap. .. confval:: scheme.colors.heatmap.discrete Default: ``false`` Type: *boolean* If false then colors from the heatmap gradient are interpolated between two nodes. Otherwise the color configured at the next lower value node is taken. .. confval:: scheme.colors.vs30.gradient Type: *gradient* The color gradient of the vs30 color values, e.g. the station symbols of the GMPE plot. .. confval:: scheme.colors.vs30.discrete Default: ``true`` Type: *boolean* If false then colors from the vs30 color gradient are interpolated between two nodes. Otherwise the color configured at the next lower value node is taken. .. confval:: scheme.colors.sigma.intensity Type: *gradient* The intensity color gradient for ground motion values. This gradient will be used without normalization. .. confval:: 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. .. confval:: scheme.colors.sigma.discrete Default: ``false`` Type: *boolean* If false then colors from the base gradient are interpolated between two nodes. Otherwise the color configured at the next lower value node is taken. .. confval:: scheme.colors.sigma.normalize Default: ``true`` Type: *boolean* Whether to normalize the base color gradient to the current value range or not. .. confval:: scheme.map.stationSymbol Default: ``diamond`` Type: *string* Defines which station symbol to use. The default is a diamond shape with a single point pointing to the location of the station. An alternative shape is the triangle as used in SeisComP. Use \"triangle\" to switch to this style. .. confval:: scheme.map.stationSymbolHotspot Default: ``0.5,0`` Type: *list:double* Defines the hotspot \(center\) of the station symbol in relative coordinates as x,y tuple. x is increasing from left to right and y is increasing from bottom to top. This setting is not taken into account when using the diamond shape. .. confval:: map.layers.scale.legendArea Default: ``bottomcenter`` Type: *string* Defines the location of the scale layer legend. Acceptable values are: topleft, topcenter, topright, bottomleft, bottomcenter and bottomright. .. confval:: map.layers.scale.visible Default: ``false`` Type: *boolean* Sets the initial visibility of the scale layer. Bindings Parameters =================== .. confval:: enable Default: ``true`` Type: *boolean* Enables\/disables the station for strong motion processing. .. confval:: channels Type: *list:string* Defines a list of preferred channels that are activated by default for that station. If this option is undefined then 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 Options ==================== Generic ------- .. option:: -h, --help Show help message. .. option:: -V, --version Show version information. .. option:: --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. Example: scautopick \-> scautopick2. .. option:: --plugins arg Load given plugins. .. option:: -D, --daemon Run as daemon. This means the application will fork itself and doesn't need to be started with \&. .. option:: --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\). .. option:: --shutdown-master-module arg Set 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. .. option:: --shutdown-master-username arg Set 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 --------- .. option:: --verbosity arg Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug. .. option:: -v, --v Increase verbosity level \(may be repeated, eg. \-vv\). .. option:: -q, --quiet Quiet mode: no logging output. .. option:: --component arg Limit the logging to a certain component. This option can be given more than once. .. option:: -s, --syslog Use syslog logging backend. The output usually goes to \/var\/lib\/messages. .. option:: -l, --lockfile arg Path to lock file. .. option:: --console arg Send log output to stdout. .. option:: --debug Execute in debug mode. Equivalent to \-\-verbosity\=4 \-\-console\=1 . .. option:: --log-file arg Use alternative log file. Database -------- .. option:: --db-driver-list List all supported database drivers. .. option:: -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\". .. option:: --config-module arg The config module to use. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location .