Files
2025/etc/descriptions/screloc.xml

224 lines
8.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="screloc" category="Processing">
<description>Automatic relocator.</description>
<configuration>
<group name="reloc">
<parameter name="locator" type="string">
<description>
Defines the locator to be used such as NonLinLoc.
</description>
</parameter>
<parameter name="profile" type="string">
<description>
The locator profile to use.
</description>
</parameter>
<parameter name="ignoreRejectedOrigins" type="boolean" default="false">
<description>
Ignores origins with status REJECTED.
</description>
</parameter>
<parameter name="allowAnyStatus" type="boolean" default="false">
<description>
Triggers processing on origins with any evaluation status.
Overrides &quot;allowPreliminaryOrigins&quot; but not
&quot;ignoreRejectedOrigins&quot;.
</description>
</parameter>
<parameter name="allowPreliminaryOrigins" type="boolean" default="false">
<description>
Triggers processing also on origins with status PRELIMINARY.
Origins with any other status is ignored anyway. The parameter
is overridden by &quot;allowAnyStatus&quot;.
</description>
</parameter>
<parameter name="allowManualOrigins" type="boolean" default="false">
<description>
Triggers processing also on origins with evaluatuion mode
MANUAL. Otherwise only origins with mode AUTOMATIC are
considered. The triggering may be limited due to an evaluation
status, see &quot;allowPreliminaryOrigins&quot;.
</description>
</parameter>
<parameter name="useWeight" type="boolean" default="false">
<description>
Whether to use the weight of the picks associated with the
input origin as defined in the input origin as input for
the locator or not. If false then all picks associated with
the input origin will be forwarded to the locator with full
weight.
</description>
</parameter>
<parameter name="adoptFixedDepth" type="boolean" default="false">
<description>
If the input origin's depth is fixed then it will be fixed
during the relocation process as well.
</description>
</parameter>
<parameter name="storeSourceOriginID" type="boolean" default="false">
<description>
Whether to store the ID of the input origin as comment in the
relocated origin or not.
</description>
</parameter>
<parameter name="originIDSuffix" type="string">
<description>
Suffix appended to the publicID of the origin to be relocated
to form the new publicID. This
helps to identify pairs of origins before and after relocation.
However, new publicIDs are unrelated to the time of creation.
If not defined, a new publicID will be generated automatically.
</description>
</parameter>
</group>
<group name="picks">
<description>
Parameters specific to picks.
</description>
<parameter name="streamsSetUnused" type="list:string" default="">
<description>
List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards * and ?
are supported.
Example:
GE.MOX.*.HH? : All arrivals on any HH stream of station MOX
will be kept but not used for locating.
</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>
<optionReference>database#db-disable</optionReference>
</group>
<group name="Mode">
<option long-flag="dump">
<description>
Dump processed origins as XML to stdout. Use in combination
with -O.
</description>
</option>
<option long-flag="test">
<description>
Test mode, do not send any message.
</description>
</option>
</group>
<group name="Input">
<option long-flag="locator" argument="arg" param-ref="reloc.locator">
</option>
<option long-flag="profile" argument="arg" param-ref="reloc.profile">
</option>
<option long-flag="ep" argument="arg">
<description>
Event parameters XML file for offline processing of all
contained origins. This option should not be mixed with
--dump.
</description>
</option>
<option flag="O" long-flag="origin-id" argument="arg">
<description>
Reprocess the origin and send a message unless test mode is
activated.
</description>
</option>
<option long-flag="use-weight" param-ref="reloc.useWeight" default="0">
</option>
<option long-flag="streams-set-unused" param-ref="picks.streamsSetUnused" argument="arg" type="list:string">
<description>
List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards * and ?
are supported.
</description>
</option>
<option long-flag="replace">
<description>
Used in combination with --ep. If given then each origin for
that an output has been generated is replaced by the result
of relocation. In other words: two LocSAT origins in, two
NonLinLoc origins out. All other objects are passed through.
</description>
</option>
</group>
<group name="Output">
<option long-flag="evaluation-mode">
<description>
Evaluation mode of the new origin (AUTOMATIC or MANUAL).
</description>
</option>
<option flag="f" long-flag="formatted">
<description>
Use formatted XML output. Otherwise XML is unformatted.
</description>
</option>
<option long-flag="origin-id-suffix">
<description>
Create origin ID from that of the input origin plus the
specfied suffix.
</description>
</option>
</group>
<group name="Profiling">
<option long-flag="measure-relocation-time">
<description>
Measure the time spent in a single relocation
</description>
</option>
<option long-flag="repeated-relocations" argument="arg">
<description>
Improve measurement of relocation time by running each
relocation multiple times. Specify the number of relocations,
e.g. 100.
</description>
</option>
</group>
</command-line>
</module>
</seiscomp>