pyart.correct.dealias.dealias_fourdd

pyart.correct.dealias.dealias_fourdd(radar, sounding_heights, sounding_wind_speeds, sounding_wind_direction, datetime_sounding, prep=1, filt=1, rsl_badval=131072, keep_original=False, refl=None, vel=None, corr_vel=None, debug=False)

Dealias the Doppler velocities field using the University of Washington 4DD algorithm utilizing information from sounding data.

Parameters :

radar : Radar

Radar object to use for dealiasing. Must have a Nyquist defined in the instrument_parameters attribute and have a reflectivity_horizontal and mean_doppler_velocity fields.

sounding_heights : array

Sounding heights is meters above mean sea level. If altitude attribute of the radar object if reference against something other than mean sea level then this parameter should also be referenced in that manner.

sounding_wind_speeds : array

Sounding wind speeds in m/s.

sounding_wind_direction : array

Sounding wind directions in degrees.

datetime_sounding : datetime

Datetime representing the mean time of the sounding profile.

Returns :

dealiased_fielddict : dict

Field dictionary containing dealiased doppler velocities. Dealiased array is stored under the ‘data’ key.

Other Parameters:  

prep : int

Flag controlling thresholding, 1 = yes, 0 = no.

filt : int

Flag controlling Bergen and Albers filter, 1 = yes, 0 = no.

rsl_badval : int

Value which represented a bad, masked, points in RSL.

keep_original : bool

True to keep original doppler velocity values when the dealiasing procedure fails, otherwises these gates will be masked. NaN values are still masked.

refl : str

Field in radar to use as the doppler velocities during dealiasing. None will use the default field name from the Py-ART configuration file.

vel : str

Field in radar to use as the reflectivity during dealiasing. None will use the default field name from the Py-ART configuration file.

corr_vel : str

Name to use for the dealiased doppler velocity field metadata. None will use the default field name from the Py-ART configuration file.

debug : bool

Set True to return RSL Volume objects for debugging: usuccess, DZvolume, radialVelVolume, unfoldedVolume, sondVolume

Notes

Due to limitations in the C code do not call with numpy arrays over 900 elements long

References

C. N. James and R. A Houze Jr, A Real-Time Four-Dimensional Doppler Dealising Scheme, Journal of Atmospheric and Oceanic Technology, 2001, 18, 1674.