pyart.correct.correct_vpr#

pyart.correct.correct_vpr(radar, nvalid_min=20, angle_min=0.0, angle_max=4.0, ml_thickness_min=200.0, ml_thickness_max=800.0, ml_thickness_step=200.0, iso0_max=5000.0, ml_top_diff_max=200.0, ml_top_step=200.0, ml_peak_min=1.0, ml_peak_max=6.0, ml_peak_step=1.0, dr_min=-6.0, dr_max=-1.5, dr_step=1.5, dr_default=-4.5, dr_alt=800.0, h_max=6000.0, h_corr_max=15000.0, h_res=1.0, max_weight=9.0, rmin_obs=5000.0, rmax_obs=150000.0, iso0=None, filter_params=False, weight_mem=0.75, vpr_theo_dict_mem=None, radar_mem_list=None, refl_field=None, lin_refl_field=None, norm_refl_field=None, corr_refl_field=None, corr_field=None, temp_field=None, iso0_field=None, temp_ref=None)[source]#

Correct VPR using the Meteo-France operational algorithm

Parameters:

  • radar (Radar) – Radar object

  • nvalid_min (int) – Minimum number of rays with data to consider the azimuthal average valid

  • angle_min, angle_max (float) – Minimum and maximum elevation angles used to compute the ratios of reflectivity

  • ml_thickness_min, ml_thickness_max, ml_thickness_step (float) – Minimum, maximum and step of the melting layer thickness of the models to explore [m]

  • iso0_max (float) – maximum iso0 altitude of the profile

  • ml_top_diff_max, ml_top_step (float) – maximum difference +- between iso-0 and top of the melting layer [m] of the models to explore. Step

  • ml_peak_min, ml_peak_max, ml_peak_step (float) – min, max and step of the value at the peak of the melting layer of the models to explore

  • dr_min, dr_max, dr_step (float) – min, max and step of the decreasing ratio above the melting layer

  • dr_default (float) – default decreasing ratio to use if a proper model could not be found

  • dr_alt (float) – altitude above the melting layer top where theoretical profile needs to be defined to be able to compute DR. If the theoretical profile is not defined up to the resulting altitude a default DR is used

  • h_max (float) – maximum altitude [masl] where to compute the model profile

  • h_corr_max (float) – maximum altitude [masl] considered for the VPR correction

  • h_res (float) – resolution of the model profile (m)

  • max_weight (float) – Maximum weight of the antenna pattern

  • rmin_obs, rmax_obs (float) – minimum and maximum range (m) of the observations that are compared with the model

  • iso0 (float) – reference iso0 value

  • filter_params (bool) – If True filters the current theoretical VPR profile with the previous theoretical VPR profile by averaging the 4 parameters that define the profile. If false the averaging is done on the shape of the profile

  • weight_mem (float) – Weight given to the previous VPR retrieval when filtering the current VPR retrieval by the previous one

  • vpr_theo_dict_mem (dict or None) – Dictionary containing the theoretical VPR computed in the previous time step

  • radar_mem_list (list of radar objects or None) – list of radar objects that contain the azimuthally averaged reflectivity computed in the past

  • refl_field (str) – Name of the reflectivity field to correct

  • lin_refl_field (str) – Name of the linear reflectivity field

  • norm_refl_field (str) – Name of the normalized linear reflectivity field

  • corr_refl_field (str) – Name of the VPR-corrected reflectivity field

  • corr_field (str) – Name of the VPR correction field

  • temp_field, iso0_field (str) – Name of the temperature and height over the iso-0 fields

  • temp_ref (str) – the field use as reference for temperature. Can be temperature or height_over_iso0.

Returns:

  • refl_corr_dict (dict) – The corrected reflectivity

  • corr_field_dict (dict) – The correction applied

  • vpr_theo_dict_filtered (dict) – The theoretical VPR profile used for the correction

  • radar_rhi (radar object) – A radar object containing the azimuthally averaged reflectivity in linear units