Mercurial > hg > auditok

changeset 30:e32c7c349af6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge branch 'master' of https://github.com/amsehili/auditok Conflicts: README.md
author Amine Sehili <amine.sehili@gmail.com>
date Sun, 29 Nov 2015 11:56:24 +0100
parents 9699fc1478a5 (current diff) 2562d19b5781 (diff)
children 77f218f8b9d7
files README.md
diffstat 1 files changed, 25 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Sun Nov 29 11:54:36 2015 +0100
+++ b/README.md	Sun Nov 29 11:56:24 2015 +0100
@@ -172,9 +172,15 @@
 ### Plot signal and detections:
 
 use option `-p`. Requires `matplotlib` and `numpy`.
+<<<<<<< HEAD
 
     auditok ...  -p
 
+=======
+
+    auditok ...  -p
+
+>>>>>>> 78ccd74544ffc6f8a251dbcdf9b7019d559a3655
 ### Save plot as image or PDF
 
     auditok ...  --save-image output.png
@@ -210,6 +216,7 @@
     
 Install `pydub` for more audio formats.
 
+<<<<<<< HEAD
 
 Setting detection parameters
 ----------------------------
@@ -226,6 +233,24 @@
 | `-d`   | Drop trailing silence from an accepted audio activity | boolean |   False          |
 | `-a`   | Analysis window length (default value should be good) | second  |   0.01 (10 ms)   |
 
+=======
+
+Setting detection parameters
+----------------------------
+
+Alongside the threshold option `-e` seen so far, a couple of other options can have a great impact on the detector behavior. These options are summarized in the following table:
+
+
+| Option | Description                                           | Unit    | Default          |
+| -------|-------------------------------------------------------|---------|------------------|
+| `-n`   | Minimum length an accepted audio activity should have | second  |   0.2 (200 ms)   |
+| `-m`   | Maximum length an accepted audio activity should reach| second  |   5.             |
+| `-s`   | Maximum length of a continuous silence period within  | second  |   0.3 (300 ms)   |
+|        | an accepted audio activity                            |         |                  |
+| `-d`   | Drop trailing silence from an accepted audio activity | boolean |   False          |
+| `-a`   | Analysis window length (default value should be good) | second  |   0.01 (10 ms)   |
+
+>>>>>>> 78ccd74544ffc6f8a251dbcdf9b7019d559a3655
 
 License
 -------