History

[py] add get_norm/power and documentation to filterbank

Paul Brossier committed 7 years ago

Commit e5efa0f1 parent e14f7a71 file · +209 −9Browse files

Showing the changes to python (1 of 1 file). Show all

Unified · Split

python/ext/py-filterbank.c+209−9
@@ -1,6 +1,188 @@
11 #include "aubio-types.h"
22
3−static char Py_filterbank_doc[] = "filterbank object";
3+static char Py_filterbank_doc[] = ""
4+"filterbank(n_filters=40, win_s=1024)\n"
5+"\n"
6+"Create a bank of spectral filters. Each instance is a callable\n"
7+"that holds a matrix of coefficients.\n"
8+"\n"
9+"See also :meth:`set_mel_coeffs`, :meth:`set_mel_coeffs_htk`,\n"
10+":meth:`set_mel_coeffs_slaney`, :meth:`set_triangle_bands`, and\n"
11+":meth:`set_coeffs`.\n"
12+"\n"
13+"Parameters\n"
14+"----------\n"
15+"n_filters : int\n"
16+" Number of filters to create.\n"
17+"win_s : int\n"
18+" Size of the input spectrum to process.\n"
19+"\n"
20+"Examples\n"
21+"--------\n"
22+">>> f = aubio.filterbank(128, 1024)\n"
23+">>> f.set_mel_coeffs(44100, 0, 10000)\n"
24+">>> c = aubio.cvec(1024)\n"
25+">>> f(c).shape\n"
26+"(128, )\n"
27+"";
28+
29+static char Py_filterbank_set_triangle_bands_doc[] =""
30+"set_triangle_bands(freqs, samplerate)\n"
31+"\n"
32+"Set triangular bands. The coefficients will be set to triangular\n"
33+"overlapping windows using the boundaries specified by `freqs`.\n"
34+"\n"
35+"`freqs` should contain `n_filters + 2` frequencies in Hz, ordered\n"
36+"by value, from smallest to largest. The first element should be greater\n"
37+"or equal to zero; the last element should be smaller or equal to\n"
38+"`samplerate / 2`.\n"
39+"\n"
40+"Parameters\n"
41+"----------\n"
42+"freqs: fvec\n"
43+" List of frequencies, in Hz.\n"
44+"samplerate : float\n"
45+" Sampling-rate of the expected input.\n"
46+"\n"
47+"Example\n"
48+"-------\n"
49+">>> fb = aubio.filterbank(n_filters=100, win_s=2048)\n"
50+">>> samplerate = 44100; freqs = np.linspace(0, 20200, 102)\n"
51+">>> fb.set_triangle_bands(aubio.fvec(freqs), samplerate)\n"
52+"";
53+
54+static char Py_filterbank_set_mel_coeffs_slaney_doc[] = ""
55+"set_mel_coeffs_slaney(samplerate)\n"
56+"\n"
57+"Set coefficients of filterbank to match Slaney's Auditory Toolbox.\n"
58+"\n"
59+"The filter coefficients will be set as in Malcolm Slaney's\n"
60+"implementation. The filterbank should have been created with\n"
61+"`n_filters = 40`.\n"
62+"\n"
63+"This is approximately equivalent to using :meth:`set_mel_coeffs` with\n"
64+"`fmin = 400./3., fmax = 6853.84`.\n"
65+"\n"
66+"Parameters\n"
67+"----------\n"
68+"samplerate : float\n"
69+" Sampling-rate of the expected input.\n"
70+"\n"
71+"References\n"
72+"----------\n"
73+"\n"
74+"Malcolm Slaney, `Auditory Toolbox Version 2, Technical Report #1998-010\n"
75+"<https://engineering.purdue.edu/~malcolm/interval/1998-010/>`_\n"
76+"";
77+
78+static char Py_filterbank_set_mel_coeffs_doc[] = ""
79+"set_mel_coeffs(samplerate, fmin, fmax)\n"
80+"\n"
81+"Set coefficients of filterbank to linearly spaced mel scale.\n"
82+"\n"
83+"Parameters\n"
84+"----------\n"
85+"samplerate : float\n"
86+" Sampling-rate of the expected input.\n"
87+"fmin : float\n"
88+" Lower frequency boundary of the first filter.\n"
89+"fmax : float\n"
90+" Upper frequency boundary of the last filter.\n"
91+"\n"
92+"See also\n"
93+"--------\n"
94+"hztomel\n"
95+"";
96+
97+static char Py_filterbank_set_mel_coeffs_htk_doc[] = ""
98+"set_mel_coeffs_htk(samplerate, fmin, fmax)\n"
99+"\n"
100+"Set coefficients of the filters to be linearly spaced in the HTK mel scale.\n"
101+"\n"
102+"Parameters\n"
103+"----------\n"
104+"samplerate : float\n"
105+" Sampling-rate of the expected input.\n"
106+"fmin : float\n"
107+" Lower frequency boundary of the first filter.\n"
108+"fmax : float\n"
109+" Upper frequency boundary of the last filter.\n"
110+"\n"
111+"See also\n"
112+"--------\n"
113+"hztomel with `htk=True`\n"
114+"";
115+
116+static char Py_filterbank_get_coeffs_doc[] = ""
117+"get_coeffs()\n"
118+"\n"
119+"Get coefficients matrix of filterbank.\n"
120+"\n"
121+"Returns\n"
122+"-------\n"
123+"array_like\n"
124+" Array of shape (n_filters, win_s/2+1) containing the coefficients.\n"
125+"";
126+
127+static char Py_filterbank_set_coeffs_doc[] = ""
128+"set_coeffs(coeffs)\n"
129+"\n"
130+"Set coefficients of filterbank.\n"
131+"\n"
132+"Parameters\n"
133+"----------\n"
134+"coeffs : fmat\n"
135+" Array of shape (n_filters, win_s/2+1) containing the coefficients.\n"
136+"";
137+
138+static char Py_filterbank_set_power_doc[] = ""
139+"set_power(power)\n"
140+"\n"
141+"Set power applied to input spectrum of filterbank.\n"
142+"\n"
143+"Parameters\n"
144+"----------\n"
145+"power : float\n"
146+" Power to raise input spectrum to before computing the filters.\n"
147+"";
148+
149+static char Py_filterbank_get_power_doc[] = ""
150+"get_power()\n"
151+"\n"
152+"Get power applied to filterbank.\n"
153+"\n"
154+"Returns\n"
155+"-------\n"
156+"float\n"
157+" Power parameter.\n"
158+"";
159+
160+static char Py_filterbank_set_norm_doc[] = ""
161+"set_norm(norm)\n"
162+"\n"
163+"Set norm parameter. If set to `0`, the filters will not be normalized.\n"
164+"If set to `1`, the filters will be normalized to one. Default to `1`.\n"
165+"\n"
166+"This function should be called *before* :meth:`set_triangle_bands`,\n"
167+":meth:`set_mel_coeffs`, :meth:`set_mel_coeffs_htk`, or\n"
168+":meth:`set_mel_coeffs_slaney`.\n"
169+"\n"
170+"Parameters\n"
171+"----------\n"
172+"norm : int\n"
173+" `0` to disable, `1` to enable\n"
174+"";
175+
176+static char Py_filterbank_get_norm_doc[] = ""
177+"get_norm()\n"
178+"\n"
179+"Get norm parameter of filterbank.\n"
180+"\n"
181+"Returns\n"
182+"-------\n"
183+"float\n"
184+" Norm parameter.\n"
185+"";
4186
5187 typedef struct
6188 {
@@ -288,6 +470,13 @@ Py_filterbank_set_power(Py_filterbank *self, PyObject *args) · 281 unmodified lines
288470 Py_RETURN_NONE;
289471 }
290472
473+static PyObject *
474+Py_filterbank_get_power (Py_filterbank * self, PyObject *unused)
475+{
476+ smpl_t power = aubio_filterbank_get_power(self->o);
477+ return (PyObject *)PyFloat_FromDouble (power);
478+}
479+
291480 static PyObject *
292481 Py_filterbank_set_norm(Py_filterbank *self, PyObject *args)
293482 {
@@ -311,23 +500,34 @@ Py_filterbank_set_norm(Py_filterbank *self, PyObject *args) · 17 unmodified lines
311500 Py_RETURN_NONE;
312501 }
313502
503+static PyObject *
504+Py_filterbank_get_norm (Py_filterbank * self, PyObject *unused)
505+{
506+ smpl_t norm = aubio_filterbank_get_norm(self->o);
507+ return (PyObject *)PyFloat_FromDouble (norm);
508+}
509+
314510 static PyMethodDef Py_filterbank_methods[] = {
315511 {"set_triangle_bands", (PyCFunction) Py_filterbank_set_triangle_bands,
316− METH_VARARGS, "set coefficients of filterbanks"},
512+ METH_VARARGS, Py_filterbank_set_triangle_bands_doc},
317513 {"set_mel_coeffs_slaney", (PyCFunction) Py_filterbank_set_mel_coeffs_slaney,
318− METH_VARARGS, "set coefficients of filterbank as in Auditory Toolbox"},
514+ METH_VARARGS, Py_filterbank_set_mel_coeffs_slaney_doc},
319515 {"set_mel_coeffs", (PyCFunction) Py_filterbank_set_mel_coeffs,
320− METH_VARARGS, "set coefficients of filterbank to linearly spaced mel scale"},
516+ METH_VARARGS, Py_filterbank_set_mel_coeffs_doc},
321517 {"set_mel_coeffs_htk", (PyCFunction) Py_filterbank_set_mel_coeffs_htk,
322− METH_VARARGS, "set coefficients of filterbank to linearly spaced mel scale"},
518+ METH_VARARGS, Py_filterbank_set_mel_coeffs_htk_doc},
323519 {"get_coeffs", (PyCFunction) Py_filterbank_get_coeffs,
324− METH_NOARGS, "get coefficients of filterbank"},
520+ METH_NOARGS, Py_filterbank_get_coeffs_doc},
325521 {"set_coeffs", (PyCFunction) Py_filterbank_set_coeffs,
326− METH_VARARGS, "set coefficients of filterbank"},
522+ METH_VARARGS, Py_filterbank_set_coeffs_doc},
327523 {"set_power", (PyCFunction) Py_filterbank_set_power,
328− METH_VARARGS, "set power applied to filterbank input spectrum"},
524+ METH_VARARGS, Py_filterbank_set_power_doc},
525+ {"get_power", (PyCFunction) Py_filterbank_get_power,
526+ METH_NOARGS, Py_filterbank_get_power_doc},
329527 {"set_norm", (PyCFunction) Py_filterbank_set_norm,
330− METH_VARARGS, "set norm applied to filterbank input spectrum"},
528+ METH_VARARGS, Py_filterbank_set_norm_doc},
529+ {"get_norm", (PyCFunction) Py_filterbank_get_norm,
530+ METH_NOARGS, Py_filterbank_get_norm_doc},
331531 {NULL}
332532 };
333533

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t