geoips.plugins.modules.coverage_checkers package#

Submodules#

geoips.plugins.modules.coverage_checkers.center_radius module#

Coverage check routine for center radius coverage checks.

geoips.plugins.modules.coverage_checkers.center_radius.call(xarray_obj, variable_name, area_def=None, radius_km=300)[source]#

Coverage check routine for xarray objects with masked projected arrays.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked

  • radius_km (float) – Radius of center disk to check for coverage

Returns:

Percent coverage of variable_name

Return type:

float

geoips.plugins.modules.coverage_checkers.center_radius.create_radius(temp_arr, radius_pixels=300, x_center=0, y_center=0)[source]#

Create a radius around given x,y coordinates in the 2d array.

Given the radius and the x,y coordinates it creates a circle around those points using the skimage.draw library

Parameters:

  • temp_arr (int) – The 2D array.

  • radius (int, optional) – The radius of the circle. 500 is default value.

  • x (int, optional) – The x coordinate of middle circle point. 0 is default value.

  • y (int, optional) – The x coordinate of middle circle point. 0 is default value.

Returns:

2D array with circle created at the x,y coordinate with the given radius All circles are marked as 1.

Return type:

numpy.ndarray

geoips.plugins.modules.coverage_checkers.center_radius.plot_coverage(main_ax, area_def, covg_args)[source]#

Plot the coverage specified by the ‘center_radius’ function.

Parameters:

  • main_ax (matplotlib.axis) – Axis on which to plot coverage representation

  • area_def (pyresample.AreaDefinition) – area def for current plot

  • covg_args (dict) – product params dictionary for current product - to ensure we plot the correct coverage params

Return type:

No return value

geoips.plugins.modules.coverage_checkers.center_radius_rgba module#

Coverage check routine for RGBA center radius coverage checks.

geoips.plugins.modules.coverage_checkers.center_radius_rgba.call(xarray_obj, variable_name, area_def=None, radius_km=300)[source]#

Coverage check routine for xarray objects with masked projected arrays.

Only calculates coverage within a “radius_km” radius of center.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked radius_km (float) : Radius of center disk to check for coverage

Returns:

Percent coverage of variable_name

Return type:

float

geoips.plugins.modules.coverage_checkers.masked_arrays module#

Coverage check routine for masked arrays.

geoips.plugins.modules.coverage_checkers.masked_arrays.call(xarray_obj, variable_name, area_def=None)[source]#

Coverage check routine for xarray objects with masked projected arrays.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked

Returns:

Percent coverage of variable_name

Return type:

float

geoips.plugins.modules.coverage_checkers.numpy_arrays_nan module#

Coverage check routine for masked arrays.

geoips.plugins.modules.coverage_checkers.numpy_arrays_nan.call(xarray_obj, variable_name, area_def=None)[source]#

Coverage check routine for xarray objects with projected numpy arrays.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked

Returns:

Percent coverage of variable_name

Return type:

float

geoips.plugins.modules.coverage_checkers.rgba module#

Coverage check routine for RGBA arrays.

geoips.plugins.modules.coverage_checkers.rgba.call(xarray_obj, variable_name, area_def=None)[source]#

Coverage check routine for xarray objects with projected RGBA arrays.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked

Returns:

Percent coverage of variable_name

Return type:

float

geoips.plugins.modules.coverage_checkers.windbarbs module#

Coverage check routine for windbarb xarrays.

geoips.plugins.modules.coverage_checkers.windbarbs.call(xarray_obj, variable_name, area_def=None)[source]#

Coverage check routine for wind barb xarray object.

Parameters:

  • xarray_obj (xarray.Dataset) – xarray object containing variable “variable_name”

  • variable_name (str) – variable name to check percent unmasked.

Returns:

Percent coverage of variable_name over area_def

Return type:

float

Module contents#

geoips coverage_checkers init file.