You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
367 lines
9.4 KiB
ReStructuredText
367 lines
9.4 KiB
ReStructuredText
.. highlight:: rst
|
|
|
|
.. _sh2proc:
|
|
|
|
#######
|
|
sh2proc
|
|
#######
|
|
|
|
**Convert SeismicHandler event files to SCML.**
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
sh2proc converts `Seismic Handler <http://www.seismic-handler.org/>`_ event data to
|
|
SeisComP XML format. Data is read from input file or `stdin` if no input file is
|
|
specified. The result is available on `stdout`.
|
|
|
|
Code mapping
|
|
============
|
|
|
|
Since Seismic Handler only specifies station and component codes, a mapping to
|
|
SeisComP network, location and channel codes is necessary. The script assumes
|
|
that the same station code is not used in different networks. In case an
|
|
ambiguous id is found a warning is printed and the first network code is used.
|
|
The channel and stream code is extracted from the dectecStream and detecLocid
|
|
configured in the global bindings. In case no configuration module is available
|
|
the first location and stream is used.
|
|
|
|
Event parameters
|
|
================
|
|
|
|
* Event types given in Seismic Handler files are mapped to SeisComP event types:
|
|
|
|
.. csv-table::
|
|
:header: "Seismic Handler", "SeisComP"
|
|
|
|
"teleseismic quake","earthquake"
|
|
"regional quake","earthquake"
|
|
"local quake","earthquake"
|
|
"quarry blast","quarry blast"
|
|
"nuclear explosion","nuclear explosion"
|
|
"mining event","mining explosion"
|
|
|
|
* The EventID given in Seismic Handler files is mapped as a comment to the event.
|
|
|
|
Magnitudes
|
|
==========
|
|
|
|
* Magnitude types given in Seismic Handler files are mapped to SeisComP magnitudes:
|
|
|
|
.. csv-table::
|
|
:header: "Seismic Handler", "SeisComP"
|
|
|
|
"m","M"
|
|
"ml","ML"
|
|
"mb","mb"
|
|
"ms","Ms(BB)"
|
|
"mw","Mw"
|
|
"bb","mB"
|
|
|
|
* ML magnitudes in Seismic Handler files have no corresponding measured amplitudes.
|
|
Therefore the ML station magnitudes are converted without referencing the amplitude.
|
|
|
|
* Seismic Handler uses the phase name "L" for referring to surface waves without
|
|
further specification. The phase name is kept unchanged.
|
|
|
|
Distance calculations
|
|
=====================
|
|
|
|
In Seismic Handler files distances can be given in units of km or degree but in
|
|
SeisComP only degree is used. Both representations are considered for conversion.
|
|
In case of double posting preference is given to the Seismic Handler values given in km
|
|
due to their higher precision.
|
|
|
|
Beam parameters
|
|
===============
|
|
|
|
Seismic Handler files provide the phase picks with theoretical, measured and corrected
|
|
slowness and (back) azimuth but the pick in SeisComP knows only one value.
|
|
During conversion highest preference is given to corrected values.
|
|
The theoretical values are ignored.
|
|
|
|
Limitations
|
|
===========
|
|
|
|
The following parameters from Seismic Handler files are not considered:
|
|
|
|
* Phase Flag
|
|
* Location Input Params
|
|
* Reference Location Name
|
|
* Quality Number
|
|
* Ampl&Period Source
|
|
* Location Quality
|
|
* Reference Latitude
|
|
* Reference Longitude
|
|
* Amplitude Time
|
|
|
|
Further processing in SeisComP
|
|
===============================
|
|
|
|
The created XML files can be used in multiple ways, e.g.:
|
|
|
|
#. By other modules in an XML-base playback
|
|
#. Inject into the messaging system by :ref:`scdispatch`
|
|
#. Integrate into the database by :ref:`scdb`
|
|
|
|
Examples
|
|
========
|
|
|
|
#. Convert the Seismic Handler file `shm.evt` and writes SC3ML into the file
|
|
`sc3.xml`. The database connection to read inventory and configuration
|
|
information is fetched from the default messaging connection.
|
|
|
|
.. code-block:: sh
|
|
|
|
sh2proc shm.evt > sc3.xml
|
|
|
|
#. Read Seismic Handler data from `stdin`. Inventory and configuration information
|
|
is provided through files.
|
|
|
|
.. code-block:: sh
|
|
|
|
cat shm.evt | sh2proc --inventory-db=inventory.xml --config-db=config.xml > sc3.xml
|
|
|
|
shm.evt file format
|
|
===================
|
|
|
|
The list of parameters supported by sh2proc may be incomplete.
|
|
Read the original `format and parameter description <http://www.seismic-handler.org/wiki/ShmDocFileEvt>`_
|
|
of the SeismicHandler .evt files for providing correct input files.
|
|
|
|
Example of a SeismicHandler `shm.evt` file with supported parameters:
|
|
|
|
.. code-block:: sh
|
|
|
|
Event ID : 1170102002
|
|
Station code : VITZ
|
|
Onset time : 2-JAN-2017_12:25:40.415
|
|
Onset type : emergent
|
|
Phase name : Pg
|
|
Event Type : mining event
|
|
Applied filter : SHM_BP_1HZ_25HZ_3
|
|
Component : Z
|
|
Quality number : 2
|
|
Pick Type : manual
|
|
Weight : 4
|
|
Theo. Azimuth (deg) : 27.29
|
|
Theo. Backazimuth (deg): 207.36
|
|
Distance (deg) : 0.122
|
|
Distance (km) : 13.572
|
|
Magnitude ml : 1.0
|
|
Phase Flags : L
|
|
--- End of Phase ---
|
|
|
|
|
|
Event ID : 1170102002
|
|
Station code : WESF
|
|
Onset time : 2-JAN-2017_12:25:53.714
|
|
Onset type : emergent
|
|
Phase name : Pg
|
|
Event Type : mining event
|
|
Applied filter : SHM_BP_1HZ_25HZ_3
|
|
Component : Z
|
|
Quality number : 2
|
|
Pick Type : manual
|
|
Weight : 4
|
|
Theo. Azimuth (deg) : 106.98
|
|
Theo. Backazimuth (deg): 287.91
|
|
Distance (deg) : 0.807
|
|
Distance (km) : 89.708
|
|
Magnitude ml : 1.8
|
|
Mean Magnitude ml : 1.1
|
|
Latitude : +50.779
|
|
Longitude : +10.003
|
|
Depth (km) : 0.0
|
|
Depth type : (g) estimated
|
|
Origin time : 2-JAN-2017_12:25:38.273
|
|
Region Table : GEO_REG
|
|
Region ID : 5326
|
|
Source region : Tann, E of Fulda
|
|
Velocity Model : deu
|
|
Location Input Params : 20
|
|
Reference Location Name: CENTRE
|
|
--- End of Phase ---
|
|
|
|
|
|
.. _sh2proc_configuration:
|
|
|
|
Module Configuration
|
|
====================
|
|
|
|
| :file:`etc/defaults/global.cfg`
|
|
| :file:`etc/defaults/sh2proc.cfg`
|
|
| :file:`etc/global.cfg`
|
|
| :file:`etc/sh2proc.cfg`
|
|
| :file:`~/.seiscomp/global.cfg`
|
|
| :file:`~/.seiscomp/sh2proc.cfg`
|
|
|
|
sh2proc inherits :ref:`global options<global-configuration>`.
|
|
|
|
|
|
|
|
|
|
Command-Line Options
|
|
====================
|
|
|
|
.. program:: sh2proc
|
|
|
|
:program:`sh2proc [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.
|
|
|
|
|
|
Messaging
|
|
---------
|
|
|
|
.. option:: -u, --user arg
|
|
|
|
Overrides configuration parameter :confval:`connection.username`.
|
|
|
|
.. option:: -H, --host arg
|
|
|
|
Overrides configuration parameter :confval:`connection.server`.
|
|
|
|
.. option:: -t, --timeout arg
|
|
|
|
Overrides configuration parameter :confval:`connection.timeout`.
|
|
|
|
.. option:: -g, --primary-group arg
|
|
|
|
Overrides configuration parameter :confval:`connection.primaryGroup`.
|
|
|
|
.. option:: -S, --subscribe-group arg
|
|
|
|
A group to subscribe to.
|
|
This option can be given more than once.
|
|
|
|
.. option:: --content-type arg
|
|
|
|
Overrides configuration parameter :confval:`connection.contentType`.
|
|
|
|
.. option:: --start-stop-msg arg
|
|
|
|
Set sending of a start and a stop message.
|
|
|
|
|
|
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 .
|
|
|
|
.. option:: --db-disable
|
|
|
|
Do not use the database at all
|
|
|