pyart.correct.calculate_attenuation_philinear#

pyart.correct.calculate_attenuation_philinear(radar, doc=None, fzl=None, pia_coef=None, gatefilter=None, pida_coef=None, refl_field=None, phidp_field=None, zdr_field=None, temp_field=None, iso0_field=None, spec_at_field=None, pia_field=None, corr_refl_field=None, spec_diff_at_field=None, pida_field=None, corr_zdr_field=None, temp_ref='temperature')[source]#

Calculate the attenuation and the differential attenuation from a polarimetric radar using linear dependece with PhiDP. The attenuation is computed up to a user defined freezing level height, where temperatures in a temperature field are positive or where the height relative to the iso0 is 0. The coefficients are either user-defined or radar frequency dependent.

Parameters:

  • radar (Radar) – Radar object to use for attenuation calculations. Must have phidp and refl fields.

  • doc (float, optional) – Number of gates at the end of each ray to to remove from the calculation.

  • fzl (float, optional) – Freezing layer, gates above this point are not included in the correction.

  • gatefilter (GateFilter, optional) – The gates to exclude from the calculation. This, combined with the gates above fzl, will be excluded from the correction. Set to None to not use a gatefilter.

  • pia_coef (float, optional) – Coefficient in path integrated attenuation calculation

  • pida_coeff (float, optional) – Coefficient in path integrated differential attenuation calculation

  • refl_field (str, optional) – Name of the reflectivity field used for the attenuation correction. A value of None for any of these parameters will use the default field name as defined in the Py-ART configuration file.

  • phidp_field (str, optional) – Name of the differential phase field used for the attenuation correction. A value of None for any of these parameters will use the default field name as defined in the Py-ART configuration file.

  • zdr_field (str, optional) – Name of the differential reflectivity field used for the attenuation correction. A value of None for any of these parameters will use the default field name as defined in the Py-ART configuration file. This will only be used if it is available.

  • temp_field (str, optional) – Name of the temperature field used for the attenuation correction. A value of None for any of these parameters will use the default field name as defined in the Py-ART configuration file.

  • iso0_field (str, optional) – Name of the field for the height above the 0C isotherm for the attenuation correction. A value of None for any of these parameters will use the default field name as defined in the Py-ART configuration file. This will only be used if it is available.

  • spec_at_field (str, optional) – Name of the specific attenuation field that will be used to fill in the metadata for the returned fields. A value of None for any of these parameters will use the default field names as defined in the Py-ART configuration file.

  • pia_field (str, optional) – Name of the path integrated attenuation field that will be used to fill in the metadata for the returned fields. A value of None for any of these parameters will use the default field names as defined in the Py-ART configuration file.

  • corr_refl_field (str, optional) – Name of the corrected reflectivity field that will be used to fill in the metadata for the returned fields. A value of None for any of these parameters will use the default field names as defined in the Py-ART configuration file.

  • spec_diff_at_field (str, optional) – Name of the specific differential attenuation field that will be used to fill in the metadata for the returned fields. A value of None for any of these parameters will use the default field names as defined in the Py-ART configuration file. This will only be calculated if ZDR is available.

  • corr_zdr_field (str, optional) – Name of the corrected differential reflectivity field that will be used to fill in the metadata for the returned fields. A value of None for any of these parameters will use the default field names as defined in the Py-ART configuration file. This will only be calculated if ZDR is available.

  • temp_ref (str, optional) – The field use as reference for temperature. Can be either temperature, height_over_iso0 or fixed_fzl.

Returns:

  • spec_at (dict) – Field dictionary containing the specific attenuation.

  • pia_dict (dict) – Field dictionary containing the path integrated attenuation.

  • cor_z (dict) – Field dictionary containing the corrected reflectivity.

  • spec_diff_at (dict) – Field dictionary containing the specific differential attenuation.

  • pida_dict (dict) – Field dictionary containing the path integrated differential attenuation.

  • cor_zdr (dict) – Field dictionary containing the corrected differential reflectivity.