Changeset 86026a0

Timestamp:

Mar 24, 2017, 2:55:22 AM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler

Children:

62a94b7

Parents:

af98cb8

Message:

python/lib/aubio/cmd.py: improve descriptions

File:

• python/lib/aubio/cmd.py (modified) (7 diffs)

python/lib/aubio/cmd.py

@@ -25 +25 @@
     # onset subcommand
     subparser = subparsers.add_parser('onset',
-            help='get onset times',
+            help='estimate time of onsets (beginning of sound event)',
             formatter_class = argparse.ArgumentDefaultsHelpFormatter)
     parser_add_input(subparser)
@@ -41 +41 @@
     # pitch subcommand
     subparser = subparsers.add_parser('pitch',
-            help='extract fundamental frequency')
+            help='estimate fundamental frequency (monophonic)')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser, buf_size=2048)
@@ -52 +52 @@
     subparser.set_defaults(process=process_pitch)
 
-    # tempo subcommand
+    # beat subcommand
     subparser = subparsers.add_parser('beat',
-            help='get locations of beats')
+            help='estimate location of beats')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser, buf_size=1024, hop_size=512)
@@ -63 +63 @@
     # tempo subcommand
     subparser = subparsers.add_parser('tempo',
-            help='get overal tempo in bpm')
+            help='estimate overall tempo in bpm')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser, buf_size=1024, hop_size=512)
@@ -72 +72 @@
     # notes subcommand
     subparser = subparsers.add_parser('notes',
-            help='get midi-like notes')
+            help='estimate midi-like notes (monophonic)')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser)
@@ -81 +81 @@
     # mfcc subcommand
     subparser = subparsers.add_parser('mfcc',
-            help='extract mel-frequency cepstrum coefficients')
+            help='extract Mel-Frequency Cepstrum Coefficients')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser)
@@ -90 +90 @@
     # melbands subcommand
     subparser = subparsers.add_parser('melbands',
-            help='extract mel-frequency energies per band')
+            help='extract energies in Mel-frequency bands')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser)