gnssrefl.simple_vegetation_correction module
Simple vegetation correction model for VWC estimation. The default and only option until October 2025.
- gnssrefl.simple_vegetation_correction.save_individual_track_data(station, vxyz, extension, fr)
Save individual track files for model 1. Columns 10-17 (model-2-specific) are written as NaN since model 1 corrects aggregate bins, not individual tracks.
- Parameters:
station (str) – Station name
vxyz (numpy array) – Track-level observations (N x 18)
extension (str) – Extension used in the analysis json
fr (int) – Frequency code
- gnssrefl.simple_vegetation_correction.simple_vegetation_filter(station, vxyz, extension='', bin_hours=24, bin_offset=0, plt2screen=True, fr=20, minvalperbin=10, skip_plots=False, save_tracks=False)
Simple vegetation model (model 1)
This function applies the simple vegetation correction filter to a vxyz array input. This was the default and only available vegetation correction until October 2025.
- Parameters:
station (str) – 4-char GNSS station name
vxyz (numpy array) – Track-level phase observations (16 columns)
extension (str) – Extension used in the analysis json (default: ‘’)
bin_hours (int) – Time bin size for subdaily support (default: 24)
bin_offset (int) – Bin timing offset for subdaily support (default: 0)
plt2screen (bool) – Whether plots come to the screen (default: True)
fr (int) – Frequency code (1=L1, 5=L5, 20=L2C, default: 20)
minvalperbin (int, optional) – Minimum observations required per time bin (default: 10)
skip_plots (bool, optional) – Skip saving diagnostic plots (default: False). Used by vwc_hourly to avoid generating redundant per-offset plots.
save_tracks (bool, optional) – Save individual track data files (default: False). Columns 10-17 are NaN since model 1 does not compute per-track corrections.
- Returns:
Dictionary containing: - ‘mjd’: list of Modified Julian Day values - ‘vwc’: numpy array of VWC values (percentage units, not leveled) - ‘datetime’: list of datetime objects for plotting - ‘bin_starts’: numpy array of bin start hours (subdaily) or empty list (daily)
- Return type:
dict