scevent¶
Associates an Origin to an Event or forms a new Event if no match is found. Selects the preferred magnitude.
Description¶
As a consequence of a real-time system the SeisComP3 system creates several origins (results of localization processes) for one earthquake because as time goes by more seismic phases are available. scevent receives these origins and associates the origins to events. It is also possible to import origins from other agencies.
Origin Matching¶
scevent associates origins to events by searching for the best match of the new (incoming) origin to other origins for existing events. If a match is not found a new event can be formed. The new origin is matched to existing origins by comparing differences in the horizontal components of the locations, origin time difference, and matching picks. The new origin is matched to an existing origin which has the highest rank in the following three groups (1, 2, 3):
Location and Time (lowest)
The difference in horizontal location is less than
eventAssociation.maximumDistance
(degrees) and the difference in origin times is less thaneventAssociation.maximumTimeSpan
.Picks
The two origins have more than
eventAssociation.minimumMatchingArrivals
matching picks. Picks are matched either by ID or by time depending oneventAssociation.maximumMatchingArrivalTimeDiff
.Picks and Location and Time (highest)
This is the best match, for which both the location-and-time and picks criteria above are satisfied.
If more than one origin is found in the highest ranking class, then the first one of them is chosen.
Note
For efficiency events in the cache are scanned first and if no matches are found
the database is scanned for the time window eventAssociation.eventTimeBefore
- eventAssociation.eventTimeAfter
around the incoming Origin time. The cached events are ordered by eventID and
thus in time.
No Origin Match
If no event with an origin that matches the incoming origin is found then a new event is formed and the origin is associated to that event. The following criteria are applied to allow the creation of the new event:
The agency for the origin is not black listed (processing.blacklist.agencies).
and
If the origin is an automatic then it has more than eventAssociation.minimumDefiningPhases picks.
Plugins¶
-
evrc plugin for scevent
Configuration¶
etc/defaults/global.cfg
etc/defaults/scevent.cfg
etc/global.cfg
etc/scevent.cfg
~/.seiscomp3/global.cfg
~/.seiscomp3/scevent.cfg
scevent inherits global options.
-
eventIDPrefix
¶ Type: string
Prefix for all Event IDs
-
eventIDPattern
¶ Type: string
Defines the pattern to generate an event ID.
%p : prefix
%Y : year
%[w]c: alpha character
%[w]C: upper case alpha character
%[w]d: decimal
%[w]x: hexadecimal
%[w]X: upper case hexadecimal
[w] is an optional width parameter. Default is
%p%Y%04c
.
-
processing.blacklist.eventIDs
¶ Type: list:string
Defines a blacklist of event ids. The items of this list are only matches against %c, %C, %d, %x and %X of the eventIDPattern description. Year (%Y) and prefix (%p) are not matched. The match is case-sensitive, so blacklisting e.g. abcd would only match in combination with %c. If %C is used ABCD has to be blacklisted.
-
eventAssociation.minimumMagnitudes
¶ Type: int
Minimum number of station magnitudes referenced to a network magnitude to become a preferred magnitude. Default is
4
.
-
eventAssociation.minimumMatchingArrivals
¶ Type: int
Minimum number of matching picks between two origins to be associated to the same event. Default is
3
.
-
eventAssociation.maximumMatchingArrivalTimeDiff
¶ Type: double
Unit: s
Negative time window: compare only pickIDs to find matching arrivals. A non negative value (including 0) compares pick times regardless of the pickID. Pass: |pick1.time - pick2.time| <= threshold Default is
-1
.
-
eventAssociation.compareAllArrivalTimes
¶ Type: boolean
This parameter is only used in conjunction with eventAssociation.maximumMatchingArrivalTimeDiff. If a station has multiple associated arrivals for a particular event, this flag defines if the time distance of a new pick to all arrivals must be within eventAssociation.maximumMatchingArrivalTimeDiff or if one matching arrival is enough. Default is
true
.
-
eventAssociation.allowLooseAssociatedArrivals
¶ Type: boolean
Allows to match picks that are associated with weight 0. Default is
false
.
-
eventAssociation.minimumDefiningPhases
¶ Type: int
Minimum number of Picks for an Origin that is automatic and cannot be associated with an Event to be allowed to form an new Event. Default is
10
.
-
eventAssociation.minimumScore
¶ Type: double
Minimum score of an automatic origin to be allowed to form an new Event. This requires an activated score plugin and a score processor. Configure score for defining the score processor and the score processor parameters. If minimumScore is defined, minimumDefiningPhases has no effect at as this phase check will be superseded by the score check. It is the task of the score processor to evaluate a proper score for all input origins.
-
eventAssociation.eventTimeBefore
¶ Type: double
Unit: s
Time range before the origin time of an incoming origin to search for matching events. Default is
1800
.
-
eventAssociation.eventTimeAfter
¶ Type: double
Unit: s
Time range after the origin time of an incoming origin to search for matching events. Default is
1800
.
-
eventAssociation.maximumTimeSpan
¶ Type: double
Unit: s
Associates an origin with an existing event if the origin time differs not more than 60 seconds unless the minimumMatchingArrivals criteria matches. Default is
60
.
-
eventAssociation.maximumDistance
¶ Type: double
Unit: degrees
Allowed location difference between an incoming origin compared with preferred origins to get associated. Default is
5
.
-
eventAssociation.minMwCount
¶ Type: int
Minimum number of station magnitudes required for Mw(mB) to be considered as preferred magnitude. Default is
8
.
-
eventAssociation.mbOverMwCount
¶ Type: int
Minimum number of station magnitudes which ensures that Mw(mB) will be preferred and not mb. Default is
30
.
-
eventAssociation.mbOverMwValue
¶ Type: double
Average between mb and Mw(mB) which must be exceeded to become Mw(mB) preferred. Default is
6
.
-
eventAssociation.enableFallbackMagnitude
¶ Type: boolean
If true, one magnitude will be preferred even if magnitude criteria are not fullfilled. Default is
false
.
-
eventAssociation.ignoreFMDerivedOrigins
¶ Type: boolean
Defines whether to associate or to ignore origins derived from CMT/MT inversions. Default is
true
.
-
eventAssociation.declareFakeEventForRejectedOrigin
¶ Type: boolean
If the preferred origin has evaluation status ‘rejected’ the event type will be set as ‘not existing’ unless the event type has been fixed by an operator or the preferred origin has been fixed. Default is
false
.
-
eventAssociation.magTypes
¶ Type: list:string
Magnitude type priority list for becoming a preferred magnitude for an event. Default is
mBc, Mw(mB), Mwp, ML, MLh, MLv, mb
.
-
eventAssociation.agencies
¶ Type: list:string
The agencyID priority list. When the eventtool comes to the point to select a preferred origin it orders all origins by its agency priority and selects then the best one among the highest priority agency. It also defines the agency priority for custom priority checks (eventAssociation.priorities).
Type: list:string
The author priority list. When the eventtool comes to the point to select a preferred origin it orders all origins by its author priority and selects then the best one among the highest priority author. It also defines the author priority for custom priority checks (eventAssociation.priorities).
-
eventAssociation.methods
¶ Type: list:string
The method priority list. When the eventtool comes to the point to select a preferred origin it orders all origins by its methodID priority and selects then the best one among the highest priority method. It also defines the method priority for custom priority checks (eventAssociation.priorities). A defined method string must match exactly the string in Origin.methodID.
-
eventAssociation.score
¶ Type: string
Defines the ScoreProcessor interface to be used along with priority “SCORE”.
-
eventAssociation.priorities
¶ Type: list:string
The general priority list to decide if an origin becomes preferred. The priority decreases in the order of the parameters. This list is not used unless this parameter is activated.
Empty priority list: scevent replicates the default hard wired behaviour: AGENCY, STATUS, PHASES_AUTOMATIC, TIME_AUTOMATIC
Each item in the list corresponds to a check that is performed. Each check computes a score of the incoming origin (s1) and the current preferred origin (s2). If the s1 is lower than s2, the incoming origin is rejected and does not become preferred. All subsequent checks are ignored. If s1 is equal to s2, the next check in the list is performed. If s1 is larger than s2, the origin becomes preferred and all subsequent checks are ignored.
Available tokens:
AGENCY: check based on agency priorities
AUTHOR: check based on author priorities
MODE: evaluation mode priority: 0 = unset, 1 = automatic, 2 = manual, manual over-rules automatic
STATUS: priority combined from evaluation status and evaluation mode: -100 = status is rejected, -1 = status is reported, 0 = status is preliminary or status is unset and mode is automatic, 1 = status is confirmed or status is unset and mode is manual, 2 = status is reviewed, 3 = status is final,
METHOD: check based on the method priorities
PHASES: higher phase count = higher priority
PHASES_AUTOMATIC: only checks phase priorities for incoming automatic origins
RMS: lower rms = higher priority
RMS_AUTOMATIC: only check RMS on incoming automatic origins
TIME: more recent origins (creationTime) have higher priorities
TIME_AUTOMATIC: only check creationTime priority on incoming automatic origins
SCORE: evaluates the score according to a configured ScoreProcessor and prefers the origin/focalmechanism with the highest score
-
eventAssociation.delayTimeSpan
¶ Type: int
Unit: s
Configures a timespan to delay event creation. If a new origin arrives which cannot be associated to an existing event, delay the event creation for a certain timespan.
-
eventAssociation.region.rect
¶ Type: string
Region in which scevent is allowed to create events.
-
eventAssociation.region.minDepth
¶ Type: double
Unit: km
Minimum depth for which scevent is allowed to create events.
-
eventAssociation.region.maxDepth
¶ Type: double
Unit: km
Maximum depth for which scevent is allowed to create events.
Note
eventAssociation.delayFilter.* The delayFilter group configures an origin filter to activate the delay feature for this origin. If more than one filter is given they are combined with AND.
-
eventAssociation.delayFilter.agencyID
¶ Type: string
The agencyID of the origin to be delayed.
Type: string
The author of the origin to be delayed.
-
eventAssociation.delayFilter.evaluationMode
¶ Type: string
The evaluation mode of the origin to be delayed. Can be either “manual” or “automatic”.
RegionCheck extension¶
evrc plugin for scevent
Note
rc.* Test if events lie within or outside a region. Events within a region are flagged as positive, outside as negative. The event type is set accordingly. Add the plugin “evrc” to the plugins parameter to make this feature available.
-
rc.regions
¶ Type: list:string
The list of closed BNA polygon names defining regions for flagging event as positive or negative. A polygon name defines a positive region but names with prefix ! (exclamation mark) define negative regions. Evaluation is done in the order of the polygons. The last matching criteria applies and the event type is set accordingly.
Default: If events are not positive or are negative regions the event type is set to “outside of network interest”. Default: “!reject”, use “accecpt” to overwrite the default.
Examples:
Events are flagged positive within the polygon “germany”:
germany
All events are flagged positive but events within the polygon “quarries” are negative:
accept,!quarries
Events within the polygon “germany” are flagged positive but all other events and events within the polygon “quarries” are negaitve:
germany,!quarries
All events are flagged positive but events within the polygon “germany” are negative and all events within the polygon “saxony” are positive:
accept,!germany,saxony Default is
!reject
.
-
rc.readEventTypeFromBNA
¶ Type: boolean
Read the event type, minDepth and maxDepth from the BNA polygon header. The header may contain the values, e.g. header of a polygon with name “quarry”:
“quarry”,”rank 1”,”eventType: quarry blast, minDepth: -5, maxDepth: 10”,13
When eventType is set, it superseeds eventTypePositive and eventTypeNegative. When not set, eventTypePositive and eventTypeNegative are considered. Default is
false
.
-
rc.eventTypePositive
¶ Type: string
New type of an event which is flagged positive. Ignored if readEventTypeFromBNA is active.
Empty: Do not set type
-
rc.eventTypeNegative
¶ Type: string
New type of an event which is flagged negative. Ignored if readEventTypeFromBNA is active.
Empty means default: “outside of network interest” Default is
"outside of network interest"
.
Command-line¶
Generic¶
-
-h
,
--help
¶
show help message.
-
-V
,
--version
¶
show version information
-
--config-file
arg
¶ Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick -> scautopick2.
-
--plugins
arg
¶ Load given plugins.
-
-D
,
--daemon
¶
Run as daemon. This means the application will fork itself and doesn’t need to be started with &.
-
--auto-shutdown
arg
¶ Enable/disable self-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message (enabled with –start-stop-msg for the master module).
-
--shutdown-master-module
arg
¶ Sets the name of the master-module used for auto-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application.
-
--shutdown-master-username
arg
¶ Sets the name of the master-username of the messaging used for auto-shutdown. If “shutdown-master-module” is given as well this parameter is ignored.
-
-x
,
--expiry
time
¶ Time span in hours after which objects expire.
-
-O
,
--origin-id
publicID
¶ OriginID to be associated. When given no messages are sent. Only the status of the association is written to stdout.
Verbosity¶
-
--verbosity
arg
¶ Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
-
-v
,
--v
¶
Increase verbosity level (may be repeated, eg. -vv)
-
-q
,
--quiet
¶
Quiet mode: no logging output
-
--component
arg
¶ Limits the logging to a certain component. This option can be given more than once.
-
-s
,
--syslog
¶
Use syslog logging back end. The output usually goes to /var/lib/messages.
-
-l
,
--lockfile
arg
¶ Path to lock file.
-
--console
arg
¶ Send log output to stdout.
-
--debug
¶
Debug mode: –verbosity=4 –console=1
-
--log-file
arg
¶ Use alternative log file.
Messaging¶
-
-u
,
--user
arg
¶ Overrides configuration parameter
connection.username
.
-
-H
,
--host
arg
¶ Overrides configuration parameter
connection.server
.
-
-t
,
--timeout
arg
¶ Overrides configuration parameter
connection.timeout
.
-
-g
,
--primary-group
arg
¶ Overrides configuration parameter
connection.primaryGroup
.
-
-S
,
--subscribe-group
arg
¶ A group to subscribe to. This option can be given more than once.
-
--encoding
arg
¶ Overrides configuration parameter
connection.encoding
.
-
--start-stop-msg
arg
¶ Sets sending of a start- and a stop message.
Database¶
-
--db-driver-list
¶
List all supported database drivers.
-
-d
,
--database
arg
¶ The database connection string, format: service://user:pwd@host/database. “service” is the name of the database driver which can be queried with “–db-driver-list”.
-
--config-module
arg
¶ The configmodule to use.
-
--inventory-db
arg
¶ Load the inventory from the given database or file, format: [service://]location
-
--db-disable
¶
Do not use the database at all