Houston, we have a trunk.
[debian/gnuradio] / gr-radio-astronomy / src / python / usrp_ra_receiver.help
1 This program is used to take spectra and total power measurements.
2   It records spectral and total-power data to external datalogging
3   files.
4
5 The program takes the following options:
6
7   --rx-subdev-spec     which USRP Rx side?  A or B
8
9   --decim              USRP decimation rate: 8, 16, 32, and 64 are good
10                        (8Mhz, 4Mhz, 2Mhz, and 1Mhz bandwidth)
11
12   --freq               USRP daughtercard frequency
13
14   --observing          Actual observing frequency (default is to use the
15                        setting for --freq)
16
17   --avg                Averaging setting for spectral display--higher numbers
18                        equal more averaging.  25 to 40 is typical.
19
20   --integ              Total power integration time: seconds
21
22   --gain               USRP daughtercard gain control
23
24   --reflevel           Reference level on pulse profile display
25
26   --longitude          Observer longitude: West is negative
27
28   --latitude           Observer latitude:  South is negative
29
30   --fft_size           Size of FFT for post-detector spectrum: default is 1024
31
32   --prefix             Filename prefix to use for data logging files
33                        Default is ./
34
35   --divbase            The base of the Y/Div menu in pulsar display
36
37   --division           The initial Y/Div in pulsar display
38
39   --ylabel             Y axis label
40
41   --cfunc              The function name prefix for the spectral and
42                        calibrator functions
43
44   --waterfall          Use waterfall, rather than regular spectral display
45                        NOT TESTED IN THIS APPLICATION
46
47   --stripsize          Size of the total-power stripchart, in samples
48
49 There are two windows--a spectral window, and the total-power window.
50   Moving the cursor around in the spectral window shows you the
51   corresponding frequency and doppler shift.  Left clicking in this
52   window sets an interference marker, which sets a "zero" in the
53   interference filter.  Use the "clear interference" button to clear this.
54
55 The total power window is updated at a fixed 2Hz rate, and grows from
56   the left of the display.
57
58 If latitude and longitude are set correctly, and system time is correct,
59   then the current LMST is displayed, updated once per second.
60
61 Averaging parameters, gain, and frequency can all be set from the GUI using
62   the appropriate controls.  You can also enter the current declination, which
63   will appear in the datalogging files.  This is useful both for mapping,
64   and housekeeping purposes, particularly when you haven't looked at a datafile
65   for quite some time.
66
67 There are two datalog files produced by this program:
68
69      YYYYMMDDHH.tpdat      Total power data
70
71      The date/time portion of the filename is referred to local time,
72      rather than UTC or sidereal.
73
74      First field is sidereal time when sample was taken
75      Second field is total power datum
76      Third field is declination in decimal degrees
77
78      Samples are written once per second
79
80      YYYYMMDDHH.sdat       Spectral data
81
82      The date/time portion of the filename is referred to local time,
83      rather than UTC or sidereal.
84
85      First field is sidereal time when spectrum was taken
86      Second field is declination in decimal degrees
87      Third field is complex spectral data--in the same order that FFTW3 library
88          places bins:  DC to bandwidth/2, followed by -bandwidth/2 to DC.
89
90      Spectral snapshots are written once every 5 seconds