geoips.plugins.classes.coverage_checkers package

Submodules

geoips.plugins.classes.coverage_checkers.center_radius module

Coverage check routine for center radius coverage checks.

class geoips.plugins.classes.coverage_checkers.center_radius.CenterRadiusCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Center Radius Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None, radius_km=300)

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. Defaults to 300 km.

Returns:

Percent coverage of variable_name

Return type:

float

family = 'standard'

interface = 'coverage_checkers'

name = 'center_radius'

plot_coverage(main_ax, area_def, covg_args)

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.classes.coverage_checkers.center_radius.PLUGIN_CLASS

alias of CenterRadiusCoverageCheckerPlugin

geoips.plugins.classes.coverage_checkers.center_radius_rgba module

Coverage check routine for RGBA center radius coverage checks.

class geoips.plugins.classes.coverage_checkers.center_radius_rgba.CenterRadiusRgbaCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Center Radius Rgba Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None, radius_km=300)

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, optional) – Radius of center disk to check for coverage. Defaults to 300 km.

Returns:

Percent coverage of variable_name

Return type:

float

family = 'standard'

interface = 'coverage_checkers'

name = 'center_radius_rgba'

geoips.plugins.classes.coverage_checkers.center_radius_rgba.PLUGIN_CLASS

alias of CenterRadiusRgbaCoverageCheckerPlugin

geoips.plugins.classes.coverage_checkers.masked_arrays module

Coverage check routine for masked arrays.

class geoips.plugins.classes.coverage_checkers.masked_arrays.MaskedArrayCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Masked Array Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None)

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

family = 'standard'

interface = 'coverage_checkers'

name = 'masked_arrays'

geoips.plugins.classes.coverage_checkers.masked_arrays.PLUGIN_CLASS

alias of MaskedArrayCoverageCheckerPlugin

geoips.plugins.classes.coverage_checkers.numpy_arrays_nan module

Coverage check routine for masked arrays.

class geoips.plugins.classes.coverage_checkers.numpy_arrays_nan.NumpyArraysNanCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Numpy Arrays NAN Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None)

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

family = 'standard'

interface = 'coverage_checkers'

name = 'numpy_arrays_nan'

geoips.plugins.classes.coverage_checkers.numpy_arrays_nan.PLUGIN_CLASS

alias of NumpyArraysNanCoverageCheckerPlugin

geoips.plugins.classes.coverage_checkers.rgba module

Coverage check routine for RGBA arrays.

geoips.plugins.classes.coverage_checkers.rgba.PLUGIN_CLASS

alias of RgbaCoverageCheckerPlugin

class geoips.plugins.classes.coverage_checkers.rgba.RgbaCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Rgba Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None)

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

family = 'standard'

interface = 'coverage_checkers'

name = 'rgba'

geoips.plugins.classes.coverage_checkers.windbarbs module

Coverage check routine for windbarb xarrays.

geoips.plugins.classes.coverage_checkers.windbarbs.PLUGIN_CLASS

alias of WindbarbCoverageCheckerPlugin

class geoips.plugins.classes.coverage_checkers.windbarbs.WindbarbCoverageCheckerPlugin(module=None)

Bases: BaseCoverageCheckerPlugin

Windbarb Coverage checker plugin class.

call(xarray_obj, variable_name, area_def=None)

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

family = 'standard'

interface = 'coverage_checkers'

name = 'windbarbs'

Module contents

geoips coverage_checkers init file.