398 lines
16 KiB
XML
398 lines
16 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<seiscomp>
|
|
<module name="scautopick" category="Processing" inherit-global-bindings="true">
|
|
<description>Phase detection and picking on waveforms.</description>
|
|
<configuration>
|
|
<parameter name="ringBufferSize" type="int" default="300" unit="s">
|
|
<description>
|
|
Defined the record ringbuffer size in seconds.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="leadTime" type="int" default="60" unit="s">
|
|
<description>
|
|
The leadTime defines the time in seconds to start picking on
|
|
waveforms before current time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="playback" type="boolean" default="false">
|
|
<description>
|
|
If enabled, picks can be made on waveforms which are older than
|
|
current time - "leadTime". Current time is the time
|
|
when the module was started. This allows to pick
|
|
historic data in real-time playbacks which are preserving the
|
|
record times. See e.g. the "msrtsimul" module.
|
|
This option deactivates "leadTime". Activate only for playbacks.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="initTime" type="int" default="60" unit="s">
|
|
<description>
|
|
The initTime defines a time span in seconds for that the picker
|
|
is blind after initialization. This time is needed to initialize
|
|
the filter and depends on it.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="gapInterpolation" type="boolean" default="false">
|
|
<description>
|
|
Interpolate gaps linearly? This is valid for gaps shorter
|
|
than thresholds.maxGapLength.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="useAllStreams" type="boolean" default="true">
|
|
<description>
|
|
If enabled, all streams that are received by the picker are
|
|
used for picking. This option has only effect if a
|
|
file is used as input which contains more data than the
|
|
picker requests. If connected to a waveform server such as
|
|
SeedLink, the picker will only receive the data it is
|
|
subscribed to.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="filter" type="string" default=""RMHP(10)>>ITAPER(30)>>BW(4,0.7,2)>>STALTA(2,80)"">
|
|
<description>
|
|
The default filter used for making detections. Station-specific
|
|
configurations (bindings) override this value.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="timeCorrection" type="double" default="-0.8" unit="s">
|
|
<description>
|
|
The time correction applied for a pick. Station-specific
|
|
values (bindings) override this value.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="picker" type="string">
|
|
<description>
|
|
The re-picker to use. By default only simple detections
|
|
are emitted as picks. To enable re-picking on a time window around
|
|
the detection, an algorithm (plugin) can be defined with this parameter.
|
|
|
|
Currently available: "AIC", "BK" or
|
|
"GFZ".
|
|
|
|
More options may be available by plugins. Configure related
|
|
parameters in global bindings.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="phaseHint" type="string" default="P">
|
|
<description>
|
|
Phase hint to be assigned to the pick made by the primary picker.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="sendDetections" type="boolean" default="false">
|
|
<description>
|
|
If enabled and "picker" is configured, then
|
|
initial detections are sent as well. To distinguish between
|
|
detections and picks the evaluation status of the pick is
|
|
set to "rejected". This is meant to be a debug
|
|
option which can be used to compare detections and picks by
|
|
their evaluation status.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="spicker" type="string">
|
|
<description>
|
|
The secondary picker to use, e.g., for picking S-phases.
|
|
Currently available is: "S-L2". More options may
|
|
be available by plugins. Configure related parameters
|
|
in global bindings.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="killPendingSPickers" type="boolean" default="true">
|
|
<description>
|
|
If enabled, all secondary pickers that were triggered by
|
|
a previous pick will be terminated when a new detection or
|
|
pick has been found. This aims to avoid the case where an
|
|
S phase is wrongly picked as P but would also be picked as
|
|
S by the secondary picker. But suppressing the S pick can
|
|
lead to undesired results. It might be better in some
|
|
situations to have two picks (P and S) instead only a wrong P.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="extraPickComments" type="boolean" default="false">
|
|
<description>
|
|
If enabled and "picker" or "spicker" is
|
|
configured, extra comments will be added to the resulting pick.
|
|
|
|
Supported comments:
|
|
|
|
SNR: added if SNR >= 0, comment id is "SNR"
|
|
|
|
duration: added if the duration has been computed at the time
|
|
of the pick creation, which actually requires
|
|
"thresholds.maxDuration" to be configured
|
|
with a non-negative value.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="fx" type="string">
|
|
<description>
|
|
Configures the feature extraction type to use. Currently
|
|
available: "DFX". Configure related parameters
|
|
in global bindings.
|
|
|
|
When configured, the usability of the features for locating
|
|
events depends on the used locator, e.g. LOCSAT. Read the
|
|
locator's documentation and configuration parameters.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="amplitudes" type="list:string" default="MLv, mb, mB">
|
|
<description>
|
|
The amplitude types to be computed by the picker based on
|
|
picks.
|
|
</description>
|
|
</parameter>
|
|
<group name="thresholds">
|
|
<description>
|
|
Threshold parameters for the primary picker.
|
|
</description>
|
|
<parameter name="triggerOn" type="double" default="3">
|
|
<description>
|
|
For which value on the filtered waveforms is a pick
|
|
detected. Station specific values override this value.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="triggerOff" type="double" default="1.5">
|
|
<description>
|
|
The value the filtered waveforms must reach to enable
|
|
detection again. Between triggerOn and triggerOff the
|
|
picker is blind and does not produce picks. Station
|
|
specific values override this value.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="maxGapLength" type="double" default="4.5" unit="s">
|
|
<description>
|
|
The maximum gap length in seconds to handle.
|
|
Gaps larger than this will cause the picker to be reset.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="amplMaxTimeWindow" type="double" default="10" unit="s">
|
|
<description>
|
|
The time window used to compute a maximum (snr) amplitude
|
|
on the filtered waveforms.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="deadTime" type="double" default="30" unit="s">
|
|
<description>
|
|
The time used together with measured amplitude and
|
|
`thresholds.minAmplOffset` for scaling the amplitude below which
|
|
the picker is inactive after a P pick. Read the documentation!
|
|
</description>
|
|
</parameter>
|
|
<parameter name="minAmplOffset" type="double" default="3">
|
|
<description>
|
|
The amplitude used together with measured amplitude and
|
|
`thresholds.deadTime` for scaling the amplitude below which
|
|
the picker is inactive after a P pick. The value is typically
|
|
similar to the trigger threshold. Read the documentation!
|
|
</description>
|
|
</parameter>
|
|
<parameter name="minDuration" type="double" default="-1">
|
|
<description>
|
|
The minimum duration to reach. The duration is measured as
|
|
the time between trigger on and trigger off. If this value
|
|
is configured the detection (pick) will be delayed in order
|
|
to compute and check the duration.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="maxDuration" type="double" default="-1">
|
|
<description>
|
|
The maximum duration allowed. The duration is measured as
|
|
the time between trigger on and trigger off. If this value
|
|
is configured the detection (pick) will be delayed in order
|
|
to compute and check the duration.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="amplitudes">
|
|
<parameter name="enableUpdate" type="list:string" default="" unit="">
|
|
<description>
|
|
Configure a list of magnitude types.
|
|
Update and send amplitudes for these magnitudes as soon as data are
|
|
available. Do not wait for complete time windows.
|
|
Only magnitudes computed by scautopick as given by the amplitudes parameter are considered.
|
|
This option is for rapid magnitude estimation and EEW.
|
|
|
|
WARNING: This option increases the load on the system!
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="connection">
|
|
<parameter name="amplitudeGroup" type="string" default="AMPLITUDE">
|
|
<description>
|
|
Message group for sending amplitudes to.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="comment">
|
|
<description>
|
|
Properties of a custom comment added to a pick. It requires both
|
|
ID and text to be configured.
|
|
</description>
|
|
<parameter name="ID" type="string" default="">
|
|
<description>
|
|
The ID of a custom comment.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="text" type="string" default="">
|
|
<description>
|
|
The text of a custom comment.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
</configuration>
|
|
<command-line>
|
|
<group name="Generic">
|
|
<optionReference>generic#help</optionReference>
|
|
<optionReference>generic#version</optionReference>
|
|
<optionReference>generic#config-file</optionReference>
|
|
<optionReference>generic#plugins</optionReference>
|
|
<optionReference>generic#daemon</optionReference>
|
|
<optionReference>generic#auto-shutdown</optionReference>
|
|
<optionReference>generic#shutdown-master-module</optionReference>
|
|
<optionReference>generic#shutdown-master-username</optionReference>
|
|
</group>
|
|
|
|
<group name="Verbosity">
|
|
<optionReference>verbosity#verbosity</optionReference>
|
|
<optionReference>verbosity#v</optionReference>
|
|
<optionReference>verbosity#quiet</optionReference>
|
|
<optionReference>verbosity#component</optionReference>
|
|
<optionReference>verbosity#syslog</optionReference>
|
|
<optionReference>verbosity#lockfile</optionReference>
|
|
<optionReference>verbosity#console</optionReference>
|
|
<optionReference>verbosity#debug</optionReference>
|
|
<optionReference>verbosity#log-file</optionReference>
|
|
</group>
|
|
|
|
<group name="Messaging">
|
|
<optionReference>messaging#user</optionReference>
|
|
<optionReference>messaging#host</optionReference>
|
|
<optionReference>messaging#timeout</optionReference>
|
|
<optionReference>messaging#primary-group</optionReference>
|
|
<optionReference>messaging#subscribe-group</optionReference>
|
|
<optionReference>messaging#content-type</optionReference>
|
|
<optionReference>messaging#start-stop-msg</optionReference>
|
|
</group>
|
|
|
|
<group name="Database">
|
|
<optionReference>database#db-driver-list</optionReference>
|
|
<optionReference>database#database</optionReference>
|
|
<optionReference>database#config-module</optionReference>
|
|
<optionReference>database#inventory-db</optionReference>
|
|
<option flag="" long-flag="db-disable" argument="" publicID="database#db-disable">
|
|
<description>Do not use the database at all</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Records">
|
|
<optionReference>records#record-driver-list</optionReference>
|
|
<optionReference>records#record-url</optionReference>
|
|
<optionReference>records#record-file</optionReference>
|
|
<optionReference>records#record-type</optionReference>
|
|
</group>
|
|
|
|
<group name="Mode">
|
|
<option flag="" long-flag="offline">
|
|
<description>Do not connect to a messaging server and do not use the database.</description>
|
|
</option>
|
|
<option flag="" long-flag="playback">
|
|
<description>
|
|
Switches to playback mode which does not request a particular time window from
|
|
the input data source. This implies that all records are forwarded to scautopick
|
|
if files are being used. Without this option scautopick sets the requested
|
|
start time to NOW-leadTime and therefore would not work anymore with
|
|
older datasets in offline mode or when running playbacks.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="ep">
|
|
<description>
|
|
Outputs an XML event parameters file containing all picks and amplitudes.
|
|
This option implies offline.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="amplitudes" argument="arg" default="1">
|
|
<description>Enables or disables computation of amplitudes.</description>
|
|
</option>
|
|
<option flag="" long-flag="test">
|
|
<description>
|
|
Runs the picker as usual but does not send any messages. This can be useful to
|
|
test the picker within a running system.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="dump-config">
|
|
<description>
|
|
Dumps the current configuration and exits. Station configuration is only read if
|
|
the picker connects to the messaging and the database. In offline mode it will
|
|
only dump the application specific setting unless a station.conf file is provided.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="dump-records">
|
|
<description>
|
|
This option only works in combination with :option:`--offline`. It will dump
|
|
the data of an amplitude processor if it completed processing successfully
|
|
and a new amplitude is available. The output format is a simple ASCII format.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Settings">
|
|
<option long-flag="filter" argument="filter" param-ref="filter"/>
|
|
<option long-flag="time-correction" argument="time" param-ref="timeCorrection"/>
|
|
<option long-flag="buffer-size" argument="timespan" param-ref="ringBufferSize"/>
|
|
<option long-flag="before" argument="timespan" param-ref="leadTime"/>
|
|
<option long-flag="init-time" argument="timespan" param-ref="initTime"/>
|
|
<option long-flag="trigger-on" argument="arg" param-ref="thresholds.triggerOn"/>
|
|
<option long-flag="trigger-off" argument="arg" param-ref="thresholds.triggerOff"/>
|
|
<option long-flag="trigger-dead-time" argument="arg" param-ref="thresholds.deadTime"/>
|
|
<option long-flag="ampl-max-time-window" argument="arg" param-ref="thresholds.amplMaxTimeWindow"/>
|
|
<option long-flag="min-ampl-offset" argument="arg" param-ref="thresholds.minAmplOffset"/>
|
|
<option long-flag="gap-tolerance" argument="arg" param-ref="thresholds.maxGapLength"/>
|
|
<option long-flag="gap-interpolation" argument="arg" param-ref="gapInterpolation"/>
|
|
<option long-flag="any-stream" argument="arg" param-ref="useAllStreams"/>
|
|
<option long-flag="send-detections" param-ref="sendDetections"/>
|
|
<option long-flag="extra-comments" param-ref="extraPickComments"/>
|
|
</group>
|
|
</command-line>
|
|
</module>
|
|
|
|
<!-- The basic binding description. This could also go into a separate file, but its integrated
|
|
into the core description to have everything in one place. -->
|
|
<binding module="scautopick">
|
|
<description>
|
|
Configures a station for picking. A station without a binding assigned
|
|
will not be picked unless the picker is in offline mode.
|
|
</description>
|
|
<configuration>
|
|
<parameter name="detecEnable" type="boolean" default="true">
|
|
<description>
|
|
Enables/disables picking on a station.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="detecFilter" type="string" default=""RMHP(10)>>ITAPER(30)>>BW(4,0.7,2)>>STALTA(2,80)"">
|
|
<description>
|
|
Defines the filter to be used for picking.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="trigOn" type="double" default="3">
|
|
<description>
|
|
For which value on the filtered waveform is a pick detected.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="trigOff" type="double" default="1.5">
|
|
<description>
|
|
The value the filtered waveform must reach to
|
|
enable a detection again.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="timeCorr" type="double" default="-0.8" unit="s">
|
|
<description>
|
|
The time correction applied to a pick.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="sensitivityCorrection" type="boolean" default="false">
|
|
<description>
|
|
Defines whether the detector applies sensitivity correction
|
|
(applying the gain) or not in advance to filter the data.
|
|
</description>
|
|
</parameter>
|
|
</configuration>
|
|
</binding>
|
|
</seiscomp>
|