pyart.correct#

Description

Radar Corrections (pyart.correct)#

Correct radar fields.

Velocity unfolding#

dealias_fourdd(radar[, last_radar, ...])

Dealias Doppler velocities using the 4DD algorithm.

dealias_unwrap_phase(radar[, unwrap_unit, ...])

Dealias Doppler velocities using multi-dimensional phase unwrapping.

dealias_region_based(radar[, ref_vel_field, ...])

Dealias Doppler velocities using a region based algorithm.

Attenuation#

calculate_attenuation calculate_attenuation_zphi calculate_attenuation_philinear

Phase processing#

phase_proc_lp(radar, offset[, debug, ...])

Phase process using a LP method [1].

phase_proc_lp_gf(radar[, gatefilter, debug, ...])

Phase process using a LP method [1] using Py-ART's Gatefilter.

det_sys_phase_ray(radar[, ind_rmin, ...])

Public method Alternative determination of the system phase.

correct_sys_phase(radar[, ind_rmin, ...])

correction of the system offset.

smooth_phidp_single_window(radar[, ...])

correction of the system offset and smoothing using one window

smooth_phidp_double_window(radar[, ...])

correction of the system offset and smoothing using two window

Other corrections#

sun_retrieval get_sun_hits get_sun_hits_psr get_sun_hits_ivic correct_vpr correct_vpr_spatialised despeckle_field correct_noise_rhohv correct_bias correct_visibility est_rhohv_rain est_zdr_precip est_zdr_snow selfconsistency_bias selfconsistency_bias2 selfconsistency_kdp_phidp

Helper functions#

find_objects(radar, field, threshold[, ...])

Find objects (i.e., contiguous gates) in one or more sweeps that match thresholds.

get_mask_fzl(radar[, fzl, doc, min_temp, ...])

Constructs a mask to mask data placed thickness m below data at min_temp and beyond.

sun_power(solar_flux, pulse_width, wavelen, ...)

computes the theoretical sun power detected at the antenna [dBm] as it would be without atmospheric attenuation (sun power at top of the atmosphere) for a given solar flux and radar characteristics

ptoa_to_sf(ptoa, pulse_width, wavelen, ...)

Converts the sun power at the top of the atmosphere (in dBm) into solar flux.

solar_flux_lookup(solar_flux, wavelen)

Given the observed solar flux at 10.7 cm wavelength, returns the solar flux at the given radar wavelength

scanning_losses(angle_step, beamwidth)

Given the antenna beam width and the integration angle, compute the losses due to the fact that the sun is not a point target and the antenna is scanning

smooth_masked(raw_data[, wind_len, ...])

smoothes the data using a rolling window.

sun_position_pysolar(dt, lat, lon[, elevation])

obtains the sun position in antenna coordinates using the pysolar library.

sun_position_mfr(dt, lat_deg, lon_deg[, ...])

Calculate the sun position for the given time (dt) at the given position (lat, lon).

compute_apparent_vpr(radar[, ml_top, ...])

Computes the apparent VPR

compute_theoretical_vpr([ml_top, ...])

Computes an idealized vertical profile of reflectivity

Classes

GateFilter(radar[, exclude_based])

A class for building a boolean arrays for filtering gates based on a set of condition typically based on the values in the radar fields.

Functions

calculate_attenuation(radar, z_offset[, ...])

Calculate the attenuation from a polarimetric radar using Z-PHI method.

calculate_attenuation_philinear(radar[, ...])

Calculate the attenuation and the differential attenuation from a polarimetric radar using linear dependece with PhiDP.

calculate_attenuation_zphi(radar[, doc, ...])

Calculate the attenuation and the differential attenuation from a polarimetric radar using Z-PHI method.

compute_apparent_vpr(radar[, ml_top, ...])

Computes the apparent VPR

compute_theoretical_vpr([ml_top, ...])

Computes an idealized vertical profile of reflectivity

correct_bias(radar[, bias, field_name])

Corrects a radar data bias.

correct_noise_rhohv(radar[, urhohv_field, ...])

Corrects RhoHV for noise according to eq.

correct_sys_phase(radar[, ind_rmin, ...])

correction of the system offset.

correct_visibility(radar[, vis_field, ...])

Corrects the reflectivity according to visibility.

correct_vpr(radar[, nvalid_min, angle_min, ...])

