Files
2025/etc/descriptions/scrttv.xml

619 lines
22 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="scrttv" category="GUI">
<description>Real-time trace view.</description>
<configuration>
<group name="messaging">
<group name="groups">
<parameter name="config" type="string" default="CONFIG">
<description>
The messaging group to which config messages (such
as station enable/disable messages) are being sent.
</description>
</parameter>
<parameter name="location" type="string" default="LOCATION">
<description>
The messaging group to which location messages
are being sent.
</description>
</parameter>
</group>
</group>
<parameter name="maxDelay" type="int" unit="s" default="0">
<description>
If greater than 0, then all traces for which the data latency is
higher than this value are hidden. 0 disables the feature.
</description>
</parameter>
<parameter name="resortAutomatically" type="boolean" default="true">
<description>
If enabled, then all traces are sorted by distance when a new
origin arrives.
</description>
</parameter>
<parameter name="showPicks" type="boolean" default="true">
<description>
If enabled, picks are shown.
</description>
</parameter>
<parameter name="mapPicks" type="boolean" default="false">
<description>
Map picks to best matching rows. This is important
if picks created on BHN should be shown but only the BHZ trace
is part of the list. Network code, station code and location code
must match anyway.
</description>
</parameter>
<parameter name="filter" type="string">
<description>
Define the filter to be used when filtering is activated. This
parameter is ignored if &quot;filters&quot; is configured.
This parameter exists mainly for backward compatibility.
</description>
</parameter>
<parameter name="filters" type="list:string" default="&quot;RMHP(2)>>ITAPER(5)>>BW(3,0.5,8.0)&quot;,&quot;RMHP(2)>>ITAPER(5)>>BW_HP(3, 3)&quot;">
<description>
Define a list of filters that is cycles through when pressing
'G' or 'D'. Filtering is toggled with 'F'.
This parameter supersedes &quot;filter&quot;. If undefined,
&quot;filter&quot; is used instead. If defined, this filter
list is used exclusively and the filter option is ignored.
Formats:
&quot;filter grammar&quot;: filter grammar is shown in
the scrttv filter selection and applied.
&quot;name;filter grammar&quot;: name is shown in the scrttv
filter selection but filter grammar is applied.
</description>
</parameter>
<parameter name="autoApplyFilter" type="boolean" default="false">
<description>
Activate the first filter of the configured filter list
after startup. This is equivalent to pressing 'f'.
</description>
</parameter>
<parameter name="bufferSize" type="int" unit="s" default="1800">
<description>
Define the buffer size in seconds of the ring bu of each trace.
</description>
</parameter>
<parameter name="allTracesInitiallyVisible" type="boolean" default="false">
<description>
If set to true, all traces will be visible on application startup
independent of data availability.
</description>
</parameter>
<parameter name="autoResetDelay" type="int" unit="s" default="900">
<description>
Time span in seconds to switch back to the last view after an origin
caused resorting. The default is 15 min.
</description>
</parameter>
<parameter name="3c" type="boolean" default="false">
<description>
If enabled, all three components (vertical, 1st and 2nd horizontal)
related to the detecStream will be shown rather than only the
component configured in global bindings. The option is ignored
when using --no-inventory.
</description>
</parameter>
<group name="streams">
<group name="sort">
<description>
Configure the initial stream sorting.
</description>
<parameter name="mode" type="string" default="distance">
<description>
The sort mode applied initially. Allowed values
are: config, distance, station, network, group.
</description>
</parameter>
<parameter name="latitude" type="double" unit="deg" default="0.0">
<description>
Latitude of the initial location for sorting traces.
Only valid if mode == distance.
</description>
</parameter>
<parameter name="longitude" type="double" unit="deg" default="0.0">
<description>
Longitude of the initial location for sorting traces.
Only valid if mode == distance.
</description>
</parameter>
</group>
<parameter name="codes" type="list:string">
<description>
The list of channel codes to be displayed. List items
may contain wildcards at any position and are separated
by comma. Wildcard support depends on RecordStream,
e.g.:
caps/sdsarchive: *.*.*.*
slink: NET.STA.*.*
The channel list is intersected with all channels
configured in inventory unless --no-inventory is used.
Examples:
default : display all streams configured by global
bindings
default, PF.BON.00.HH? : display default and all HH
streams of PF.BON.00
</description>
</parameter>
<parameter name="blacklist" type="list:string">
<description>
If not empty then all stream patterns are part of the blacklist.
The blacklist is only active if &quot;streams.codes&quot;
is omitted and the default stream list according to the
bindings is to be shown. Each pattern can include wildcards
(either ? or *). The pattern is checked against the channel
id which is a concatenation of network code, station code,
location code and channel code separated with a dot,
e.g. &quot;GE.MORC..BHZ&quot;.
</description>
</parameter>
<parameter name="rows" type="integer">
<description>
Number of rows to show at once in one windows. If more traces
than rows are loaded, the are accessible by a scroll bar.
</description>
</parameter>
<group name="region">
<description>
Define a region used for clipping requested stations.
</description>
<parameter name="lonmin" type="double" unit="deg" default="-180.0">
<description>
Minimum longitude.
</description>
</parameter>
<parameter name="lonmax" type="double" unit="deg" default="180.0">
<description>
Maximum longitude.
</description>
</parameter>
<parameter name="latmin" type="double" unit="deg" default="-90.0">
<description>
Minimum latitude.
</description>
</parameter>
<parameter name="latmax" type="double" unit="deg" default="90.0">
<description>
Maximum latitude.
</description>
</parameter>
</group>
<parameter name="groups" type="string" default="">
<description>
Stream group profiles to be considered which must be defined in
group section. Use comma separation for a list of groups.
</description>
</parameter>
<parameter name="profiles" type="string" default="">
<description>
Stream profiles to be considered which must be defined in
profile section. Use comma separation for a list of profiles.
</description>
</parameter>
<group name="group">
<description>
Definiton of stream groups shown in scrttv with unique features.
Register the profiles in &quot;groups&quot; to apply them.
</description>
<struct type="Stream group profile" link="streams.groups">
<parameter name="members" type="list:string">
<description>
List of channels codes to be displayed within
this group. List items may contain wildcards at any position
and are separated by comma.
The list is intersected with all channels configured in inventory.
Example:
CX.*..BH?,PF.BON.00.HH? : all BH streams of the CX network
and all HH streams of PF.BON.00
</description>
</parameter>
<parameter name="title" type="string">
<description>
Title of the group visible as a tooltip of the traces.
</description>
</parameter>
<group name="pen">
<description>
Define the trace pen of the group.
</description>
<parameter name="color" type="color">
<description>
The color of the pen. If not given, the default
trace color is being used. The parameter is overridden
by &quot;streams.group.$profile.gradient&quot; .
</description>
</parameter>
<parameter name="gradient" type="gradient">
<description>
Define the color gradient used to generate the
trace color for each group member. When given, the
value in &quot;streams.group.$profile.pen.color&quot;
is ignored. The colors are distributed equally and
given in hexadecimal representation or by or
:term:`color keyword names`.
The stop points
can be set at any value. The final trace color
will be interpolated from the normalized gradient
where the value range is scaled to [0,1].
Format: value1:color1,value2:color2
Examples:
0:yellow,1:green
0:FFBF00,1:C70039
</description>
</parameter>
<parameter name="style" type="string" default="SolidLine">
<description>
The style of the pen. Supported values are: NoPen,
SolidLine, DashLine, DotLine, DashDotLine,
DashDotDotLine.
</description>
</parameter>
<parameter name="width" type="double" default="1.0" unit="px">
<description>
The width of the pen.
</description>
</parameter>
</group>
</struct>
</group>
<group name="profile">
<description>
Definiton of profiles for streams shown with unique decorations.
Register the profiles in &quot;profiles&quot; to apply them.
</description>
<struct type="Stream profile" link="streams.profiles">
<parameter name="match" type="string" unit="" default="">
<description>
Stream applying this profile to. Use regular expressions
for defining multiple streams. Examples:
GR.BFO.00.BHZ: One stream on vertical component
GR.*.00.BHZ: All stations from GR network and their
vertical components.
</description>
</parameter>
<parameter name="description" type="string" unit="" default="">
<description>
Text added to streams.
</description>
</parameter>
<parameter name="minMaxMargin" type="double" unit="" default="0.0">
<description>
Fraction of trace amplitude added to trace widgets.
</description>
</parameter>
<parameter name="unit" type="string" unit="" default="">
<description>
The physical unit shown along with stream maximum and
minimum values.
</description>
</parameter>
<parameter name="gain" type="double" unit="" default="0.0">
<description>
The gain applied to scale trace amplitudes. 0 disables
showing trace amplitude value
</description>
</parameter>
<parameter name="fixedScale" type="boolean" default="false">
<description>
</description>
</parameter>
<group name="minimum">
<description>
Properties defining the minimum line on each trace.
</description>
<parameter name="value" type="double" default="0.0">
<description>
Value at which to draw a line.
</description>
</parameter>
<group name="pen">
<description>
Line properties.
</description>
<parameter name="width" type="string" default="1">
<description>
</description>
</parameter>
<parameter name="style" type="string" default="solidline">
<description>
</description>
</parameter>
<parameter name="color" type="string" default="000000ff">
<description>
</description>
</parameter>
</group>
<group name="brush">
<description>
Properties of the area below the minimum.
</description>
<parameter name="style" type="string" default="nobrush">
<description>
</description>
</parameter>
<parameter name="color" type="string" default="000000ff">
<description>
</description>
</parameter>
</group>
</group>
<group name="maximum">
<description>
Properties defining the maximum line on each trace.
</description>
<parameter name="value" type="double" default="0.0">
<description>
Value at which to draw a line.
</description>
</parameter>
<group name="pen">
<description>
Line properties.
</description>
<parameter name="width" type="string" default="1" unit="">
<description>
</description>
</parameter>
<parameter name="style" type="string" default="solidline">
<description>
</description>
</parameter>
<parameter name="color" type="string" default="000000ff">
<description>
</description>
</parameter>
</group>
<group name="brush">
<description>
Properties of the area above the maximum.
</description>
<parameter name="style" type="string" default="nobrush">
<description>
</description>
</parameter>
<parameter name="color" type="string" default="000000ff">
<description>
</description>
</parameter>
</group>
</group>
</struct>
</group>
</group>
<group name="associator">
<description>
Define parameters for manually associating phases to origin and
for locating the origins.
</description>
<parameter name="defaultLocator" type="string">
<description>
The locator which is activated as default locator.
</description>
</parameter>
<parameter name="defaultLocatorProfile" type="string">
<description>
The locator profile which is activated as default profile for
the default locator.
</description>
</parameter>
<parameter name="fixedDepths" type="list:double" unit="km" default="0, 10, 18">
<description>
A list of depths used to populate the locator depth selection
dropdown list.
</description>
</parameter>
</group>
<group name="spectrogram">
<description>
Define parameters for spectrogram representation.
</description>
<parameter name="smoothing" type="boolean" default="false">
<description>
Whether to plot the spectrogram filtered bilinearily.
</description>
</parameter>
<parameter name="logScale" type="boolean" default="false">
<description>
Whether to use logarithmic frequency scale.
</description>
</parameter>
<parameter name="normalization" type="string" default="fixed">
<description>
Which amplitude normalization mode to use: &quot;fixed&quot;,
&quot;frequency&quot; or &quot;time&quot;.
</description>
</parameter>
<parameter name="axis" type="boolean" default="false">
<description>
Whether to show the frequency axis.
</description>
</parameter>
<parameter name="minimumAmplitude" type="double" default="-15" unit="log(ps)">
<description>
The lower bound of the static amplitude range give as logarithm of
the power spectrum (log(real**2 + imag**2)).
</description>
</parameter>
<parameter name="maximumAmplitude" type="double" default="-5" unit="log(ps)">
<description>
The upper bound of the static amplitude range give as logarithm of
the power spectrum (log(real**2 + imag**2)).
</description>
</parameter>
<parameter name="minimumFrequency" type="double" default="0" unit="Hz">
<description>
The lower bound of the frequency to be shown.
</description>
</parameter>
<parameter name="maximumFrequency" type="double" default="0" unit="Hz">
<description>
The upper bound of the frequency to be shown. Zero is a special
value and means &quot;auto&quot; and sets the maximum
frequency from the spectra.
</description>
</parameter>
<parameter name="timeSpan" type="double" default="20" unit="s">
<description>
The time span of each data slice used to compute the
frequency spectrum.
</description>
</parameter>
<parameter name="overlap" type="double" default="0.5">
<description>
The overlap of the data time window between zero and one
(exclusive).
</description>
</parameter>
</group>
</configuration>
<command-line>
<synopsis>
scrttv [options] [miniSEED file]
</synopsis>
<group name="Generic">
<optionReference>generic#help</optionReference>
<optionReference>generic#version</optionReference>
<optionReference>generic#config-file</optionReference>
<optionReference>generic#plugins</optionReference>
<optionReference>generic#auto-shutdown</optionReference>
<optionReference>generic#shutdown-master-module</optionReference>
<optionReference>generic#shutdown-master-username</optionReference>
<optionReference>generic#print-config-vars</optionReference>
<optionReference>generic#validate-schema-params</optionReference>
<optionReference>generic#dump-settings</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>
<optionReference>verbosity#print-context</optionReference>
<optionReference>verbosity#print-component</optionReference>
<optionReference>verbosity#log-utc</optionReference>
<optionReference>verbosity#trace</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="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="Options">
<option flag="i" long-flag="input-file" argument="xml">
<description>Load picks in given XML file during startup</description>
</option>
</group>
<group name="Mode">
<option long-flag="filter" argument="arg" publicID="mode#filter" param-ref="filter"/>
<option long-flag="offline" argument="" publicID="mode#offline">
<description>
Do not connect to a messaging server and do not use the
database.
</description>
</option>
<option long-flag="no-inventory" argument="" publicID="mode#no-inventory">
<description>
Do not read streams from inventory but display all streams
available from the specified record source. This option may
be combined with the streams.codes parameter to filter the
available streams.
</description>
</option>
<option long-flag="end-time" argument="arg" publicID="mode#end-time">
<description>
Set the acquisition end time, e.g. '2017-09-08 13:30:00',
default: 'gmt'.
</description>
</option>
<option flag="" long-flag="buffer-size" argument="arg" param-ref="bufferSize" publicID="mode#buffer-size"/>
<option long-flag="max-delay" argument="arg" param-ref="maxDelay" publicID="mode#max-delay"/>
<option long-flag="start-at-now" argument="" publicID="mode#start-at-now">
<description>
Subscribe to data starting at now rather than now - bufferSize
</description>
</option>
<option long-flag="rt" argument="" publicID="mode#rt">
<description>
Do not ask for time window at data server. This might be
important if e.g. Seedlink does not allow time window
extraction.
</description>
</option>
<option long-flag="map-picks" argument="" param-ref="mapPicks" publicID="mode#map-picks"/>
<option flag="" long-flag="3c" argument="" param-ref="3c"/>
<option long-flag="channels" argument="" publicID="mode#channels">
<description>
Channel(s) to display. The channel code may contain wildcards
at any position but the support of wildcards depends on
RecordStream. Repeat the option for multiple
channel groups. Examples:
default : all streams configured by global bindings.
GE.*.*.HH? : all HH channels of all stations from GE network.
</description>
</option>
</group>
<group name="Cities">
<optionReference>cities#city-xml</optionReference>
</group>
<group name="User interface">
<optionReference>gui#full-screen</optionReference>
<optionReference>gui#non-interactive</optionReference>
</group>
</command-line>
</module>
</seiscomp>