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),
  64                                      weight="heavy", size=self.text_size)
  65         self.text_file_pos = figtext(0.10, 0.92, "File Position: ",
  66                                      weight="heavy", size=self.text_size)
  67         self.text_block    = figtext(0.35, 0.92, ("Block Size: %d" % self.block_length),
  68                                      weight="heavy", size=self.text_size)
  69         self.text_sr       = figtext(0.60, 0.915, ("Sample Rate: %.2f" % self.sample_rate),
  70                                      weight="heavy", size=self.text_size)
  71         self.make_plots()
  72
  73         self.button_left_axes = self.fig.add_axes([0.45, 0.01, 0.05, 0.05], frameon=True)
  74         self.button_left = Button(self.button_left_axes, "<")
  75         self.button_left_callback = self.button_left.on_clicked(self.button_left_click)
  76
  77         self.button_right_axes = self.fig.add_axes([0.50, 0.01, 0.05, 0.05], frameon=True)
  78         self.button_right = Button(self.button_right_axes, ">")
  79         self.button_right_callback = self.button_right.on_clicked(self.button_right_click)
  80
  81         self.xlim = self.sp_iq.get_xlim()
  82
  83         self.manager = get_current_fig_manager()
  84         connect('draw_event', self.zoom)
  85         connect('key_press_event', self.click)
  86         show()
  87
  88     def get_data(self):
  89         self.position = self.hfile.tell()/self.sizeof_data
  90         self.text_file_pos.set_text("File Position: %d" % self.position)
  91         try:
  92             self.iq = scipy.fromfile(self.hfile, dtype=self.datatype, count=self.block_length)
  93         except MemoryError:
  94             print "End of File"
  95         else:
  96             tstep = 1.0 / self.sample_rate
  97             self.time = [tstep*(self.position + i) for i in xrange(len(self.iq))]
  98
  99             self.iq_psd, self.freq = self.dopsd(self.iq)
 100
 101     def dopsd(self, iq):
 102         ''' Need to do this here and plot later so we can do the fftshift '''
 103         overlap = self.psdfftsize/4
 104         winfunc = scipy.blackman
 105         psd,freq = self.sp_psd.psd(iq, self.psdfftsize, self.sample_rate,
 106                                    window = lambda d: d*winfunc(self.psdfftsize),
 107                                    noverlap = overlap, visible=False)
 108         psd = 10.0*log10(abs(fftpack.fftshift(psd)))
 109         return (psd, freq)
 110
 111     def make_plots(self):
 112         # if specified on the command-line, set file pointer
 113         self.hfile.seek(self.sizeof_data*self.start, 1)
 114
 115         iqdims = [[0.075, 0.2, 0.4, 0.6], [0.075, 0.55, 0.4, 0.3]]
 116         psddims = [[0.575, 0.2, 0.4, 0.6], [0.575, 0.55, 0.4, 0.3]]
 117         specdims = [0.2, 0.125, 0.6, 0.3]
 118
 119         # Subplot for real and imaginary parts of signal
 120         self.sp_iq = self.fig.add_subplot(2,2,1, position=iqdims[self.dospec])
 121         self.sp_iq.set_title(("I&Q"), fontsize=self.title_font_size, fontweight="bold")
 122         self.sp_iq.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
 123         self.sp_iq.set_ylabel("Amplitude (V)", fontsize=self.label_font_size, fontweight="bold")
 124
 125         # Subplot for PSD plot
 126         self.sp_psd = self.fig.add_subplot(2,2,2, position=psddims[self.dospec])
 127         self.sp_psd.set_title(("PSD"), fontsize=self.title_font_size, fontweight="bold")
 128         self.sp_psd.set_xlabel("Frequency (Hz)", fontsize=self.label_font_size, fontweight="bold")
 129         self.sp_psd.set_ylabel("Power Spectrum (dBm)", fontsize=self.label_font_size, fontweight="bold")
 130
 131         self.get_data()
 132
 133         self.plot_iq  = self.sp_iq.plot([], 'bo-') # make plot for reals
 134         self.plot_iq += self.sp_iq.plot([], 'ro-') # make plot for imags
 135         self.draw_time()                           # draw the plot
 136
 137         self.plot_psd = self.sp_psd.plot([], 'b')  # make plot for PSD
 138         self.draw_psd()                            # draw the plot
 139
 140
 141         if self.dospec:
 142             # Subplot for spectrogram plot
 143             self.sp_spec = self.fig.add_subplot(2,2,3, position=specdims)
 144             self.sp_spec.set_title(("Spectrogram"), fontsize=self.title_font_size, fontweight="bold")
 145             self.sp_spec.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
 146             self.sp_spec.set_ylabel("Frequency (Hz)", fontsize=self.label_font_size, fontweight="bold")
 147
 148             self.draw_spec()
 149
 150         draw()
 151
 152     def draw_time(self):
 153         reals = self.iq.real
 154         imags = self.iq.imag
 155         self.plot_iq[0].set_data([self.time, reals])
 156         self.plot_iq[1].set_data([self.time, imags])
 157         self.sp_iq.set_xlim(min(self.time), max(self.time))
 158         self.sp_iq.set_ylim([1.5*min([min(reals), min(imags)]),
 159                              1.5*max([max(reals), max(imags)])])
 160
 161     def draw_psd(self):
 162         self.plot_psd[0].set_data([self.freq, self.iq_psd])
 163         self.sp_psd.set_ylim([min(self.iq_psd)-10, max(self.iq_psd)+10])
 164
 165     def draw_spec(self):
 166         overlap = self.specfftsize/4
 167         winfunc = scipy.blackman
 168         self.sp_spec.clear()
 169         self.sp_spec.specgram(self.iq, self.specfftsize, self.sample_rate,
 170                               window = lambda d: d*winfunc(self.specfftsize),
 171                               noverlap = overlap, xextent=[min(self.time), max(self.time)])
 172
 173     def update_plots(self):
 174         self.draw_time()
 175         self.draw_psd()
 176
 177         if self.dospec:
 178             self.draw_spec()
 179
 180         self.xlim = self.sp_iq.get_xlim() # so zoom doesn't get called
 181         draw()
 182
 183     def zoom(self, event):
 184         newxlim = scipy.array(self.sp_iq.get_xlim())
 185         curxlim = scipy.array(self.xlim)
 186         if(newxlim.all() != curxlim.all()):
 187             self.xlim = newxlim
 188             xmin = max(0, int(ceil(self.sample_rate*(self.xlim[0] - self.position))))
 189             xmax = min(int(ceil(self.sample_rate*(self.xlim[1] - self.position))), len(self.iq))
 190
 191             iq = self.iq[xmin : xmax]
 192             time = self.time[xmin : xmax]
 193
 194             iq_psd, freq = self.dopsd(iq)
 195
 196             self.plot_psd[0].set_data(freq, iq_psd)
 197             self.sp_psd.axis([min(freq), max(freq),
 198                               min(iq_psd)-10, max(iq_psd)+10])
 199
 200             draw()
 201
 202     def click(self, event):
 203         forward_valid_keys = [" ", "down", "right"]
 204         backward_valid_keys = ["up", "left"]
 205
 206         if(find(event.key, forward_valid_keys)):
 207             self.step_forward()
 208
 209         elif(find(event.key, backward_valid_keys)):
 210             self.step_backward()
 211
 212     def button_left_click(self, event):
 213         self.step_backward()
 214
 215     def button_right_click(self, event):
 216         self.step_forward()
 217
 218     def step_forward(self):
 219         self.get_data()
 220         self.update_plots()
 221
 222     def step_backward(self):
 223         # Step back in file position
 224         if(self.hfile.tell() >= 2*self.sizeof_data*self.block_length ):
 225             self.hfile.seek(-2*self.sizeof_data*self.block_length, 1)
 226         else:
 227             self.hfile.seek(-self.hfile.tell(),1)
 228         self.get_data()
 229         self.update_plots()
 230
 231 def find(item_in, list_search):
 232     try:
 233         return list_search.index(item_in) != None
 234     except ValueError:
 235         return False
 236
 237 def setup_options():
 238     usage="%prog: [options] input_filename"
 239     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."
 240
 241     parser = OptionParser(conflict_handler="resolve", usage=usage, description=description)
 242     parser.add_option("-d", "--data-type", type="string", default="complex64",
 243                       help="Specify the data type (complex64, float32, (u)int32, (u)int16, (u)int8) [default=%default]")
 244     parser.add_option("-B", "--block", type="int", default=8192,
 245                       help="Specify the block size [default=%default]")
 246     parser.add_option("-s", "--start", type="int", default=0,
 247                       help="Specify where to start in the file [default=%default]")
 248     parser.add_option("-R", "--sample-rate", type="float", default=1.0,
 249                       help="Set the sampler rate of the data [default=%default]")
 250     parser.add_option("", "--psd-size", type="int", default=1024,
 251                       help="Set the size of the PSD FFT [default=%default]")
 252     parser.add_option("", "--spec-size", type="int", default=256,
 253                       help="Set the size of the spectrogram FFT [default=%default]")
 254     parser.add_option("-S", "--enable-spec", action="store_true", default=False,
 255                       help="Turn on plotting the spectrogram [default=%default]")
 256
 257     return parser
 258
 259 def main():
 260     parser = setup_options()
 261     (options, args) = parser.parse_args ()
 262     if len(args) != 1:
 263         parser.print_help()
 264         raise SystemExit, 1
 265     filename = args[0]
 266
 267     dc = gr_plot_psd(options.data_type, filename, options)
 268
 269 if __name__ == "__main__":
 270     try:
 271         main()
 272     except KeyboardInterrupt:
 273         pass
 274
 275
 276