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.

202 lines
8.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="scmag" category="Processing">
<description>Calculates magnitudes of different types.</description>
<configuration>
<parameter name="magnitudes" type="list:string" default="MLv, mb, mB, Mwp">
<description>
The magnitude types to be calculated. Station magnitudes are
computed from their amplitudes, network magnitudes from their
station magnitudes.
</description>
</parameter>
<group name="magnitudes">
<description>
General parameters for computing magnitudes. Others are configured
by global binding parameters for specific magnitude types.
</description>
<parameter name="average" type="list:string" default="default">
<description>
The methods for computing the network magnitude
from station magnitudes. Exactly one method per
magnitude can be configured.
To define the averaging method per magnitude type append
the type after colon, e.g.:
&quot;magnitudes.average = default, MLv:median&quot;
default: Compute the mean if less than 4 contributed
station magnitudes exist. Otherwise apply a trimmed mean
of 25%.
Options are &quot;default&quot;, &quot;mean&quot;,
&quot;median&quot;, &quot;trimmedMean&quot; and
&quot;medianTrimmedMean&quot;.
</description>
</parameter>
</group>
<group name="connection">
<parameter name="sendInterval" type="int" default="1" unit="s">
<description>
Interval between 2 sending processes. The interval controls
how often information is updated.
</description>
</parameter>
<parameter name="minimumArrivalWeight" type="double" default="0.5">
<description>
The minimum weight of an arrival for an associated amplitude
to be used for calculating a magnitude.
</description>
</parameter>
</group>
<group name="summaryMagnitude">
<description>
The summary magnitude is the weighted average from all
defined network magnitude types: Single network magnitude values
are multiplied with their magnitude-type specific weight and
summed up. The resulting sum is divided by the sum of all weights.
</description>
<parameter name="enabled" type="boolean" default="true">
<description>Enables summary magnitude calculation.</description>
</parameter>
<parameter name="type" type="string" default="M">
<description>Define the type/name of the summary magnitude.</description>
</parameter>
<parameter name="minStationCount" type="int" default="4">
<description>
This is the minimum station magnitude required for any
magnitude to contribute to the summary magnitude at all. If
this is set to 4, then no magnitude with less than 4 station
magnitudes is taken into consideration even if this results
in no summary magnitude at all. For this reason, the default
here is 1 but in a purely automatic system it should be
higher, at least 4 is recommended.
</description>
</parameter>
<parameter name="blacklist" type="list:string" default="">
<description>
Define the magnitude types to be excluded from the summary
magnitude calculation.
</description>
</parameter>
<parameter name="whitelist" type="list:string" default="">
<description>
Define the magnitude types to be included in the summary
magnitude calculation.
</description>
</parameter>
<group name="coefficients">
<description>
The coefficients defining the weight of network magnitudes
for calculating the summary magnitude.
Weight = a * magnitudeStationCount + b.
</description>
<parameter name="a" type="list:string" default="0, Mw(mB):0.4, Mw(Mwp):0.4">
<description>
Define the coefficients a. To define the value per magnitude
type append the type after colon. A value without a
type defines the default value.
</description>
</parameter>
<parameter name="b" type="list:string" default="1, MLv:2, Mw(mB):-1, Mw(Mwp):-1">
<description>
Define the coefficients b. To define the value per magnitude
type append the type after colon. A value without a
type defines the default value.
</description>
</parameter>
</group>
</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>
<option flag="x" long-flag="expiry" argument="time">
<description>Time span in hours after which objects expire.</description>
</option>
</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>
<optionReference>database#db-disable</optionReference>
</group>
<group name="Input">
<option long-flag="ep" argument="file">
<description>
Defines an event parameters XML file to be read and processed. This
implies offline mode and only processes all origins contained
in that file. It computes station magnitudes for all picks associated
with an origin where amplitudes are available and the corresponding
network magnitudes. Station and network magnitudes having the
evaluation status set are ignored. Use the --force to include those
magnitudes. It outputs an XML text adding the station-
and network magnitudes to the input XML file.
</description>
</option>
<option long-flag="reprocess">
<description>
Reprocess also station and network magnitudes with an evaluation
status set but do not change original weights. New
contributions are added with weight 0.
</description>
</option>
</group>
<group name="Reprocess">
<option long-flag="static">
<description>
With that flag all existing station magnitudes are recomputed
based on their associated amplitudes. If an amplitude cannot
be accessed, no station magnitude is updated.
Network magnitudes are recomputed based on their station
magnitude contributions. No new objects will
be created in this mode, it only updates values and weights.
The method to accumulate the station magnitudes to form the network
magnitude will be read from the existing object and replicated.
If it cannot be interpreted then the configured default for this
magnitude type will be used instead. Weights of station magnitudes
will be changed according to the accumulation method of the
network magnitude.
</description>
</option>
<option long-flag="keep-weights">
<description>
Keep the original weights in combination with --static.
</description>
</option>
</group>
</command-line>
</module>
</seiscomp>