git.gag.com Git - debian/gnuradio/blob - gr-utils/src/python/gr_plot_psd.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     from scipy import fftpack
  26 except ImportError:
  27     print "Please install SciPy to run this script (http://www.scipy.org/)"
  28     raise SystemExit, 1
  29
  30 try:
  31     from pylab import *
  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 from scipy import log10
  38
  39 class gr_plot_psd:
  40     def __init__(self, datatype, filename, options):
  41         self.hfile = open(filename, "r")
  42         self.block_length = options.block
  43         self.start = options.start
  44         self.sample_rate = options.sample_rate
  45         self.psdfftsize = options.psd_size
  46         self.specfftsize = options.spec_size
  47
  48         self.dospec = options.enable_spec  # if we want to plot the spectrogram
  49
  50         self.datatype = getattr(scipy, datatype) #scipy.complex64
  51         self.sizeof_data = self.datatype().nbytes    # number of bytes per sample in file
  52
  53         self.axis_font_size = 16
  54         self.label_font_size = 18
  55         self.title_font_size = 20
  56         self.text_size = 22
  57
  58         # Setup PLOT
  59         self.fig = figure(1, figsize=(16, 12), facecolor='w')
  60         rcParams['xtick.labelsize'] = self.axis_font_size
  61         rcParams['ytick.labelsize'] = self.axis_font_size
  62
  63         self.text_file     = figtext(0.10, 0.95, ("File: %s" % filename), weight="heavy", size=self.text_size)
  64         self.text_file_pos = figtext(0.10, 0.92, "File Position: ", weight="heavy", size=self.text_size)
  65         self.text_block    = figtext(0.35, 0.92, ("Block Size: %d" % self.block_length),
  66                                      weight="heavy", size=self.text_size)
  67         self.text_sr       = figtext(0.60, 0.915, ("Sample Rate: %.2f" % self.sample_rate),
  68                                      weight="heavy", size=self.text_size)
  69         self.make_plots()
  70
  71         self.button_left_axes = self.fig.add_axes([0.45, 0.01, 0.05, 0.05], frameon=True)
  72         self.button_left = Button(self.button_left_axes, "<")
  73         self.button_left_callback = self.button_left.on_clicked(self.button_left_click)
  74
  75         self.button_right_axes = self.fig.add_axes([0.50, 0.01, 0.05, 0.05], frameon=True)
  76         self.button_right = Button(self.button_right_axes, ">")
  77         self.button_right_callback = self.button_right.on_clicked(self.button_right_click)
  78
  79         self.xlim = self.sp_iq.get_xlim()
  80
  81         self.manager = get_current_fig_manager()
  82         connect('draw_event', self.zoom)
  83         connect('key_press_event', self.click)
  84         show()
  85
  86     def get_data(self):
  87         self.position = self.hfile.tell()/self.sizeof_data
  88         self.text_file_pos.set_text("File Position: %d" % self.position)
  89         self.iq = scipy.fromfile(self.hfile, dtype=self.datatype, count=self.block_length)
  90         #print "Read in %d items" % len(self.iq)
  91         if(len(self.iq) == 0):
  92             print "End of File"
  93         else:
  94             tstep = 1.0 / self.sample_rate
  95             self.time = [tstep*(self.position + i) for i in xrange(len(self.iq))]
  96
  97             self.iq_psd, self.freq = self.dopsd(self.iq)
  98
  99     def dopsd(self, iq):
 100         ''' Need to do this here and plot later so we can do the fftshift '''
 101         overlap = self.psdfftsize/4
 102         winfunc = scipy.blackman
 103         psd,freq = self.sp_psd.psd(iq, self.psdfftsize, self.sample_rate,
 104                                    window = lambda d: d*winfunc(self.psdfftsize),
 105                                    noverlap = overlap, visible=False)
 106         psd = 10.0*log10(abs(fftpack.fftshift(psd)))
 107         return (psd, freq)
 108
 109     def make_plots(self):
 110         # if specified on the command-line, set file pointer
 111         self.hfile.seek(self.sizeof_data*self.start, 1)
 112
 113         iqdims = [[0.075, 0.2, 0.4, 0.6], [0.075, 0.55, 0.4, 0.3]]
 114         psddims = [[0.575, 0.2, 0.4, 0.6], [0.575, 0.55, 0.4, 0.3]]
 115         specdims = [0.2, 0.125, 0.6, 0.3]
 116
 117         # Subplot for real and imaginary parts of signal
 118         self.sp_iq = self.fig.add_subplot(2,2,1, position=iqdims[self.dospec])
 119         self.sp_iq.set_title(("I&Q"), fontsize=self.title_font_size, fontweight="bold")
 120         self.sp_iq.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
 121         self.sp_iq.set_ylabel("Amplitude (V)", fontsize=self.label_font_size, fontweight="bold")
 122
 123         # Subplot for PSD plot
 124         self.sp_psd = self.fig.add_subplot(2,2,2, position=psddims[self.dospec])
 125         self.sp_psd.set_title(("PSD"), fontsize=self.title_font_size, fontweight="bold")
 126         self.sp_psd.set_xlabel("Frequency (Hz)", fontsize=self.label_font_size, fontweight="bold")
 127         self.sp_psd.set_ylabel("Power Spectrum (dBm)", fontsize=self.label_font_size, fontweight="bold")
 128
 129         self.get_data()
 130
 131         self.plot_iq  = self.sp_iq.plot([], 'bo-') # make plot for reals
 132         self.plot_iq += self.sp_iq.plot([], 'ro-') # make plot for imags
 133         self.draw_time()                           # draw the plot
 134
 135         self.plot_psd = self.sp_psd.plot([], 'b')  # make plot for PSD
 136         self.draw_psd()                            # draw the plot
 137
 138
 139         if self.dospec:
 140             # Subplot for spectrogram plot
 141             self.sp_spec = self.fig.add_subplot(2,2,3, position=specdims)
 142             self.sp_spec.set_title(("Spectrogram"), fontsize=self.title_font_size, fontweight="bold")
 143             self.sp_spec.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
 144             self.sp_spec.set_ylabel("Frequency (Hz)", fontsize=self.label_font_size, fontweight="bold")
 145
 146             self.draw_spec()
 147
 148         draw()
 149
 150     def draw_time(self):
 151         reals = self.iq.real
 152         imags = self.iq.imag
 153         self.plot_iq[0].set_data([self.time, reals])
 154         self.plot_iq[1].set_data([self.time, imags])
 155         self.sp_iq.set_xlim(min(self.time), max(self.time))
 156         self.sp_iq.set_ylim([1.5*min([min(reals), min(imags)]),
 157                              1.5*max([max(reals), max(imags)])])
 158
 159     def draw_psd(self):
 160         self.plot_psd[0].set_data([self.freq, self.iq_psd])
 161         self.sp_psd.set_ylim([min(self.iq_psd)-10, max(self.iq_psd)+10])
 162
 163     def draw_spec(self):
 164         overlap = self.specfftsize/4
 165         winfunc = scipy.blackman
 166         self.sp_spec.clear()
 167         self.sp_spec.specgram(self.iq, self.specfftsize, self.sample_rate,
 168                               window = lambda d: d*winfunc(self.specfftsize),
 169                               noverlap = overlap, xextent=[min(self.time), max(self.time)])
 170
 171     def update_plots(self):
 172         self.draw_time()
 173         self.draw_psd()
 174
 175         if self.dospec:
 176             self.draw_spec()
 177
 178         self.xlim = self.sp_iq.get_xlim() # so zoom doesn't get called
 179         draw()
 180
 181     def zoom(self, event):
 182         newxlim = scipy.array(self.sp_iq.get_xlim())
 183         curxlim = scipy.array(self.xlim)
 184         if(newxlim.all() != curxlim.all()):
 185             self.xlim = newxlim
 186             xmin = max(0, int(ceil(self.sample_rate*(self.xlim[0] - self.position))))
 187             xmax = min(int(ceil(self.sample_rate*(self.xlim[1] - self.position))), len(self.iq))
 188
 189             iq = self.iq[xmin : xmax]
 190             time = self.time[xmin : xmax]
 191
 192             iq_psd, freq = self.dopsd(iq)
 193
 194             self.plot_psd[0].set_data(freq, iq_psd)
 195             self.sp_psd.axis([min(freq), max(freq),
 196                               min(iq_psd)-10, max(iq_psd)+10])
 197
 198             draw()
 199
 200     def click(self, event):
 201         forward_valid_keys = [" ", "down", "right"]
 202         backward_valid_keys = ["up", "left"]
 203
 204         if(find(event.key, forward_valid_keys)):
 205             self.step_forward()
 206
 207         elif(find(event.key, backward_valid_keys)):
 208             self.step_backward()
 209
 210     def button_left_click(self, event):
 211         self.step_backward()
 212
 213     def button_right_click(self, event):
 214         self.step_forward()
 215
 216     def step_forward(self):
 217         self.get_data()
 218         self.update_plots()
 219
 220     def step_backward(self):
 221         # Step back in file position
 222         if(self.hfile.tell() >= 2*self.sizeof_data*self.block_length ):
 223             self.hfile.seek(-2*self.sizeof_data*self.block_length, 1)
 224         else:
 225             self.hfile.seek(-self.hfile.tell(),1)
 226         self.get_data()
 227         self.update_plots()
 228
 229 def find(item_in, list_search):
 230     try:
 231         return list_search.index(item_in) != None
 232     except ValueError:
 233         return False
 234
 235 def setup_options():
 236     usage="%prog: [options] input_filename"
 237     description = "Takes a GNU Radio binary file (with specified data type using --data-type) and displays the I&Q data versus time as well as the power spectral density (PSD) plot. The y-axis values are plotted assuming volts as the amplitude of the I&Q streams and converted into dBm in the frequency domain (the 1/N power adjustment out of the FFT is performed internally). The script plots a certain block of data at a time, specified on the command line as -B or --block. The start position in the file can be set by specifying -s or --start and defaults to 0 (the start of 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 and frequency axis, set the sample rate (-R or --sample-rate) to the sample rate used when capturing the samples. Finally, the size of the FFT to use for the PSD and spectrogram plots can be set independently with --psd-size and --spec-size, respectively. The spectrogram plot does not display by default and is turned on with -S or --enable-spec."
 238
 239     parser = OptionParser(conflict_handler="resolve", usage=usage, description=description)
 240     parser.add_option("-d", "--data-type", type="string", default="complex64",
 241                       help="Specify the data type (complex64, float32, (u)int32, (u)int16, (u)int8) [default=%default]")
 242     parser.add_option("-B", "--block", type="int", default=8192,
 243                       help="Specify the block size [default=%default]")
 244     parser.add_option("-s", "--start", type="int", default=0,
 245                       help="Specify where to start in the file [default=%default]")
 246     parser.add_option("-R", "--sample-rate", type="float", default=1.0,
 247                       help="Set the sampler rate of the data [default=%default]")
 248     parser.add_option("", "--psd-size", type="int", default=1024,
 249                       help="Set the size of the PSD FFT [default=%default]")
 250     parser.add_option("", "--spec-size", type="int", default=256,
 251                       help="Set the size of the spectrogram FFT [default=%default]")
 252     parser.add_option("-S", "--enable-spec", action="store_true", default=False,
 253                       help="Turn on plotting the spectrogram [default=%default]")
 254
 255     return parser
 256
 257 def main():
 258     parser = setup_options()
 259     (options, args) = parser.parse_args ()
 260     if len(args) != 1:
 261         parser.print_help()
 262         raise SystemExit, 1
 263     filename = args[0]
 264
 265     dc = gr_plot_psd(options.data_type, filename, options)
 266
 267 if __name__ == "__main__":
 268     try:
 269         main()
 270     except KeyboardInterrupt:
 271         pass
 272
 273
 274