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