Adding equiripple band reject filter to filter design app.
[debian/gnuradio] / gr-utils / src / python / gr_filter_design.py
1 #!/usr/bin/env python
2
3 try:
4     import scipy
5     from scipy import fftpack
6 except ImportError:
7     print "Please install SciPy to run this script (http://www.scipy.org/)"
8     raise SystemExit, 1
9
10 import sys, os
11 from PyQt4 import Qt, QtCore, QtGui
12 import PyQt4.Qwt5 as Qwt
13 from optparse import OptionParser
14 from gnuradio import gr, blks2, eng_notation
15 from scipy import fftpack
16
17 from pyqt_filter import Ui_MainWindow
18
19 class gr_plot_filter(QtGui.QMainWindow):
20     def __init__(self, qapp, options):
21         QtGui.QWidget.__init__(self, None)
22         self.gui = Ui_MainWindow()
23         self.gui.setupUi(self)
24
25         self.connect(self.gui.filterTypeComboBox,
26                      Qt.SIGNAL("currentIndexChanged(const QString&)"),
27                      self.changed_filter_type)
28         self.connect(self.gui.filterDesignTypeComboBox,
29                      Qt.SIGNAL("currentIndexChanged(const QString&)"),
30                      self.changed_filter_design_type)
31
32         self.connect(self.gui.designButton,
33                      Qt.SIGNAL("released()"),
34                      self.design)
35
36         self.connect(self.gui.tabGroup,
37                      Qt.SIGNAL("currentChanged(int)"),
38                      self.tab_changed)
39
40         self.connect(self.gui.nfftEdit,
41                      Qt.SIGNAL("textEdited(QString)"),
42                      self.nfft_edit_changed)
43
44         self.gui.designButton.setShortcut(QtCore.Qt.Key_Return)
45
46         self.taps = []
47         self.fftdB = []
48         self.fftDeg = []
49         self.groupDelay = []
50         self.nfftpts = int(10000)
51         self.gui.nfftEdit.setText(Qt.QString("%1").arg(self.nfftpts))
52
53         self.gui.lpfPassBandRippleLabel.setVisible(False)
54         self.gui.lpfPassBandRippleEdit.setVisible(False)
55         self.gui.bpfPassBandRippleLabel.setVisible(False)
56         self.gui.bpfPassBandRippleEdit.setVisible(False)
57         self.gui.bnfPassBandRippleLabel.setVisible(False)
58         self.gui.bnfPassBandRippleEdit.setVisible(False)
59         self.gui.hpfPassBandRippleLabel.setVisible(False)
60         self.gui.hpfPassBandRippleEdit.setVisible(False)
61                 
62         # Initialize to LPF
63         self.gui.filterTypeWidget.setCurrentWidget(self.gui.firlpfPage)
64
65         # Set Axis labels
66         self.gui.freqPlot.setAxisTitle(self.gui.freqPlot.xBottom,
67                                        "Frequency (Hz)")
68         self.gui.freqPlot.setAxisTitle(self.gui.freqPlot.yLeft,
69                                        "Magnitude (dB)")
70         self.gui.timePlot.setAxisTitle(self.gui.timePlot.xBottom,
71                                        "Tap number")
72         self.gui.timePlot.setAxisTitle(self.gui.timePlot.yLeft,
73                                        "Amplitude")
74         self.gui.phasePlot.setAxisTitle(self.gui.phasePlot.xBottom,
75                                         "Frequency (Hz)")
76         self.gui.phasePlot.setAxisTitle(self.gui.phasePlot.yLeft,
77                                         "Phase (Radians)")
78         self.gui.groupPlot.setAxisTitle(self.gui.groupPlot.xBottom,
79                                         "Frequency (Hz)")
80         self.gui.groupPlot.setAxisTitle(self.gui.groupPlot.yLeft,
81                                         "Delay (sec)")
82
83         # Set up plot curves
84         self.rcurve = Qwt.QwtPlotCurve("Real")
85         self.rcurve.attach(self.gui.timePlot)
86         self.icurve = Qwt.QwtPlotCurve("Imag")
87         self.icurve.attach(self.gui.timePlot)
88
89         self.freqcurve = Qwt.QwtPlotCurve("PSD")
90         self.freqcurve.attach(self.gui.freqPlot)
91
92         self.phasecurve = Qwt.QwtPlotCurve("Phase")
93         self.phasecurve.attach(self.gui.phasePlot)
94
95         self.groupcurve = Qwt.QwtPlotCurve("Group Delay")
96         self.groupcurve.attach(self.gui.groupPlot)
97
98         # Create zoom functionality for the plots
99         self.timeZoomer = Qwt.QwtPlotZoomer(self.gui.timePlot.xBottom,
100                                             self.gui.timePlot.yLeft,
101                                             Qwt.QwtPicker.PointSelection,
102                                             Qwt.QwtPicker.AlwaysOn,
103                                             self.gui.timePlot.canvas())
104
105         self.freqZoomer = Qwt.QwtPlotZoomer(self.gui.freqPlot.xBottom,
106                                             self.gui.freqPlot.yLeft,
107                                             Qwt.QwtPicker.PointSelection,
108                                             Qwt.QwtPicker.AlwaysOn,
109                                             self.gui.freqPlot.canvas())
110
111         self.phaseZoomer = Qwt.QwtPlotZoomer(self.gui.phasePlot.xBottom,
112                                              self.gui.phasePlot.yLeft,
113                                              Qwt.QwtPicker.PointSelection,
114                                              Qwt.QwtPicker.AlwaysOn,
115                                              self.gui.phasePlot.canvas())
116
117         self.groupZoomer = Qwt.QwtPlotZoomer(self.gui.groupPlot.xBottom,
118                                              self.gui.groupPlot.yLeft,
119                                              Qwt.QwtPicker.PointSelection,
120                                              Qwt.QwtPicker.AlwaysOn,
121                                              self.gui.groupPlot.canvas())
122
123         # Set up pen for colors and line width
124         blue = QtGui.qRgb(0x00, 0x00, 0xFF)
125         blueBrush = Qt.QBrush(Qt.QColor(blue))
126         self.freqcurve.setPen(Qt.QPen(blueBrush, 2))
127         self.rcurve.setPen(Qt.QPen(blueBrush, 2))
128         self.phasecurve.setPen(Qt.QPen(blueBrush, 2))
129         self.groupcurve.setPen(Qt.QPen(blueBrush, 2))
130         
131         self.filterWindows = {"Hamming Window" : gr.firdes.WIN_HAMMING,
132                               "Hann Window" : gr.firdes.WIN_HANN,
133                               "Blackman Window" : gr.firdes.WIN_BLACKMAN,
134                               "Rectangular Window" : gr.firdes.WIN_RECTANGULAR,
135                               "Kaiser Window" : gr.firdes.WIN_KAISER,
136                               "Blackman-harris Window" : gr.firdes.WIN_BLACKMAN_hARRIS}
137
138         self.show()
139
140     def changed_filter_type(self, ftype):
141         strftype = str(ftype.toAscii())
142         if(ftype == "Low Pass"):
143             self.gui.filterTypeWidget.setCurrentWidget(self.gui.firlpfPage)
144         elif(ftype == "Band Pass"):
145             self.gui.filterTypeWidget.setCurrentWidget(self.gui.firbpfPage)
146         elif(ftype == "Complex Band Pass"):
147             self.gui.filterTypeWidget.setCurrentWidget(self.gui.firbpfPage)
148         elif(ftype == "Band Notch"):
149             self.gui.filterTypeWidget.setCurrentWidget(self.gui.firbnfPage)
150         elif(ftype == "High Pass"):
151             self.gui.filterTypeWidget.setCurrentWidget(self.gui.firhpfPage)
152         elif(ftype == "Root Raised Cosine"):
153             self.gui.filterTypeWidget.setCurrentWidget(self.gui.rrcPage)
154         elif(ftype == "Gaussian"):
155             self.gui.filterTypeWidget.setCurrentWidget(self.gui.gausPage)
156
157         self.design()
158         
159     def changed_filter_design_type(self, design):
160         if(design == "Equiripple"):
161             self.set_equiripple()
162         else:
163             self.set_windowed()
164             
165         self.design()
166
167     def set_equiripple(self):
168         self.equiripple = True
169         self.gui.lpfPassBandRippleLabel.setVisible(True)
170         self.gui.lpfPassBandRippleEdit.setVisible(True)
171         self.gui.bpfPassBandRippleLabel.setVisible(True)
172         self.gui.bpfPassBandRippleEdit.setVisible(True)
173         self.gui.bnfPassBandRippleLabel.setVisible(True)
174         self.gui.bnfPassBandRippleEdit.setVisible(True)
175         self.gui.hpfPassBandRippleLabel.setVisible(True)
176         self.gui.hpfPassBandRippleEdit.setVisible(True)
177         
178     def set_windowed(self):
179         self.equiripple = False
180         self.gui.lpfPassBandRippleLabel.setVisible(False)
181         self.gui.lpfPassBandRippleEdit.setVisible(False)
182         self.gui.bpfPassBandRippleLabel.setVisible(False)
183         self.gui.bpfPassBandRippleEdit.setVisible(False)
184         self.gui.bnfPassBandRippleLabel.setVisible(False)
185         self.gui.bnfPassBandRippleEdit.setVisible(False)
186         self.gui.hpfPassBandRippleLabel.setVisible(False)
187         self.gui.hpfPassBandRippleEdit.setVisible(False)
188         
189     def design(self):
190         ret = True
191         fs,r = self.gui.sampleRateEdit.text().toDouble()
192         ret = r and ret
193         gain,r = self.gui.filterGainEdit.text().toDouble()
194         ret = r and ret
195
196         if(ret):
197             winstr = str(self.gui.filterDesignTypeComboBox.currentText().toAscii())
198             ftype = str(self.gui.filterTypeComboBox.currentText().toAscii())
199
200             if(winstr == "Equiripple"):
201                 designer = {"Low Pass" : self.design_opt_lpf,
202                             "Band Pass" : self.design_opt_bpf,
203                             "Complex Band Pass" : self.design_opt_cbpf,
204                             "Band Notch" : self.design_opt_bnf,
205                             "High Pass" :  self.design_opt_hpf}
206                 taps,r = designer[ftype](fs, gain)
207
208             else:
209                 designer = {"Low Pass" : self.design_win_lpf,
210                             "Band Pass" : self.design_win_bpf,
211                             "Complex Band Pass" : self.design_win_cbpf,
212                             "Band Notch" : self.design_win_bnf,
213                             "High Pass" :  self.design_win_hpf,
214                             "Root Raised Cosine" :  self.design_win_rrc,
215                             "Gaussian" :  self.design_win_gaus}
216                 wintype = self.filterWindows[winstr]
217                 taps,r = designer[ftype](fs, gain, wintype)
218
219             if(r):
220                 print "Number of taps: ", len(taps)
221
222                 self.taps = scipy.array(taps)
223                 self.get_fft(fs, self.taps, self.nfftpts)
224                 self.update_time_curves()
225                 self.update_freq_curves()
226                 self.update_phase_curves()
227                 self.update_group_curves()
228
229     # Filter design functions using a window
230     def design_win_lpf(self, fs, gain, wintype):
231         ret = True
232         pb,r = self.gui.endofLpfPassBandEdit.text().toDouble()
233         ret = r and ret
234         sb,r = self.gui.startofLpfStopBandEdit.text().toDouble()
235         ret = r and ret
236         atten,r = self.gui.lpfStopBandAttenEdit.text().toDouble()
237         ret = r and ret
238
239         if(ret):
240             tb = sb - pb
241             
242             taps = gr.firdes.low_pass_2(gain, fs, pb, tb,
243                                         atten, wintype)
244             return (taps, ret)
245         else:
246             return ([], ret)
247     
248     def design_win_bpf(self, fs, gain, wintype):
249         ret = True
250         pb1,r = self.gui.startofBpfPassBandEdit.text().toDouble()
251         ret = r and ret
252         pb2,r = self.gui.endofBpfPassBandEdit.text().toDouble()
253         ret = r and ret
254         tb,r  = self.gui.bpfTransitionEdit.text().toDouble()
255         ret = r and ret
256         atten,r = self.gui.bpfStopBandAttenEdit.text().toDouble()
257         ret = r and ret
258
259         if(r):
260             taps = gr.firdes.band_pass_2(gain, fs, pb1, pb2, tb,
261                                          atten, wintype)
262             return (taps,r)
263         else:
264             return ([],r)
265
266     def design_win_cbpf(self, fs, gain, wintype):
267         ret = True
268         pb1,r = self.gui.startofBpfPassBandEdit.text().toDouble()
269         ret = r and ret
270         pb2,r = self.gui.endofBpfPassBandEdit.text().toDouble()
271         ret = r and ret
272         tb,r  = self.gui.bpfTransitionEdit.text().toDouble()
273         ret = r and ret
274         atten,r = self.gui.bpfStopBandAttenEdit.text().toDouble()
275         ret = r and ret
276
277         if(r):
278             taps = gr.firdes.complex_band_pass_2(gain, fs, pb1, pb2, tb,
279                                                  atten, wintype)
280             return (taps,r)
281         else:
282             return ([],r)
283
284     def design_win_bnf(self, fs, gain, wintype):
285         ret = True
286         pb1,r = self.gui.startofBnfStopBandEdit.text().toDouble()
287         ret = r and ret
288         pb2,r = self.gui.endofBnfStopBandEdit.text().toDouble()
289         ret = r and ret
290         tb,r  = self.gui.bnfTransitionEdit.text().toDouble()
291         ret = r and ret
292         atten,r = self.gui.bnfStopBandAttenEdit.text().toDouble()
293         ret = r and ret
294
295         if(r):
296             taps = gr.firdes.band_reject_2(gain, fs, pb1, pb2, tb,
297                                            atten, wintype)
298             return (taps,r)
299         else:
300             return ([],r)
301
302     def design_win_hpf(self, fs, gain, wintype):
303         ret = True
304         sb,r = self.gui.endofHpfStopBandEdit.text().toDouble()
305         ret = r and ret
306         pb,r = self.gui.startofHpfPassBandEdit.text().toDouble()
307         ret = r and ret
308         atten,r = self.gui.hpfStopBandAttenEdit.text().toDouble()
309         ret = r and ret
310
311         if(r):
312             tb = pb - sb
313             taps = gr.firdes.high_pass_2(gain, fs, pb, tb,
314                                          atten, wintype)            
315             return (taps,r)
316         else:
317             return ([],r)
318
319     def design_win_rrc(self, fs, gain, wintype):
320         ret = True
321         sr,r = self.gui.rrcSymbolRateEdit.text().toDouble()
322         ret = r and ret
323         alpha,r = self.gui.rrcAlphaEdit.text().toDouble()
324         ret = r and ret
325         ntaps,r = self.gui.rrcNumTapsEdit.text().toInt()
326         ret = r and ret
327
328         if(r):
329             taps = gr.firdes.root_raised_cosine(gain, fs, sr,
330                                                 alpha, ntaps)
331             return (taps,r)
332         else:
333             return ([],r)
334
335     def design_win_gaus(self, fs, gain, wintype):
336         ret = True
337         sr,r = self.gui.gausSymbolRateEdit.text().toDouble()
338         ret = r and ret
339         bt,r = self.gui.gausBTEdit.text().toDouble()
340         ret = r and ret
341         ntaps,r = self.gui.gausNumTapsEdit.text().toInt()
342         ret = r and ret
343
344         if(r):
345             spb = fs / sr
346             taps = gr.firdes.gaussian(gain, spb, bt, ntaps)
347             return (taps,r)
348         else:
349             return ([],r)
350
351     # Design Functions for Equiripple Filters
352     def design_opt_lpf(self, fs, gain):
353         ret = True
354         pb,r = self.gui.endofLpfPassBandEdit.text().toDouble()
355         ret = r and ret
356         sb,r = self.gui.startofLpfStopBandEdit.text().toDouble()
357         ret = r and ret
358         atten,r = self.gui.lpfStopBandAttenEdit.text().toDouble()
359         ret = r and ret
360         ripple,r = self.gui.lpfPassBandRippleEdit.text().toDouble()
361         ret = r and ret
362
363         if(ret):
364             taps = blks2.optfir.low_pass(gain, fs, pb, sb,
365                                          ripple, atten)
366             return (taps, ret)
367         else:
368             return ([], ret)
369     
370     def design_opt_bpf(self, fs, gain):
371         ret = True
372         pb1,r = self.gui.startofBpfPassBandEdit.text().toDouble()
373         ret = r and ret
374         pb2,r = self.gui.endofBpfPassBandEdit.text().toDouble()
375         ret = r and ret
376         tb,r  = self.gui.bpfTransitionEdit.text().toDouble()
377         ret = r and ret
378         atten,r = self.gui.bpfStopBandAttenEdit.text().toDouble()
379         ret = r and ret
380         ripple,r = self.gui.bpfPassBandRippleEdit.text().toDouble()
381         ret = r and ret
382
383         if(r):
384             sb1 = pb1 - tb
385             sb2 = pb2 + tb
386             taps = blks2.optfir.band_pass(gain, fs, sb1, pb1, pb2, sb2,
387                                           ripple, atten)
388             return (taps,r)
389         else:
390             return ([],r)
391
392     def design_opt_cbpf(self, fs, gain):
393         ret = True
394         pb1,r = self.gui.startofBpfPassBandEdit.text().toDouble()
395         ret = r and ret
396         pb2,r = self.gui.endofBpfPassBandEdit.text().toDouble()
397         ret = r and ret
398         tb,r  = self.gui.bpfTransitionEdit.text().toDouble()
399         ret = r and ret
400         atten,r = self.gui.bpfStopBandAttenEdit.text().toDouble()
401         ret = r and ret
402         ripple,r = self.gui.bpfPassBandRippleEdit.text().toDouble()
403         ret = r and ret
404
405         if(r):
406             sb1 = pb1 - tb
407             sb2 = pb2 + tb
408             taps = blks2.optfir.complex_band_pass(gain, fs, sb1, pb1, pb2, sb2,
409                                                   ripple, atten)
410             return (taps,r)
411         else:
412             return ([],r)
413
414     def design_opt_bnf(self, fs, gain):
415         ret = True
416         sb1,r = self.gui.startofBnfStopBandEdit.text().toDouble()
417         ret = r and ret
418         sb2,r = self.gui.endofBnfStopBandEdit.text().toDouble()
419         ret = r and ret
420         tb,r  = self.gui.bnfTransitionEdit.text().toDouble()
421         ret = r and ret
422         atten,r = self.gui.bnfStopBandAttenEdit.text().toDouble()
423         ret = r and ret
424         ripple,r = self.gui.bnfPassBandRippleEdit.text().toDouble()
425         ret = r and ret
426
427         if(r):
428             pb1 = sb1 - tb
429             pb2 = sb2 + tb
430             taps = blks2.optfir.band_reject(gain, fs, pb1, sb1, sb2, pb2,
431                                             ripple, atten)
432             return (taps,r)
433         else:
434             return ([],r)
435
436     def design_opt_hpf(self, fs, gain):
437         ret = True
438         sb,r = self.gui.endofHpfStopBandEdit.text().toDouble()
439         ret = r and ret
440         pb,r = self.gui.startofHpfPassBandEdit.text().toDouble()
441         ret = r and ret
442         atten,r = self.gui.hpfStopBandAttenEdit.text().toDouble()
443         ret = r and ret
444         ripple,r = self.gui.hpfPassBandRippleEdit.text().toDouble()
445         ret = r and ret
446
447         if(r):
448             taps = blks2.optfir.high_pass(gain, fs, sb, pb,
449                                           atten, ripple)
450             return (taps,r)
451         else:
452             return ([],r)
453
454     def nfft_edit_changed(self, nfft):
455         infft,r = nfft.toInt()
456         if(r and (infft != self.nfftpts)):
457             self.nfftpts = infft
458             self.update_freq_curves()
459
460     def tab_changed(self, tab):
461         if(tab == 0):
462             self.update_freq_curves()
463         if(tab == 1):
464             self.update_time_curves()
465         if(tab == 2):
466             self.update_phase_curves()
467         if(tab == 3):
468             self.update_group_curves()
469         
470     def get_fft(self, fs, taps, Npts):
471         Ts = 1.0/fs
472         fftpts = fftpack.fft(taps, Npts)
473         self.freq = scipy.arange(0, fs, 1.0/(Npts*Ts))        
474         self.fftdB = 20.0*scipy.log10(abs(fftpts))
475         self.fftDeg = scipy.unwrap(scipy.angle(fftpts))
476         self.groupDelay = -scipy.diff(self.fftDeg)
477         
478     def update_time_curves(self):
479         ntaps = len(self.taps)
480         if(ntaps > 0):
481             if(type(self.taps[0]) == scipy.complex128):
482                 self.rcurve.setData(scipy.arange(ntaps), self.taps.real)
483                 self.icurve.setData(scipy.arange(ntaps), self.taps.imag)
484             else:
485                 self.rcurve.setData(scipy.arange(ntaps), self.taps)
486
487             # Reset the x-axis to the new time scale
488             ymax = 1.5 * max(self.taps)
489             ymin = 1.5 * min(self.taps)
490             self.gui.timePlot.setAxisScale(self.gui.timePlot.xBottom,
491                                            0, ntaps)
492             self.gui.timePlot.setAxisScale(self.gui.timePlot.yLeft,
493                                            ymin, ymax)
494             
495             # Set the zoomer base to unzoom to the new axis
496             self.timeZoomer.setZoomBase()
497             
498             self.gui.timePlot.replot()
499         
500     def update_freq_curves(self):
501         npts = len(self.fftdB)
502         if(npts > 0):
503             self.freqcurve.setData(self.freq, self.fftdB)
504             
505             # Reset the x-axis to the new time scale
506             ymax = 1.5 * max(self.fftdB[0:npts/2])
507             ymin = 1.1 * min(self.fftdB[0:npts/2])
508             xmax = self.freq[npts/2]
509             xmin = self.freq[0]
510             self.gui.freqPlot.setAxisScale(self.gui.freqPlot.xBottom,
511                                            xmin, xmax)
512             self.gui.freqPlot.setAxisScale(self.gui.freqPlot.yLeft,
513                                            ymin, ymax)
514             
515             # Set the zoomer base to unzoom to the new axis
516             self.freqZoomer.setZoomBase()
517             
518             self.gui.freqPlot.replot()
519
520
521     def update_phase_curves(self):
522         npts = len(self.fftDeg)
523         if(npts > 0):
524             self.phasecurve.setData(self.freq, self.fftDeg)
525             
526             # Reset the x-axis to the new time scale
527             ymax = 1.5 * max(self.fftDeg[0:npts/2])
528             ymin = 1.1 * min(self.fftDeg[0:npts/2])
529             xmax = self.freq[npts/2]
530             xmin = self.freq[0]
531             self.gui.phasePlot.setAxisScale(self.gui.phasePlot.xBottom,
532                                             xmin, xmax)
533             self.gui.phasePlot.setAxisScale(self.gui.phasePlot.yLeft,
534                                             ymin, ymax)
535             
536             # Set the zoomer base to unzoom to the new axis
537             self.phaseZoomer.setZoomBase()
538             
539             self.gui.phasePlot.replot()
540
541     def update_group_curves(self):
542         npts = len(self.groupDelay)
543         if(npts > 0):
544             self.groupcurve.setData(self.freq, self.groupDelay)
545             
546             # Reset the x-axis to the new time scale
547             ymax = 1.5 * max(self.groupDelay[0:npts/2])
548             ymin = 1.1 * min(self.groupDelay[0:npts/2])
549             xmax = self.freq[npts/2]
550             xmin = self.freq[0]
551             self.gui.groupPlot.setAxisScale(self.gui.groupPlot.xBottom,
552                                             xmin, xmax)
553             self.gui.groupPlot.setAxisScale(self.gui.groupPlot.yLeft,
554                                             ymin, ymax)
555             
556             # Set the zoomer base to unzoom to the new axis
557             self.groupZoomer.setZoomBase()
558             
559             self.gui.groupPlot.replot()
560
561
562 def setup_options():
563     usage="%prog: [options] (input_filename)"
564     description = ""
565
566     parser = OptionParser(conflict_handler="resolve",
567                           usage=usage, description=description)
568     return parser
569
570 def main(args):
571     parser = setup_options()
572     (options, args) = parser.parse_args ()
573
574     app = Qt.QApplication(args)
575     gplt = gr_plot_filter(app, options)
576     app.exec_()
577
578 if __name__ == '__main__':
579     main(sys.argv)
580