Skip to content

Commit

Permalink
Fix READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Syler1984 committed Mar 4, 2022
1 parent 19f59a6 commit 379ab5c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,27 @@ out = predictions_argi.txt
WIP

## Custom models
WIP
WIP

## Advanced search
With flag `--advanced-search` (or option `advanced-search = true` in config file) enabled,
for every _detected event_ (_detected event_ is a combination of closely packed detection with number of events greater or equal
`detections-for-event` parameter value) additional scan will be performed.
This scan could have different threshold and window shift to extract more detailed information about
event.

Note: scan will be performed only on stations on which detections were found (you can change that behaviour).

List of related command line options / parameters:
- `--advanced-search` - enable advanced search
- `--advanced-search-range <number>` - range of search (in seconds) around detected events, default: 30
- `--advanced-search-threshold <threshold>` - threshold for advanced search, could be set just like regular `--threshold`:
with number from 0 to 1.0 or for _p_ and _s_ labels individually, default: 0.9
- `--advanced-search-shift <number>` - window shift for advanced search (in samples), default: 2
- `--advanced-search-combine` - if specified (or set in config: `advanced-search-combine = true`)
will combine all detections in advanced search as single event, otherwise will use normal event combination
method. Without this option enabled, if `advanced-search-range` is larger than `combine-events-range`, advanced search
for a single event could potentially yeild multiple events.
- `--advanced-search-all-stations` - with this option enabled the scan will be performed on full list
of stations (same as for the original scan), otherwise, only stations with detected wave arrivals will be used for
the advanced search.
22 changes: 1 addition & 21 deletions utils/args/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,4 @@ You can write your own functions. Each function takes three variables: `(value,
variables access).
- `key` - current variable index.
Function returns value which is then applied to current variable.
You can also alter existing variable or add new by manipulating `params`.

### 6. Advanced search
With flag `--advanced-search` (or option `advanced-search = true` in config file) enabled,
for every _detected event_ (_detected event_ is a combination of closely packed detection with number of events greater or equal
`detections-for-event` parameter value) additional scan will be performed.
This scan could have different threshold and window shift to extract more detailed information about
event.

Note: that scan will be performed only on stations on which detections were found (you can change that behaviour).

List of related command line options / parameters:
- `--advanced-search` - enable advanced search
- `--advanced-search-range <number>` - range of search (in seconds) around detected events, default: 30
- `--advanced-search-threshold <threshold>` - threshold for advanced search, could be set just like regular `--threshold`:
with number from 0 to 1.0 or for _p_ and _s_ labels individually, default: 0.9
- `--advanced-search-shift <number>` - window shift for advanced search (in samples), default: 2
- `--advanced-search-combine` - if specified (or set in config: `advanced-search-combine = true`)
will combine all detections in advanced search as single event, otherwise will use normal event combination
method. Without this option enabled, if `advanced-search-range` is larger than `combine-events-range`, advanced search
for a single event could potentially yeild multiple events.
You can also alter existing variable or add new by manipulating `params`.

0 comments on commit 379ab5c

Please sign in to comment.