gnssrefl.quickLook_cl module

quickLook command line function

gnssrefl.quickLook_cl.quicklook(station: str, year: int, doy: int, snr: int = 66, fr: int = 1, ampl: float = 7.0, e1: float = 5, e2: float = 25, h1: float = 0.5, h2: float = 8.0, sat: int = None, peak2noise: float = 3.0, screenstats: bool = False, fortran: bool = None, plt: bool = True, azim1: float = 0.0, azim2: float = 360.0, ediff: float = 2.0, delTmax: float = 75.0, hires_figs: bool = False)

quickLook assessment of GNSS-IR results using SNR data. It creates two plots: one with periodograms for four different quadrants (northwest, northeast, southeast, southwest) and the other with the RH results shown as a function of azimuth. This plot also summarizes why the RH retrievals were accepted or rejected in terms of the quality control parameters.


quickLook p041 2023 1

analyzes station p041 on day of year 1 in the year 2023 with defaults (L1, e1=5, e2=25)

quickLook p041 2023 1 -h1 1 -h2 10

analyzes station p041 on day of year 1 in the year 2023. The periodogram would be restricted to RH of 1-10 meters.

If your site name is in the GNSS-IR database (which is generated from the Nevada Reno geodesy group), a standard refraction correction is applied. If not, it does not. This is most relevant for very very tall sites, i.e. > 200 meters. Refraction models are always applied in the gnssir module.

If users would like the refraction correction to be applied here for stations that are not in the standard database, they need to submit a pull request making that possible. One option is to read from an existing gnssir_input json file. That is what is done in nmea2snr and invsnr_input.

  • station (str) – 4 character ID of the station

  • year (int) – Year

  • doy (int) – Day of year

  • snr (int, optional) – SNR format. This tells the code which SNR file to use. 66 is the default. Other options: 50, 88, and 99.

  • f (int, optional.) –

    GNSS frequency. Default is GPS L1 value options:

    1,2,20,5 : GPS L1,L2,L2C,L5 (1 is default)

    101,102 : GLONASS L1 and L2

    201,205,206,207,208 : GALILEO E1 E5a E6,E5b,E5

    302,306,307 : BEIDOU B1, B3, B2

  • reqAmp (int or array_like, optional) – Lomb-Scargle Periodogram (LSP) amplitude significance criterion in volts/volts. Default is 7

  • e1 (int, optional) – elevation angle lower limit in degrees for the LSP. default is 5.

  • e2 (int, optional) – elevation angle upper limit in degrees for the LSP. default is 25.

  • h1 (float, optional) – The allowed LSP reflector height lower limit in meters. default is 0.5.

  • h2 (float, optional) – The allowed LSP reflector height upper limit in meters. default is 6.

  • sat (integer, optional) – specific satellite number, default is None.

  • peak2noise (int, optional) – peak to noise ratio of the periodogram values (periodogram peak divided by the periodogram noise). For snow and ice, 3.5 or greater, tides can be tricky if the water is rough (and thus you might go below 3 a bit, say 2.7 default is 3.

  • screenstats (boolean, optional) – Whether to print stats to the screen. default is False.

  • plt (boolean, optional) – Whether to print plots to the screen. default is True. Regardless, png files are made

  • azim1 (float, optional) – minimum azimuth angle (deg) default is 0.

  • azim2 (float, optional) – maximum azimuth angle (deg) default is 360.

  • ediff (float, optional) – elevation angle difference, quality control parameter default is 2 degrees.

  • delTmax (float, optional) – maximum allowed arc length, in minutes default is 75 minutes.

  • hires_figs (bool, optional) – eps instead of png files