added catchall **kwargs to scope sink gl
[debian/gnuradio] / gr-wxgui / src / python / scopesink_gl.py
1 #
2 # Copyright 2008 Free Software Foundation, Inc.
3 #
4 # This file is part of GNU Radio
5 #
6 # GNU Radio is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3, or (at your option)
9 # any later version.
10 #
11 # GNU Radio is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with GNU Radio; see the file COPYING.  If not, write to
18 # the Free Software Foundation, Inc., 51 Franklin Street,
19 # Boston, MA 02110-1301, USA.
20 #
21
22 ##################################################
23 # Imports
24 ##################################################
25 import scope_window
26 import common
27 from gnuradio import gr
28 from pubsub import pubsub
29 from constants import *
30
31 class ac_couple_block(gr.hier_block2):
32         """
33         AC couple the incoming stream by subtracting out the low pass signal.
34         Mute the low pass filter to disable ac coupling.
35         """
36
37         def __init__(self, controller, ac_couple_key, ac_couple, sample_rate_key):
38                 gr.hier_block2.__init__(
39                         self,
40                         "ac_couple",
41                         gr.io_signature(1, 1, gr.sizeof_float),
42                         gr.io_signature(1, 1, gr.sizeof_float),
43                 )
44                 #blocks
45                 copy = gr.kludge_copy(gr.sizeof_float)
46                 lpf = gr.single_pole_iir_filter_ff(0.0)
47                 sub = gr.sub_ff()
48                 mute = gr.mute_ff()
49                 #connect
50                 self.connect(self, copy, sub, self)
51                 self.connect(copy, lpf, mute, (sub, 1))
52                 #subscribe
53                 controller.subscribe(ac_couple_key, lambda x: mute.set_mute(not x))
54                 controller.subscribe(sample_rate_key, lambda x: lpf.set_taps(2.0/x))
55                 #initialize
56                 controller[ac_couple_key] = ac_couple
57                 controller[sample_rate_key] = controller[sample_rate_key]
58
59 ##################################################
60 # Scope sink block (wrapper for old wxgui)
61 ##################################################
62 class _scope_sink_base(gr.hier_block2):
63         """
64         A scope block with a gui window.
65         """
66
67         def __init__(
68                 self,
69                 parent,
70                 title='',
71                 sample_rate=1,
72                 size=scope_window.DEFAULT_WIN_SIZE,
73                 v_scale=0,
74                 t_scale=0,
75                 xy_mode=False,
76                 ac_couple=False,
77                 num_inputs=1,
78                 frame_rate=scope_window.DEFAULT_FRAME_RATE,
79                 **kwargs #do not end with a comma
80         ):
81                 if not t_scale: t_scale = 10.0/sample_rate
82                 #init
83                 gr.hier_block2.__init__(
84                         self,
85                         "scope_sink",
86                         gr.io_signature(num_inputs, num_inputs, self._item_size),
87                         gr.io_signature(0, 0, 0),
88                 )
89                 #scope
90                 msgq = gr.msg_queue(2)
91                 scope = gr.oscope_sink_f(sample_rate, msgq)
92                 #controller
93                 self.controller = pubsub()
94                 self.controller.subscribe(SAMPLE_RATE_KEY, scope.set_sample_rate)
95                 self.controller.publish(SAMPLE_RATE_KEY, scope.sample_rate)
96                 self.controller.subscribe(DECIMATION_KEY, scope.set_decimation_count)
97                 self.controller.publish(DECIMATION_KEY, scope.get_decimation_count)
98                 self.controller.subscribe(TRIGGER_LEVEL_KEY, scope.set_trigger_level)
99                 self.controller.publish(TRIGGER_LEVEL_KEY, scope.get_trigger_level)
100                 self.controller.subscribe(TRIGGER_MODE_KEY, scope.set_trigger_mode)
101                 self.controller.publish(TRIGGER_MODE_KEY, scope.get_trigger_mode)
102                 self.controller.subscribe(TRIGGER_SLOPE_KEY, scope.set_trigger_slope)
103                 self.controller.publish(TRIGGER_SLOPE_KEY, scope.get_trigger_slope)
104                 self.controller.subscribe(TRIGGER_CHANNEL_KEY, scope.set_trigger_channel)
105                 self.controller.publish(TRIGGER_CHANNEL_KEY, scope.get_trigger_channel)
106                 #connect
107                 if self._real:
108                         for i in range(num_inputs):
109                                 self.connect(
110                                         (self, i),
111                                         ac_couple_block(self.controller, common.index_key(AC_COUPLE_KEY, i), ac_couple, SAMPLE_RATE_KEY),
112                                         (scope, i),
113                                 )
114                 else:
115                         for i in range(num_inputs):
116                                 c2f = gr.complex_to_float() 
117                                 self.connect((self, i), c2f)
118                                 for j in range(2):
119                                         self.connect(
120                                                 (c2f, j), 
121                                                 ac_couple_block(self.controller, common.index_key(AC_COUPLE_KEY, 2*i+j), ac_couple, SAMPLE_RATE_KEY),
122                                                 (scope, 2*i+j),
123                                         )
124                         num_inputs *= 2
125                 #start input watcher
126                 common.input_watcher(msgq, self.controller, MSG_KEY)
127                 #create window
128                 self.win = scope_window.scope_window(
129                         parent=parent,
130                         controller=self.controller,
131                         size=size,
132                         title=title,
133                         frame_rate=frame_rate,
134                         num_inputs=num_inputs,
135                         sample_rate_key=SAMPLE_RATE_KEY,
136                         t_scale=t_scale,
137                         v_scale=v_scale,
138                         xy_mode=xy_mode,
139                         ac_couple_key=AC_COUPLE_KEY,
140                         trigger_level_key=TRIGGER_LEVEL_KEY,
141                         trigger_mode_key=TRIGGER_MODE_KEY,
142                         trigger_slope_key=TRIGGER_SLOPE_KEY,
143                         trigger_channel_key=TRIGGER_CHANNEL_KEY,
144                         decimation_key=DECIMATION_KEY,
145                         msg_key=MSG_KEY,
146                 )
147                 common.register_access_methods(self, self.win)
148
149 class scope_sink_f(_scope_sink_base):
150         _item_size = gr.sizeof_float
151         _real = True
152
153 class scope_sink_c(_scope_sink_base):
154         _item_size = gr.sizeof_gr_complex
155         _real = False
156
157 # ----------------------------------------------------------------
158 # Stand-alone test application
159 # ----------------------------------------------------------------
160
161 import wx
162 from gnuradio.wxgui import stdgui2
163
164 class test_top_block (stdgui2.std_top_block):
165     def __init__(self, frame, panel, vbox, argv):
166         stdgui2.std_top_block.__init__ (self, frame, panel, vbox, argv)
167
168         if len(argv) > 1:
169             frame_decim = int(argv[1]) 
170         else:
171             frame_decim = 1
172
173         if len(argv) > 2:
174             v_scale = float(argv[2])  # start up at this v_scale value
175         else:
176             v_scale = None  # start up in autorange mode, default
177
178         if len(argv) > 3:
179             t_scale = float(argv[3])  # start up at this t_scale value
180         else:
181             t_scale = .00003  # old behavior
182
183         print "frame decim %s  v_scale %s  t_scale %s" % (frame_decim,v_scale,t_scale)
184             
185         input_rate = 1e6
186
187         # Generate a complex sinusoid
188         self.src0 = gr.sig_source_c (input_rate, gr.GR_SIN_WAVE, 25.1e3, 1e3)
189
190         # We add this throttle block so that this demo doesn't suck down
191         # all the CPU available.  You normally wouldn't use it...
192         self.thr = gr.throttle(gr.sizeof_gr_complex, input_rate)
193
194         scope = scope_sink_c (panel,"Secret Data",sample_rate=input_rate,
195                               v_scale=v_scale, t_scale=t_scale)
196         vbox.Add (scope.win, 1, wx.EXPAND)
197
198         # Ultimately this will be
199         # self.connect("src0 throttle scope")
200         self.connect(self.src0, self.thr, scope) 
201
202 def main ():
203     app = stdgui2.stdapp (test_top_block, "O'Scope Test App")
204     app.MainLoop ()
205
206 if __name__ == '__main__':
207     main ()