radtraq.proc.extract_profile

radtraq.proc.extract_profile(obj, azimuth, ground_dist, append_obj=None, variables=None, azimuth_range=None, ground_dist_range=200, azimuth_name='azimuth', range_name='range', ground_range_units='m', elevation_name='elevation')[source]

Function for extracting vertical profile over a location from a PPI scan giving azimuth direction and ground range distance

Parameters:

  • obj (Xarray.Dataset) – Xarray Dataset with all the data

  • azimuth (float) – Azimuth direction to extract profile in degrees

  • ground_dist (float) – Horizontal ground distance to extract profile

  • append_obj (Xarray.Dataset) – Xarray Dataset to return with new profile appened.

  • variables (str, list, None) – List of variables to extract profile

  • azimuth_range (float, None) – Range to used to determine if close to correct profile location. If set to None will calculate using mode of difference. Assumed to be in degrees.

  • ground_dist_range (float) – Distance range window size allowed to extract profile. If the profile location is off from lat/lon location by more than this distance, will not extract a profile and will return None.

  • azimuth_name (string) – Variable name in Xarray object containing azimuth values.

  • range_name (string) – Variable name in Xarray object containing range values.

  • ground_range_units (string) – ground_dist units

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

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