radtraq.proc.extract_rhi_profile

radtraq.proc.extract_rhi_profile(obj, append_obj=None, variables=None, elevation_range=[89, 91], elevation_name='elevation', sweep_variables=['sweep_start_ray_index', 'sweep_end_ray_index'])[source]

Function for extracting vertical profile over a location from a RHI scan

Parameters:

  • obj (Xarray.Dataset) – Xarray object with all the data. Requires the additional variables in sweep_variables for finding sweeps. They will be removed from returned Dataset to allow concatination.

  • append_obj (Xarray.Dataset) – If provided will append extracted profiles to this object.

  • variables (str, list, None) – List of variables to return in extracted Dataset. If set to None returns all variables in the Dataset.

  • elevation_range (list) – Range of elevation values to use in subsetting to find a vertical profile. Will return profile closest to 90 degrees for each RHI scan that fits within this range. If the scan does not have a value within this range, will skip that scan. Assumed to be in degrees.

  • elevation_name (string) – Variable name in Xarray object containing elevation values. Assumed to be in degrees.

  • sweep_variables (list of str) – Variable names used to determine sweeps to extract profile.

Returns:

obj – Xarray Dataset with profile extracted and new coordinate variable height added or if unable to find profile returns None.

Return type:

Xarray.Dataset or None