3 # Copyright 2003,2004,2005,2007 Free Software Foundation, Inc.
5 # This file is part of GNU Radio
7 # GNU Radio is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3, or (at your option)
12 # GNU Radio is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with GNU Radio; see the file COPYING. If not, write to
19 # the Free Software Foundation, Inc., 51 Franklin Street,
20 # Boston, MA 02110-1301, USA.
23 from gnuradio import gr, gru, window
24 from gnuradio.wxgui import stdgui2
26 import gnuradio.wxgui.plot as plot
32 default_fftsink_size = (640,240)
33 default_fft_rate = gr.prefs().get_long('wxgui', 'fft_rate', 15)
35 class waterfall_sink_base(object):
36 def __init__(self, input_is_real=False, baseband_freq=0,
37 sample_rate=1, fft_size=512,
38 fft_rate=default_fft_rate,
39 average=False, avg_alpha=None, title=''):
41 # initialize common attributes
42 self.baseband_freq = baseband_freq
43 self.sample_rate = sample_rate
44 self.fft_size = fft_size
45 self.fft_rate = fft_rate
46 self.average = average
48 self.avg_alpha = 2.0 / fft_rate
50 self.avg_alpha = avg_alpha
52 self.input_is_real = input_is_real
53 self.msgq = gr.msg_queue(2) # queue up to 2 messages
55 def set_average(self, average):
56 self.average = average
58 self.avg.set_taps(self.avg_alpha)
60 self.avg.set_taps(1.0)
62 def set_avg_alpha(self, avg_alpha):
63 self.avg_alpha = avg_alpha
65 def set_baseband_freq(self, baseband_freq):
66 self.baseband_freq = baseband_freq
68 def set_sample_rate(self, sample_rate):
69 self.sample_rate = sample_rate
73 self.one_in_n.set_n(max(1, int(self.sample_rate/self.fft_size/self.fft_rate)))
75 class waterfall_sink_f(gr.hier_block2, waterfall_sink_base):
76 def __init__(self, parent, baseband_freq=0,
77 y_per_div=10, ref_level=50, sample_rate=1, fft_size=512,
78 fft_rate=default_fft_rate, average=False, avg_alpha=None,
79 title='', size=default_fftsink_size):
81 gr.hier_block2.__init__(self, "waterfall_sink_f",
82 gr.io_signature(1, 1, gr.sizeof_float),
83 gr.io_signature(0,0,0))
85 waterfall_sink_base.__init__(self, input_is_real=True, baseband_freq=baseband_freq,
86 sample_rate=sample_rate, fft_size=fft_size,
88 average=average, avg_alpha=avg_alpha, title=title)
90 self.s2p = gr.serial_to_parallel(gr.sizeof_float, self.fft_size)
91 self.one_in_n = gr.keep_one_in_n(gr.sizeof_float * self.fft_size,
92 max(1, int(self.sample_rate/self.fft_size/self.fft_rate)))
94 mywindow = window.blackmanharris(self.fft_size)
95 self.fft = gr.fft_vfc(self.fft_size, True, mywindow)
96 self.c2mag = gr.complex_to_mag(self.fft_size)
97 self.avg = gr.single_pole_iir_filter_ff(1.0, self.fft_size)
98 self.log = gr.nlog10_ff(20, self.fft_size, -20*math.log10(self.fft_size))
99 self.sink = gr.message_sink(gr.sizeof_float * self.fft_size, self.msgq, True)
100 self.connect(self, self.s2p, self.one_in_n, self.fft, self.c2mag, self.avg, self.log, self.sink)
102 self.win = waterfall_window(self, parent, size=size)
103 self.set_average(self.average)
106 class waterfall_sink_c(gr.hier_block2, waterfall_sink_base):
107 def __init__(self, parent, baseband_freq=0,
108 y_per_div=10, ref_level=50, sample_rate=1, fft_size=512,
109 fft_rate=default_fft_rate, average=False, avg_alpha=None,
110 title='', size=default_fftsink_size):
112 gr.hier_block2.__init__(self, "waterfall_sink_f",
113 gr.io_signature(1, 1, gr.sizeof_gr_complex),
114 gr.io_signature(0,0,0))
116 waterfall_sink_base.__init__(self, input_is_real=False, baseband_freq=baseband_freq,
117 sample_rate=sample_rate, fft_size=fft_size,
119 average=average, avg_alpha=avg_alpha, title=title)
121 self.s2p = gr.serial_to_parallel(gr.sizeof_gr_complex, self.fft_size)
122 self.one_in_n = gr.keep_one_in_n(gr.sizeof_gr_complex * self.fft_size,
123 max(1, int(self.sample_rate/self.fft_size/self.fft_rate)))
125 mywindow = window.blackmanharris(self.fft_size)
126 self.fft = gr.fft_vcc(self.fft_size, True, mywindow)
127 self.c2mag = gr.complex_to_mag(self.fft_size)
128 self.avg = gr.single_pole_iir_filter_ff(1.0, self.fft_size)
129 self.log = gr.nlog10_ff(20, self.fft_size, -20*math.log10(self.fft_size))
130 self.sink = gr.message_sink(gr.sizeof_float * self.fft_size, self.msgq, True)
131 self.connect(self, self.s2p, self.one_in_n, self.fft, self.c2mag, self.avg, self.log, self.sink)
133 self.win = waterfall_window(self, parent, size=size)
134 self.set_average(self.average)
137 # ------------------------------------------------------------------------
139 myDATA_EVENT = wx.NewEventType()
140 EVT_DATA_EVENT = wx.PyEventBinder (myDATA_EVENT, 0)
143 class DataEvent(wx.PyEvent):
144 def __init__(self, data):
145 wx.PyEvent.__init__(self)
146 self.SetEventType (myDATA_EVENT)
150 self.__class__ (self.GetId())
153 class input_watcher (threading.Thread):
154 def __init__ (self, msgq, fft_size, event_receiver, **kwds):
155 threading.Thread.__init__ (self, **kwds)
158 self.fft_size = fft_size
159 self.event_receiver = event_receiver
160 self.keep_running = True
164 while (self.keep_running):
165 msg = self.msgq.delete_head() # blocking read of message queue
166 itemsize = int(msg.arg1())
167 nitems = int(msg.arg2())
169 s = msg.to_string() # get the body of the msg as a string
171 # There may be more than one FFT frame in the message.
172 # If so, we take only the last one
174 start = itemsize * (nitems - 1)
175 s = s[start:start+itemsize]
177 complex_data = numpy.fromstring (s, numpy.float32)
178 de = DataEvent (complex_data)
179 wx.PostEvent (self.event_receiver, de)
183 class waterfall_window (wx.Panel):
184 def __init__ (self, fftsink, parent, id = -1,
185 pos = wx.DefaultPosition, size = wx.DefaultSize,
186 style = wx.DEFAULT_FRAME_STYLE, name = ""):
187 wx.Panel.__init__(self, parent, id, pos, size, style, name)
189 self.fftsink = fftsink
190 self.bm = wx.EmptyBitmap(self.fftsink.fft_size, 300, -1)
192 self.scale_factor = 5.0 # FIXME should autoscale, or set this
195 dc1.SelectObject(self.bm)
198 self.pens = self.make_pens()
200 wx.EVT_PAINT( self, self.OnPaint )
201 wx.EVT_CLOSE (self, self.on_close_window)
202 EVT_DATA_EVENT (self, self.set_data)
204 self.build_popup_menu()
206 wx.EVT_CLOSE (self, self.on_close_window)
207 self.Bind(wx.EVT_RIGHT_UP, self.on_right_click)
209 self.input_watcher = input_watcher(fftsink.msgq, fftsink.fft_size, self)
212 def on_close_window (self, event):
213 print "waterfall_window: on_close_window"
214 self.keep_running = False
216 def const_list(self,const,len):
219 def make_colormap(self):
221 r.extend(self.const_list(0,96))
222 r.extend(range(0,255,4))
223 r.extend(self.const_list(255,64))
224 r.extend(range(255,128,-4))
227 g.extend(self.const_list(0,32))
228 g.extend(range(0,255,4))
229 g.extend(self.const_list(255,64))
230 g.extend(range(255,0,-4))
231 g.extend(self.const_list(0,32))
234 b.extend(self.const_list(255,64))
235 b.extend(range(255,0,-4))
236 b.extend(self.const_list(0,96))
240 (r,g,b) = self.make_colormap()
242 for i in range(0,256):
243 colour = wx.Colour(r[i], g[i], b[i])
244 pens.append( wx.Pen(colour, 2, wx.SOLID))
247 def OnPaint(self, event):
248 dc = wx.PaintDC(self)
251 def DoDrawing(self, dc=None):
253 dc = wx.ClientDC(self)
254 dc.DrawBitmap(self.bm, 0, 0, False )
257 def const_list(self,const,len):
259 for i in range(1,len):
263 def make_colormap(self):
265 r.extend(self.const_list(0,96))
266 r.extend(range(0,255,4))
267 r.extend(self.const_list(255,64))
268 r.extend(range(255,128,-4))
271 g.extend(self.const_list(0,32))
272 g.extend(range(0,255,4))
273 g.extend(self.const_list(255,64))
274 g.extend(range(255,0,-4))
275 g.extend(self.const_list(0,32))
278 b.extend(self.const_list(255,64))
279 b.extend(range(255,0,-4))
280 b.extend(self.const_list(0,96))
283 def set_data (self, evt):
288 dc1.SelectObject(self.bm)
289 dc1.Blit(0,1,self.fftsink.fft_size,300,dc1,0,0,wx.COPY,False,-1,-1)
291 x = max(abs(self.fftsink.sample_rate), abs(self.fftsink.baseband_freq))
303 if self.fftsink.input_is_real: # only plot 1/2 the points
310 scale_factor = self.scale_factor
311 if self.fftsink.input_is_real: # real fft
312 for x_pos in range(0, d_max):
313 value = int(dB[x_pos] * scale_factor)
314 value = min(255, max(0, value))
315 dc1.SetPen(self.pens[value])
316 dc1.DrawRectangle(x_pos*p_width, 0, p_width, 1)
318 for x_pos in range(0, d_max): # positive freqs
319 value = int(dB[x_pos] * scale_factor)
320 value = min(255, max(0, value))
321 dc1.SetPen(self.pens[value])
322 dc1.DrawRectangle(x_pos*p_width + d_max, 0, p_width, 1)
323 for x_pos in range(0 , d_max): # negative freqs
324 value = int(dB[x_pos+d_max] * scale_factor)
325 value = min(255, max(0, value))
326 dc1.SetPen(self.pens[value])
327 dc1.DrawRectangle(x_pos*p_width, 0, p_width, 1)
329 self.DoDrawing (None)
331 def on_average(self, evt):
333 self.fftsink.set_average(evt.IsChecked())
335 def on_right_click(self, event):
336 menu = self.popup_menu
337 for id, pred in self.checkmarks.items():
338 item = menu.FindItemById(id)
340 self.PopupMenu(menu, event.GetPosition())
343 def build_popup_menu(self):
344 self.id_incr_ref_level = wx.NewId()
345 self.id_decr_ref_level = wx.NewId()
346 self.id_incr_y_per_div = wx.NewId()
347 self.id_decr_y_per_div = wx.NewId()
348 self.id_y_per_div_1 = wx.NewId()
349 self.id_y_per_div_2 = wx.NewId()
350 self.id_y_per_div_5 = wx.NewId()
351 self.id_y_per_div_10 = wx.NewId()
352 self.id_y_per_div_20 = wx.NewId()
353 self.id_average = wx.NewId()
355 self.Bind(wx.EVT_MENU, self.on_average, id=self.id_average)
356 #self.Bind(wx.EVT_MENU, self.on_incr_ref_level, id=self.id_incr_ref_level)
357 #self.Bind(wx.EVT_MENU, self.on_decr_ref_level, id=self.id_decr_ref_level)
358 #self.Bind(wx.EVT_MENU, self.on_incr_y_per_div, id=self.id_incr_y_per_div)
359 #self.Bind(wx.EVT_MENU, self.on_decr_y_per_div, id=self.id_decr_y_per_div)
360 #self.Bind(wx.EVT_MENU, self.on_y_per_div, id=self.id_y_per_div_1)
361 #self.Bind(wx.EVT_MENU, self.on_y_per_div, id=self.id_y_per_div_2)
362 #self.Bind(wx.EVT_MENU, self.on_y_per_div, id=self.id_y_per_div_5)
363 #self.Bind(wx.EVT_MENU, self.on_y_per_div, id=self.id_y_per_div_10)
364 #self.Bind(wx.EVT_MENU, self.on_y_per_div, id=self.id_y_per_div_20)
369 self.popup_menu = menu
370 menu.AppendCheckItem(self.id_average, "Average")
371 # menu.Append(self.id_incr_ref_level, "Incr Ref Level")
372 # menu.Append(self.id_decr_ref_level, "Decr Ref Level")
373 # menu.Append(self.id_incr_y_per_div, "Incr dB/div")
374 # menu.Append(self.id_decr_y_per_div, "Decr dB/div")
375 # menu.AppendSeparator()
376 # we'd use RadioItems for these, but they're not supported on Mac
377 #menu.AppendCheckItem(self.id_y_per_div_1, "1 dB/div")
378 #menu.AppendCheckItem(self.id_y_per_div_2, "2 dB/div")
379 #menu.AppendCheckItem(self.id_y_per_div_5, "5 dB/div")
380 #menu.AppendCheckItem(self.id_y_per_div_10, "10 dB/div")
381 #menu.AppendCheckItem(self.id_y_per_div_20, "20 dB/div")
384 self.id_average : lambda : self.fftsink.average
385 #self.id_y_per_div_1 : lambda : self.fftsink.y_per_div == 1,
386 #self.id_y_per_div_2 : lambda : self.fftsink.y_per_div == 2,
387 #self.id_y_per_div_5 : lambda : self.fftsink.y_per_div == 5,
388 #self.id_y_per_div_10 : lambda : self.fftsink.y_per_div == 10,
389 #self.id_y_per_div_20 : lambda : self.fftsink.y_per_div == 20,
395 Return the first item in seq that is > v.
402 def next_down(v, seq):
404 Return the last item in seq that is < v.
415 # ----------------------------------------------------------------
416 # Standalone test app
417 # ----------------------------------------------------------------
419 class test_top_block (stdgui2.std_top_block):
420 def __init__(self, frame, panel, vbox, argv):
421 stdgui2.std_top_block.__init__ (self, frame, panel, vbox, argv)
425 # build our flow graph
426 input_rate = 20.000e3
428 # Generate a complex sinusoid
429 self.src1 = gr.sig_source_c (input_rate, gr.GR_SIN_WAVE, 5.75e3, 1000)
430 #src1 = gr.sig_source_c (input_rate, gr.GR_CONST_WAVE, 5.75e3, 1000)
432 # We add these throttle blocks so that this demo doesn't
433 # suck down all the CPU available. Normally you wouldn't use these.
434 self.thr1 = gr.throttle(gr.sizeof_gr_complex, input_rate)
436 sink1 = waterfall_sink_c (panel, title="Complex Data", fft_size=fft_size,
437 sample_rate=input_rate, baseband_freq=100e3)
438 self.connect(self.src1, self.thr1, sink1)
439 vbox.Add (sink1.win, 1, wx.EXPAND)
441 # generate a real sinusoid
442 self.src2 = gr.sig_source_f (input_rate, gr.GR_SIN_WAVE, 5.75e3, 1000)
443 self.thr2 = gr.throttle(gr.sizeof_float, input_rate)
444 sink2 = waterfall_sink_f (panel, title="Real Data", fft_size=fft_size,
445 sample_rate=input_rate, baseband_freq=100e3)
446 self.connect(self.src2, self.thr2, sink2)
447 vbox.Add (sink2.win, 1, wx.EXPAND)
451 app = stdgui2.stdapp (test_top_block, "Waterfall Sink Test App")
454 if __name__ == '__main__':