Correct VPR using the Meteo-France operational algorithm

correct_vpr_spatialised(radar[, nvalid_min, ...])

Correct VPR using a spatialised version of the Meteo-France operational algorithm

dealias_fourdd(radar[, last_radar, ...])

Dealias Doppler velocities using the 4DD algorithm.

dealias_region_based(radar[, ref_vel_field, ...])

Dealias Doppler velocities using a region based algorithm.

dealias_unwrap_phase(radar[, unwrap_unit, ...])

Dealias Doppler velocities using multi-dimensional phase unwrapping.

despeckle_field(radar, field[, label_dict, ...])

Despeckle a radar volume by identifying small objects in each scan and masking them out.

det_sys_phase_ray(radar[, ind_rmin, ...])

Public method Alternative determination of the system phase.

est_rhohv_rain(radar[, ind_rmin, ind_rmax, ...])

Estimates the quantiles of RhoHV in rain for each sweep

est_zdr_precip(radar[, ind_rmin, ind_rmax, ...])

Filters out all undesired data to be able to estimate ZDR bias, either in moderate rain or from vertically pointing scans

est_zdr_snow(radar[, ind_rmin, ind_rmax, ...])

Filters out all undesired data to be able to estimate ZDR bias in snow

find_objects(radar, field, threshold[, ...])

Find objects (i.e., contiguous gates) in one or more sweeps that match thresholds.

gauss_fit(az_data, az_ref, el_data, el_ref, ...)

estimates a gaussian fit of sun hits data

get_mask_fzl(radar[, fzl, doc, min_temp, ...])

Constructs a mask to mask data placed thickness m below data at min_temp and beyond.

get_sun_hits(radar[, delev_max, dazim_max, ...])

get data from suspected sun hits.

get_sun_hits_ivic(radar[, delev_max, ...])

get data from suspected sun hits.

get_sun_hits_psr(radar[, delev_max, ...])

get data from suspected sun hits.

moment_based_gate_filter(radar[, ncp_field, ...])

Create a filter which removes undesired gates based on moments.

phase_proc_lp(radar, offset[, debug, ...])

Phase process using a LP method [1].

phase_proc_lp_gf(radar[, gatefilter, debug, ...])

Phase process using a LP method [1] using Py-ART's Gatefilter.

ptoa_to_sf(ptoa, pulse_width, wavelen, ...)

Converts the sun power at the top of the atmosphere (in dBm) into solar flux.

retrieval_result(sunhits, alpha, beta, par, npar)

computes the physical parameters of the sun retrieval from the results of a Gaussian fit.

scanning_losses(angle_step, beamwidth)

Given the antenna beam width and the integration angle, compute the losses due to the fact that the sun is not a point target and the antenna is scanning

selfconsistency_bias(radar, zdr_kdpzh_dict)

Estimates reflectivity bias at each ray using the self-consistency algorithm by Gourley

selfconsistency_bias2(radar, zdr_kdpzh_dict)

Estimates reflectivity bias at each ray using the self-consistency algorithm by Gourley

selfconsistency_kdp_phidp(radar, zdr_kdpzh_dict)

Estimates KDP and PhiDP in rain from Zh and ZDR using a selfconsistency relation between ZDR, Zh and KDP.

smooth_masked(raw_data[, wind_len, ...])

smoothes the data using a rolling window.

smooth_phidp_double_window(radar[, ...])

correction of the system offset and smoothing using two window

smooth_phidp_single_window(radar[, ...])

correction of the system offset and smoothing using one window

solar_flux_lookup(solar_flux, wavelen)

Given the observed solar flux at 10.7 cm wavelength, returns the solar flux at the given radar wavelength

sun_position_mfr(dt, lat_deg, lon_deg[, ...])

Calculate the sun position for the given time (dt) at the given position (lat, lon).

sun_position_pysolar(dt, lat, lon[, elevation])

obtains the sun position in antenna coordinates using the pysolar library.

sun_power(solar_flux, pulse_width, wavelen, ...)

computes the theoretical sun power detected at the antenna [dBm] as it would be without atmospheric attenuation (sun power at top of the atmosphere) for a given solar flux and radar characteristics

sun_retrieval(az_rad, az_sun, el_rad, ...[, ...])

Estimates sun parameters from sun hits