git.gag.com Git - debian/gnuradio/blob - gr-utils/src/python/gr_plot_fft.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
  38 class gr_plot_fft:
  39     def __init__(self, datatype, 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 = getattr(scipy, datatype)
  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         self.text_size = 22
  52
  53         # Setup PLOT
  54         self.fig = figure(1, figsize=(16, 12), facecolor='w')
  55         rcParams['xtick.labelsize'] = self.axis_font_size
  56         rcParams['ytick.labelsize'] = self.axis_font_size
  57
  58         self.text_file     = figtext(0.10, 0.94, ("File: %s" % filename), weight="heavy", size=self.text_size)
  59         self.text_file_pos = figtext(0.10, 0.88, "File Position: ", weight="heavy", size=self.text_size)
  60         self.text_block    = figtext(0.35, 0.88, ("Block Size: %d" % self.block_length),
  61                                      weight="heavy", size=self.text_size)
  62         self.text_sr       = figtext(0.60, 0.88, ("Sample Rate: %.2f" % self.sample_rate),
  63                                      weight="heavy", size=self.text_size)
  64         self.make_plots()
  65
  66         self.button_left_axes = self.fig.add_axes([0.45, 0.01, 0.05, 0.05], frameon=True)
  67         self.button_left = Button(self.button_left_axes, "<")
  68         self.button_left_callback = self.button_left.on_clicked(self.button_left_click)
  69
  70         self.button_right_axes = self.fig.add_axes([0.50, 0.01, 0.05, 0.05], frameon=True)
  71         self.button_right = Button(self.button_right_axes, ">")
  72         self.button_right_callback = self.button_right.on_clicked(self.button_right_click)
  73
  74         self.xlim = self.sp_iq.get_xlim()
  75
  76         self.manager = get_current_fig_manager()
  77         connect('draw_event', self.zoom)
  78         connect('key_press_event', self.click)
  79         show()
  80
  81     def get_data(self):
  82         self.position = self.hfile.tell()/self.sizeof_data
  83         self.text_file_pos.set_text("File Position: %d" % (self.position))
  84         self.iq = scipy.fromfile(self.hfile, dtype=self.datatype, count=self.block_length)
  85         #print "Read in %d items" % len(self.iq)
  86         if(len(self.iq) == 0):
  87             print "End of File"
  88         else:
  89             self.iq_fft = self.dofft(self.iq)
  90
  91             tstep = 1.0 / self.sample_rate
  92             self.time = [tstep*(self.position + i) for i in xrange(len(self.iq))]
  93
  94             self.freq = self.calc_freq(self.time, self.sample_rate)
  95
  96     def dofft(self, iq):
  97         N = len(iq)
  98         iq_fft = fftpack.fftshift(scipy.fft(iq))       # fft and shift axis
  99         iq_fft = 20*scipy.log10(abs((iq_fft+1e-15)/N)) # convert to decibels, adjust power
 100         # adding 1e-15 (-300 dB) to protect against value errors if an item in iq_fft is 0
 101         return iq_fft
 102
 103     def calc_freq(self, time, sample_rate):
 104         N = len(time)
 105         Fs = 1.0 / (max(time) - min(time))
 106         Fn = 0.5 * sample_rate
 107         freq = [-Fn + i*Fs for i in xrange(N)]
 108         return freq
 109
 110     def make_plots(self):
 111         # if specified on the command-line, set file pointer
 112         self.hfile.seek(self.sizeof_data*self.start, 1)
 113
 114         # Subplot for real and imaginary parts of signal
 115         self.sp_iq = self.fig.add_subplot(2,2,1, position=[0.075, 0.2, 0.4, 0.6])
 116         self.sp_iq.set_title(("I&Q"), fontsize=self.title_font_size, fontweight="bold")
 117         self.sp_iq.set_xlabel("Time (s)", fontsize=self.label_font_size, fontweight="bold")
 118         self.sp_iq.set_ylabel("Amplitude (V)", fontsize=self.label_font_size, fontweight="bold")
 119
 120         # Subplot for FFT plot
 121         self.sp_fft = self.fig.add_subplot(2,2,2, position=[0.575, 0.2, 0.4, 0.6])
 122         self.sp_fft.set_title(("FFT"), fontsize=self.title_font_size, fontweight="bold")
 123         self.sp_fft.set_xlabel("Frequency (Hz)", fontsize=self.label_font_size, fontweight="bold")
 124         self.sp_fft.set_ylabel("Power Spectrum (dBm)", fontsize=self.label_font_size, fontweight="bold")
 125
 126         self.get_data()
 127
 128         self.plot_iq  = self.sp_iq.plot([], 'bo-') # make plot for reals
 129         self.plot_iq += self.sp_iq.plot([], 'ro-') # make plot for imags
 130         self.draw_time()                           # draw the plot
 131
 132         self.plot_fft = self.sp_fft.plot([], 'bo-')  # make plot for FFT
 133         self.draw_fft()                              # draw the plot
 134
 135         draw()
 136
 137     def draw_time(self):
 138         reals = self.iq.real
 139         imags = self.iq.imag
 140         self.plot_iq[0].set_data([self.time, reals])
 141         self.plot_iq[1].set_data([self.time, imags])
 142         self.sp_iq.set_xlim(min(self.time), max(self.time))
 143         self.sp_iq.set_ylim([1.5*min([min(reals), min(imags)]),
 144                              1.5*max([max(reals), max(imags)])])
 145
 146     def draw_fft(self):
 147         self.plot_fft[0].set_data([self.freq, self.iq_fft])
 148         self.sp_fft.set_xlim(min(self.freq), max(self.freq))
 149         self.sp_fft.set_ylim([min(self.iq_fft)-10, max(self.iq_fft)+10])
 150
 151     def update_plots(self):
 152         self.draw_time()
 153         self.draw_fft()
 154
 155         self.xlim = self.sp_iq.get_xlim()
 156         draw()
 157
 158     def zoom(self, event):
 159         newxlim = scipy.array(self.sp_iq.get_xlim())
 160         curxlim = scipy.array(self.xlim)
 161         if(newxlim.all() != curxlim.all()):
 162             self.xlim = newxlim
 163             xmin = max(0, int(ceil(self.sample_rate*(self.xlim[0] - self.position))))
 164             xmax = min(int(ceil(self.sample_rate*(self.xlim[1] - self.position))), len(self.iq))
 165
 166             iq = self.iq[xmin : xmax]
 167             time = self.time[xmin : xmax]
 168
 169             iq_fft = self.dofft(iq)
 170             freq = self.calc_freq(time, self.sample_rate)
 171
 172             self.plot_fft[0].set_data(freq, iq_fft)
 173             self.sp_fft.axis([min(freq), max(freq),
 174                               min(iq_fft)-10, max(iq_fft)+10])
 175
 176             draw()
 177
 178     def click(self, event):
 179         forward_valid_keys = [" ", "down", "right"]
 180         backward_valid_keys = ["up", "left"]
 181
 182         if(find(event.key, forward_valid_keys)):
 183             self.step_forward()
 184
 185         elif(find(event.key, backward_valid_keys)):
 186             self.step_backward()
 187
 188     def button_left_click(self, event):
 189         self.step_backward()
 190
 191     def button_right_click(self, event):
 192         self.step_forward()
 193
 194     def step_forward(self):
 195         self.get_data()
 196         self.update_plots()
 197
 198     def step_backward(self):
 199         # Step back in file position
 200         if(self.hfile.tell() >= 2*self.sizeof_data*self.block_length ):
 201             self.hfile.seek(-2*self.sizeof_data*self.block_length, 1)
 202         else:
 203             self.hfile.seek(-self.hfile.tell(),1)
 204         self.get_data()
 205         self.update_plots()
 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 def setup_options():
 214     usage="%prog: [options] input_filename"
 215     description = "Takes a GNU Radio complex binary file and displays the I&Q data versus time as well as the frequency domain (FFT) 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. This value defaults to 1000. 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."
 216
 217     parser = OptionParser(conflict_handler="resolve", usage=usage, description=description)
 218     parser.add_option("-d", "--data-type", type="string", default="complex64",
 219                       help="Specify the data type (complex64, float32, (u)int32, (u)int16, (u)int8) [default=%default]")
 220     parser.add_option("-B", "--block", type="int", default=1000,
 221                       help="Specify the block size [default=%default]")
 222     parser.add_option("-s", "--start", type="int", default=0,
 223                       help="Specify where to start in the file [default=%default]")
 224     parser.add_option("-R", "--sample-rate", type="float", default=1.0,
 225                       help="Set the sampler rate of the data [default=%default]")
 226     return parser
 227
 228 def main():
 229     parser = setup_options()
 230     (options, args) = parser.parse_args ()
 231     if len(args) != 1:
 232         parser.print_help()
 233         raise SystemExit, 1
 234     filename = args[0]
 235
 236     dc = gr_plot_fft(options.data_type, filename, options)
 237
 238 if __name__ == "__main__":
 239     try:
 240         main()
 241     except KeyboardInterrupt:
 242         pass
 243
 244
 245