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.
128 lines
3.2 KiB
Plaintext
128 lines
3.2 KiB
Plaintext
1 year ago
|
.. _global_locext:
|
||
|
|
|
||
|
|
######
|
||
|
|
LocExt
|
||
|
|
######
|
||
|
|
|
||
|
|
Locator which forwards the processing to external scripts
|
||
|
|
|
||
|
|
Description
|
||
|
|
===========
|
||
|
|
|
||
|
|
The ExternalLocator implements a wrapper for scripts which do the actual location
|
||
|
|
process. The input and output are represented as XML and communicated via the
|
||
|
|
input/output channels of the called process: stdin and stdout.
|
||
|
|
|
||
|
|
|
||
|
|
Plugin
|
||
|
|
======
|
||
|
|
|
||
|
|
To enable the ExternalLocator the plugin ``locext`` must be loaded.
|
||
|
|
|
||
|
|
|
||
|
|
Commandline Parameters
|
||
|
|
======================
|
||
|
|
|
||
|
|
There are several commandline parameters passed to the script depending on
|
||
|
|
the locator configuration. The following table summarizes them.
|
||
|
|
|
||
|
|
========================= ====================================================
|
||
|
|
Parameter Description
|
||
|
|
========================= ====================================================
|
||
|
|
--max-dist=X The cut-off distance if set
|
||
|
|
--ignore-initial-location Whether to ignore the initial origin location or not
|
||
|
|
--fixed-depth=X The depth in km to be fixed if enabled
|
||
|
|
========================= ====================================================
|
||
|
|
|
||
|
|
|
||
|
|
Input
|
||
|
|
=====
|
||
|
|
|
||
|
|
The input document written to stdin of the child process is a valid SeisComP
|
||
|
|
XML document containing ``EventParameters``. The event parameters hold exactly
|
||
|
|
one origin to be relocated and all picks references from the origins arrivals.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.. code:: xml
|
||
|
|
|
||
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<seiscomp xmlns="http://geofon.gfz-potsdam.de/ns/seiscomp3-schema/0.11" version="0.11">
|
||
|
|
<EventParameters>
|
||
|
|
<pick ...>...</pick>
|
||
|
|
<pick ...>...</pick>
|
||
|
|
...
|
||
|
|
<origin ...>
|
||
|
|
...
|
||
|
|
<arrival>
|
||
|
|
...
|
||
|
|
</arrival>
|
||
|
|
<arrival>
|
||
|
|
...
|
||
|
|
</arrival>
|
||
|
|
...
|
||
|
|
</origin>
|
||
|
|
</EventParameters>
|
||
|
|
</seiscomp>
|
||
|
|
|
||
|
|
|
||
|
|
Output
|
||
|
|
======
|
||
|
|
|
||
|
|
The output is read from stdout and is expected to be a SeisComP XML document
|
||
|
|
just containing an origin.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
.. code:: xml
|
||
|
|
|
||
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<seiscomp xmlns="http://geofon.gfz-potsdam.de/ns/seiscomp3-schema/0.11" version="0.11">
|
||
|
|
<Origin publicID="...">
|
||
|
|
</Origin>
|
||
|
|
</seiscomp>
|
||
|
|
|
||
|
|
|
||
|
|
Example Configuration
|
||
|
|
=====================
|
||
|
|
|
||
|
|
#. Define the external locator by global configuration e.g. in :file:`global.cfg`:
|
||
|
|
|
||
|
|
.. code::
|
||
|
|
|
||
|
|
plugins = ${plugins}, locext
|
||
|
|
|
||
|
|
ExternalLocator.profiles = locator1:"python /path/to/locator/script1.py",\
|
||
|
|
locator2:"/path/to/other/locator/script1.sh"
|
||
|
|
|
||
|
|
with
|
||
|
|
|
||
|
|
* *locator1*/*locator2*: The names of the profiles as shown in :ref:`scolv`
|
||
|
|
or use in ther modules like :ref:`screloc` for calling the external locator,
|
||
|
|
* *script1.py*/*script2.sh*: The names of Python/Bash scripts with full path
|
||
|
|
called by the profile to execute the locator given within the scripts.
|
||
|
|
|
||
|
|
#. Once defined, the external locator can be further configured and called
|
||
|
|
within :ref:`scolv` or by other modules e.g. :ref:`screloc`.
|
||
|
|
|
||
|
|
.. _global_locext_configuration:
|
||
|
|
|
||
|
|
Module Configuration
|
||
|
|
====================
|
||
|
|
|
||
|
|
|
||
|
|
.. note::
|
||
|
|
**ExternalLocator.\***
|
||
|
|
*Locator parameters: ExternalLocator*
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
.. confval:: ExternalLocator.profiles
|
||
|
|
|
||
|
|
Type: *list:string*
|
||
|
|
|
||
|
|
A list of profiles defined as tuples of name
|
||
|
|
and path to a script separated by colon.
|
||
|
|
|
||
|
|
|