Imported Upstream version 3.2.2
[debian/gnuradio] / gr-utils / src / python / gr_plot_const.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2007,2008 Free Software Foundation, Inc.
4
5 # This file is part of GNU Radio
6
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)
10 # any later version.
11
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.
16
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.
21
22
23 try:
24     import scipy
25 except ImportError:
26     print "Please install SciPy to run this script (http://www.scipy.org/)"
27     raise SystemExit, 1
28
29 try:
30     from pylab import *
31     from matplotlib.font_manager import fontManager, FontProperties
32 except ImportError:
33     print "Please install Matplotlib to run this script (http://matplotlib.sourceforge.net/)"
34     raise SystemExit, 1
35
36 from optparse import OptionParser
37
38 matplotlib.interactive(True)
39 matplotlib.use('TkAgg')
40
41 class draw_constellation:
42     def __init__(self, filename, options):
43         self.hfile = open(filename, "r")
44         self.block_length = options.block
45         self.start = options.start
46         self.sample_rate = options.sample_rate
47
48         self.datatype = scipy.complex64
49         self.sizeof_data = self.datatype().nbytes    # number of bytes per sample in file
50
51         self.axis_font_size = 16
52         self.label_font_size = 18
53         self.title_font_size = 20
54
55         # Setup PLOT
56         self.fig = figure(1, figsize=(16, 9), facecolor='w')
57         rcParams['xtick.labelsize'] = self.axis_font_size
58         rcParams['ytick.labelsize'] = self.axis_font_size
59         
60         self.text_file     = figtext(0.10, 0.95, ("File: %s" % filename), weight="heavy", size=16)
61         self.text_file_pos = figtext(0.10, 0.90, "File Position: ", weight="heavy", size=16)
62         self.text_block    = figtext(0.40, 0.90, ("Block Size: %d" % self.block_length),
63                                      weight="heavy", size=16)        
64         self.text_sr       = figtext(0.60, 0.90, ("Sample Rate: %.2f" % self.sample_rate),
65                                      weight="heavy", size=16)
66         self.make_plots()
67
68         self.button_left_axes = self.fig.add_axes([0.45, 0.01, 0.05, 0.05], frameon=True)
69         self.button_left = Button(self.button_left_axes, "<")
70         self.button_left_callback = self.button_left.on_clicked(self.button_left_click)
71
72         self.button_right_axes = self.fig.add_axes([0.50, 0.01, 0.05, 0.05], frameon=True)
73         self.button_right = Button(self.button_right_axes, ">")
74         self.button_right_callback = self.button_right.on_clicked(self.button_right_click)
75
76         self.xlim = self.sp_iq.get_xlim()
77
78         self.manager = get_current_fig_manager()
79         connect('draw_event', self.zoom)
80         connect('key_press_event', self.click)
81         connect('button_press_event', self.mouse_button_callback)
82         show()
83
84     def get_data(self):
85         self.text_file_pos.set_text("File Position: %d" % (self.hfile.tell()//self.sizeof_data))
86         iq = scipy.fromfile(self.hfile, dtype=self.datatype, count=self.block_length)
87         #print "Read in %d items" % len(iq)
88         if(len(iq) == 0):
89             print "End of File"
90         else:
91             self.reals = [r.real for r in iq]
92             self.imags = [i.imag for i in iq]
93
94             self.time = [i*(1/self.sample_rate) for i in range(len(self.reals))]
95             
96     def make_plots(self):
97         # if specified on the command-line, set file pointer
98         self.hfile.seek(self.sizeof_data*self.start, 1)
99
100         self.get_data()
101         
102         # Subplot for real and imaginary parts of signal
103         self.sp_iq = self.fig.add_subplot(2,1,1, position=[0.075, 0.2, 0.4, 0.6])
104         self.sp_iq.set_title(("I&Q"), fontsize=self.title_font_size, fontweight="bold")
105         self.sp_iq.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
106         self.sp_iq.set_ylabel("Amplitude (V)", fontsize=self.label_font_size, fontweight="bold")
107         self.plot_iq  = self.sp_iq.plot(self.time, self.reals, 'bo-', self.time, self.imags, 'ro-')
108
109         # Subplot for constellation plot
110         self.sp_const = self.fig.add_subplot(2,2,1, position=[0.575, 0.2, 0.4, 0.6])
111         self.sp_const.set_title(("Constellation"), fontsize=self.title_font_size, fontweight="bold")
112         self.sp_const.set_xlabel("Inphase", fontsize=self.label_font_size, fontweight="bold")
113         self.sp_const.set_ylabel("Qaudrature", fontsize=self.label_font_size, fontweight="bold")
114         self.plot_const  = self.sp_const.plot(self.reals, self.imags, 'bo')
115
116         # Add plots to mark current location of point between time and constellation plots
117         self.indx = 0
118         self.plot_iq += self.sp_iq.plot([self.time[self.indx],], [self.reals[self.indx],], 'mo', ms=8)
119         self.plot_iq += self.sp_iq.plot([self.time[self.indx],], [self.imags[self.indx],], 'mo', ms=8)
120         self.plot_const += self.sp_const.plot([self.reals[self.indx],], [self.imags[self.indx],], 'mo', ms=12)
121
122         # Adjust axis
123         self.sp_iq.axis([min(self.time), max(self.time),
124                          1.5*min([min(self.reals), min(self.imags)]),
125                          1.5*max([max(self.reals), max(self.imags)])])
126         self.sp_const.axis([-2, 2, -2, 2])
127
128         draw()
129
130     def update_plots(self):
131         self.plot_iq[0].set_data([self.time, self.reals])
132         self.plot_iq[1].set_data([self.time, self.imags])
133         self.sp_iq.axis([min(self.time), max(self.time),
134                          1.5*min([min(self.reals), min(self.imags)]),
135                          1.5*max([max(self.reals), max(self.imags)])])
136
137         self.plot_const[0].set_data([self.reals, self.imags])
138         self.sp_const.axis([-2, 2, -2, 2])
139         draw()
140         
141     def zoom(self, event):
142         newxlim = self.sp_iq.get_xlim()
143         if(newxlim.all() != self.xlim.all()):
144             self.xlim = newxlim
145             r = self.reals[int(ceil(self.xlim[0])) : int(ceil(self.xlim[1]))]
146             i = self.imags[int(ceil(self.xlim[0])) : int(ceil(self.xlim[1]))]
147
148             self.plot_const[0].set_data(r, i)
149             self.sp_const.axis([-2, 2, -2, 2])
150             self.manager.canvas.draw()
151             draw()
152
153     def click(self, event):
154         forward_valid_keys = [" ", "down", "right"]
155         backward_valid_keys = ["up", "left"]
156         trace_forward_valid_keys = [">",]
157         trace_backward_valid_keys = ["<",]
158
159         if(find(event.key, forward_valid_keys)):
160             self.step_forward()
161             
162         elif(find(event.key, backward_valid_keys)):
163             self.step_backward()
164
165         elif(find(event.key, trace_forward_valid_keys)):
166             self.indx = min(self.indx+1, len(self.time)-1)
167             self.set_trace(self.indx)
168
169         elif(find(event.key, trace_backward_valid_keys)):
170             self.indx = max(0, self.indx-1)
171             self.set_trace(self.indx)
172
173     def button_left_click(self, event):
174         self.step_backward()
175
176     def button_right_click(self, event):
177         self.step_forward()
178
179     def step_forward(self):
180         self.get_data()
181         self.update_plots()
182
183     def step_backward(self):
184         # Step back in file position
185         if(self.hfile.tell() >= 2*self.sizeof_data*self.block_length ):
186             self.hfile.seek(-2*self.sizeof_data*self.block_length, 1)
187         else:
188             self.hfile.seek(-self.hfile.tell(),1)
189         self.get_data()
190         self.update_plots()
191     
192         
193     def mouse_button_callback(self, event):
194         x, y = event.xdata, event.ydata
195         
196         if x is not None and y is not None:
197             if(event.inaxes == self.sp_iq):
198                 self.indx = searchsorted(self.time, [x])
199                 self.set_trace(self.indx)
200                 
201
202     def set_trace(self, indx):
203         self.plot_iq[2].set_data(self.time[indx], self.reals[indx])
204         self.plot_iq[3].set_data(self.time[indx], self.imags[indx])
205         self.plot_const[1].set_data(self.reals[indx], self.imags[indx])
206         draw()
207
208             
209 def find(item_in, list_search):
210     try:
211         return list_search.index(item_in) != None
212     except ValueError:
213         return False
214         
215
216 def main():
217     usage="%prog: [options] input_filename"
218     description = "Takes a GNU Radio complex binary file and displays the I&Q data versus time and the constellation plot (I vs. Q). You can set the block size to specify how many points to read in at a time and the start position in the file. By default, the system assumes a sample rate of 1, so in time, each sample is plotted versus the sample number. To set a true time axis, set the sample rate (-R or --sample-rate) to the sample rate used when capturing the samples."
219
220     parser = OptionParser(conflict_handler="resolve", usage=usage, description=description)
221     parser.add_option("-B", "--block", type="int", default=1000,
222                       help="Specify the block size [default=%default]")
223     parser.add_option("-s", "--start", type="int", default=0,
224                       help="Specify where to start in the file [default=%default]")
225     parser.add_option("-R", "--sample-rate", type="float", default=1.0,
226                       help="Set the sampler rate of the data [default=%default]")
227     
228     (options, args) = parser.parse_args ()
229     if len(args) != 1:
230         parser.print_help()
231         raise SystemExit, 1
232     filename = args[0]
233
234     dc = draw_constellation(filename, options)
235
236 if __name__ == "__main__":
237     try:
238         main()
239     except KeyboardInterrupt:
240         pass
241     
242
243