d9a9daabf9e08505a7cbc9c488ccf959b2626f8e
[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         show()
82
83     def get_data(self):
84         self.text_file_pos.set_text("File Position: %d" % (self.hfile.tell()//self.sizeof_data))
85         iq = scipy.fromfile(self.hfile, dtype=self.datatype, count=self.block_length)
86         #print "Read in %d items" % len(iq)
87         if(len(iq) == 0):
88             print "End of File"
89         else:
90             self.reals = [r.real for r in iq]
91             self.imags = [i.imag for i in iq]
92
93             self.time = [i*(1/self.sample_rate) for i in range(len(self.reals))]
94             
95     def make_plots(self):
96         # if specified on the command-line, set file pointer
97         self.hfile.seek(self.sizeof_data*self.start, 1)
98
99         self.get_data()
100         
101         # Subplot for real and imaginary parts of signal
102         self.sp_iq = self.fig.add_subplot(2,1,1, position=[0.075, 0.2, 0.4, 0.6])
103         self.sp_iq.set_title(("I&Q"), fontsize=self.title_font_size, fontweight="bold")
104         self.sp_iq.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
105         self.sp_iq.set_ylabel("Amplitude (V)", fontsize=self.label_font_size, fontweight="bold")
106         self.plot_iq = plot(self.time, self.reals, 'bo-', self.time, self.imags, 'ro-')
107         self.sp_iq.axis([min(self.time), max(self.time),
108                          1.5*min([min(self.reals), min(self.imags)]),
109                          1.5*max([max(self.reals), max(self.imags)])])
110
111         # Subplot for constellation plot
112         self.sp_const = self.fig.add_subplot(2,2,1, position=[0.575, 0.2, 0.4, 0.6])
113         self.sp_const.set_title(("Constellation"), fontsize=self.title_font_size, fontweight="bold")
114         self.sp_const.set_xlabel("Inphase", fontsize=self.label_font_size, fontweight="bold")
115         self.sp_const.set_ylabel("Qaudrature", fontsize=self.label_font_size, fontweight="bold")
116         self.plot_const = plot(self.reals, self.imags, 'bo')
117         self.sp_const.axis([-2, 2, -2, 2])
118
119         draw()
120
121     def update_plots(self):
122         self.plot_iq[0].set_data([self.time, self.reals])
123         self.plot_iq[1].set_data([self.time, self.imags])
124         self.sp_iq.axis([min(self.time), max(self.time),
125                          1.5*min([min(self.reals), min(self.imags)]),
126                          1.5*max([max(self.reals), max(self.imags)])])
127
128         self.plot_const[0].set_data([self.reals, self.imags])
129         self.sp_const.axis([-2, 2, -2, 2])
130         draw()
131         
132     def zoom(self, event):
133         newxlim = self.sp_iq.get_xlim()
134         if(newxlim != self.xlim):
135             self.xlim = newxlim
136             r = self.reals[int(ceil(self.xlim[0])) : int(ceil(self.xlim[1]))]
137             i = self.imags[int(ceil(self.xlim[0])) : int(ceil(self.xlim[1]))]
138
139             self.plot_const[0].set_data(r, i)
140             self.sp_const.axis([-2, 2, -2, 2])
141             self.manager.canvas.draw()
142             draw()
143
144     def click(self, event):
145         forward_valid_keys = [" ", "down", "right"]
146         backward_valid_keys = ["up", "left"]
147
148         if(find(event.key, forward_valid_keys)):
149             self.step_forward()
150             
151         elif(find(event.key, backward_valid_keys)):
152             self.step_backward()
153
154     def button_left_click(self, event):
155         self.step_backward()
156
157     def button_right_click(self, event):
158         self.step_forward()
159
160     def step_forward(self):
161         self.get_data()
162         self.update_plots()
163
164     def step_backward(self):
165         # Step back in file position
166         if(self.hfile.tell() >= 2*self.sizeof_data*self.block_length ):
167             self.hfile.seek(-2*self.sizeof_data*self.block_length, 1)
168         else:
169             self.hfile.seek(-self.hfile.tell(),1)
170         self.get_data()
171         self.update_plots()
172         
173             
174 def find(item_in, list_search):
175     try:
176         return list_search.index(item_in) != None
177     except ValueError:
178         return False
179         
180
181 def main():
182     usage="%prog: [options] input_filename"
183     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."
184
185     parser = OptionParser(conflict_handler="resolve", usage=usage, description=description)
186     parser.add_option("-B", "--block", type="int", default=1000,
187                       help="Specify the block size [default=%default]")
188     parser.add_option("-s", "--start", type="int", default=0,
189                       help="Specify where to start in the file [default=%default]")
190     parser.add_option("-R", "--sample-rate", type="float", default=1.0,
191                       help="Set the sampler rate of the data [default=%default]")
192     
193     (options, args) = parser.parse_args ()
194     if len(args) != 1:
195         parser.print_help()
196         raise SystemExit, 1
197     filename = args[0]
198
199     dc = draw_constellation(filename, options)
200
201 if __name__ == "__main__":
202     try:
203         main()
204     except KeyboardInterrupt:
205         pass
206     
207
208