Commit 54e4e1a1 authored by Oliver Kirsebom's avatar Oliver Kirsebom
Browse files

updated readme

parent bddc7453
......@@ -140,7 +140,7 @@ Transform (STFT) of the audio data, searches for narrow peaks, and reports a boa
peaks are found. The peak search algorithm is similar, though not identical, to the one described in
[this paper](https://doi.org/10.1111/2041-210X.13245).
The performance of the FAV detector can be optimized by adjustable the parameters found in the [fav.json](detectors/fav.json)
The performance of the FAV detector can be optimized by adjusting the parameters found in the [fav.json](detectors/fav.json)
configuration files. While this file contains many parameters, the most relevant are the `threshold` parameter (found in
the `fav_config` section) and the `height` parameter (found in the `detect_config` section). The former determines how sharp and tall
a frequency peak must be to be counted as a peak, while the latter determines how many such peaks must be present at given
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment