scgof#
Geographic origin filter.
Description#
scgof is released under the GNU Affero General Public License (Free Software Foundation, version 3 or later). It filters origins based on their epicenter locations, and keeps only those within a region defined in BNA files, and configured in a filter profile with a matching creation author. The origin filtering procedure is as follows:
Listen to origins received from groups defined in connection.subscriptions.
For each origin, check if the author and location match any of the filters configured with author, and a region.
If the origin checks the previous, transfer the origin to the messaging group defined in connection.primaryGroup.
Note
Inappropriate origins are still recorded in the database, they are only discarded for event association.
It requires to setup modules creating the origins to be filtered, with a dedicated messaging group, e.g.:
connection.primaryGroup = LOCATION_A
Following the same example, you might add the group “LOCATION_A” to the
default message groups defined by scmaster in scmaster.cfg
:
msgGroups = LOCATION_A, ...
and let scgof listen to the messages to the “LOCATION_A” group.
Adjust scgof.cfg
:
connection.subscriptions = LOCATION_A
Configuration#
etc/defaults/global.cfg
etc/defaults/scgof.cfg
etc/global.cfg
etc/scgof.cfg
~/.seiscomp/global.cfg
~/.seiscomp/scgof.cfg
scgof inherits global options.
- bnaFile#
Type: list:string
The BNA file defining regions (closed polygons) for each filter. BNA file might be defined and extended interactively in the map of scolv or scmv. Default is
@DATADIR@/bna/custom.bna
.
- profiles#
Type: list:string
The list of origin filters. Default is
none
.
Note
profile.* Parameters of each geographic origin filter.
Note
profile.$name.*
$name is a placeholder for the name to be used and needs to be added to profiles
to become active.
profiles = a,b
profile.a.value1 = ...
profile.b.value1 = ...
# c is not active because it has not been added
# to the list of profiles
profile.c.value1 = ...
- profile.$name.author#
Type: string
Origin creation author to allow origins for. Only the author name is considered (not the hostname). Default is
none
.
- profile.$name.region#
Type: string
Region (closed polygon) where to allow origins. All regions should be defined in "bnaFile". Default is
none
.