gpm.gv.xradar package

gpm.gv.xradar package#

Submodules#

gpm.gv.xradar.accessors module#

class gpm.gv.xradar.accessors.XradarDevDataTreeAccessor(xarray_obj)[source][source]#

Bases: object

extent(max_distance=None, crs=None)[source][source]#
property maximum_horizontal_distance[source]#
property maximum_range_distance[source]#
property sweeps[source]#
class gpm.gv.xradar.accessors.Xradar_Dev_Base_Accessor(xarray_obj)[source][source]#

Bases: object

extent(max_distance=None, crs=None)[source][source]#
property maximum_horizontal_distance[source]#
property maximum_range_distance[source]#
plot_range_distance(distance, ax=None, add_background=True, fig_kwargs=None, subplot_kwargs=None, **plot_kwargs)[source][source]#
property pyproj_crs[source]#
quadmesh_corners()[source][source]#
quadmesh_polygons(crs=None)[source][source]#
quadmesh_vertices(ccw=True)[source][source]#
resolution_at_range(azimuth_beamwidth, elevation_beamwidth)[source][source]#
class gpm.gv.xradar.accessors.Xradar_Dev_DataArray_Accessor(xarray_obj)[source][source]#

Bases: Xradar_Dev_Base_Accessor

plot_map(ax=None, x='lon', y='lat', add_colorbar=True, add_background=True, fig_kwargs=None, subplot_kwargs=None, cbar_kwargs=None, **plot_kwargs)[source][source]#
class gpm.gv.xradar.accessors.Xradar_Dev_Dataset_Accessor(xarray_obj)[source][source]#

Bases: Xradar_Dev_Base_Accessor

to_geopandas(dim_order=None)[source][source]#

gpm.gv.xradar.methods module#

gpm.gv.xradar.methods.get_datatree_extent(dt, max_distance=None, crs=None)[source][source]#

Get extent, restricted to max_distance from radar location if specified.

If the CRS is not specified, it returns extent in WGS84 CRS.

gpm.gv.xradar.methods.get_datatree_maximum_horizontal_distance(dt)[source][source]#

Return the maximum horizontal distance from the radar across all sweeps.

gpm.gv.xradar.methods.get_datatree_maximum_range_distance(dt)[source][source]#

Return the maximum range distance across all sweeps.

gpm.gv.xradar.methods.get_datatree_sweeps(dt)[source][source]#

Return the datatree node names corresponding to radar sweep.

gpm.gv.xradar.methods.get_extent(xr_obj, max_distance=None, crs=None)[source][source]#

Get extent , restricted to max_distance from radar location if specified.

If the CRS is not specified, it returns extent in WGS84 CRS.

gpm.gv.xradar.methods.get_maximum_horizontal_distance(xr_obj)[source][source]#

Return the horizontal distance from the last gate.

gpm.gv.xradar.methods.get_maximum_range_distance(xr_obj)[source][source]#

Return the range distance from the last gate.

gpm.gv.xradar.methods.get_quadmesh_corners(xr_obj, crs=None)[source][source]#

Return quadmesh x and y corners of shape (N+1, M+1).

gpm.gv.xradar.methods.get_quadmesh_polygons(xr_obj, crs=None)[source][source]#

Return an array with quadmesh shapely polygons.

gpm.gv.xradar.methods.get_quadmesh_vertices(xr_obj, crs=None, ccw=True, origin='bottom')[source][source]#

Return the quadmesh vertices array with shape (N, M, 4, 2).

Parameters:

  • origin (str) – Origin of the y axis. The default is bottom.

  • ccw (bool, optional) – If True, vertices are ordered counterclockwise. If False, vertices are ordered clockwise. The default is True.

gpm.gv.xradar.methods.get_radius_polygon(xr_obj, distance, crs=None)[source][source]#
gpm.gv.xradar.methods.plot_map(da, x='lon', y='lat', ax=None, add_colorbar=True, add_background=True, add_gridlines=True, add_labels=True, fig_kwargs=None, subplot_kwargs=None, cbar_kwargs=None, **plot_kwargs)[source][source]#
gpm.gv.xradar.methods.plot_range_distance(xr_obj, distance, ax=None, fig_kwargs=None, subplot_kwargs=None, add_background=True, add_gridlines=True, add_labels=True, **plot_kwargs)[source][source]#
gpm.gv.xradar.methods.resolution_at_range(xr_obj, azimuth_beamwidth, elevation_beamwidth)[source][source]#

Compute the horizontal and vertical resolution of each radar gate.

Parameters:

  • ds (xarray.Dataset or xarray.DataArray) – xradar Dataset or DataArray.

  • azimuth_beamwidth (float) – Azimuth beamwidth (Δφ) in degrees.

  • elevation_beamwidth (float) – Elevation beamwidth (Δθ) in degrees.

Returns:

  • horizontal_res (xr.DataArray) – Horizontal resolution of the radar gates.

  • vertical_res (xr.DataArray) – Vertical resolution of the radar gates.

gpm.gv.xradar.methods.to_geopandas(ds, dim_order=None)[source][source]#

Convert xradar dataset to geopandas object.

Module contents#

This directory defines custom xradar xarray accessors.

class gpm.gv.xradar.Xradar_Dev_DataArray_Accessor(xarray_obj)[source][source]#

Bases: Xradar_Dev_Base_Accessor

plot_map(ax=None, x='lon', y='lat', add_colorbar=True, add_background=True, fig_kwargs=None, subplot_kwargs=None, cbar_kwargs=None, **plot_kwargs)[source][source]#
class gpm.gv.xradar.Xradar_Dev_Dataset_Accessor(xarray_obj)[source][source]#

Bases: Xradar_Dev_Base_Accessor

to_geopandas(dim_order=None)[source][source]#