gpm.dataset.decoding package

Submodules

gpm.dataset.decoding.cf module

This module contains functions to CF-decoding the GPM files.

gpm.dataset.decoding.cf.apply_cf_decoding(ds)

Apply CF decoding to the xarray dataset.

For more information on CF-decoding, read:

https://docs.xarray.dev/en/stable/generated/xarray.decode_cf.html

gpm.dataset.decoding.coordinates module

This module contains functions to sanitize GPM-API Dataset coordinates.

gpm.dataset.decoding.coordinates.ensure_valid_coords(ds, raise_error=False)

Ensure geographic coordinates are within expected range.

gpm.dataset.decoding.coordinates.get_pmw_frequency(sensor, scan_mode)

Get product info dictionary.

gpm.dataset.decoding.coordinates.get_pmw_frequency_corra(product)

gpm.dataset.decoding.coordinates.get_pmw_frequency_dict()

Get PMW info dictionary.

gpm.dataset.decoding.coordinates.set_coordinates(ds, product, scan_mode)

gpm.dataset.decoding.dataarray_attrs module

This module contains functions to standardize GPM-API Dataset attributes.

gpm.dataset.decoding.dataarray_attrs.convert_string_to_number(string)

gpm.dataset.decoding.dataarray_attrs.ensure_dtype_name(dtype)

Ensure the dtype is a string name.

This function convert numpy.dtype to the string name.

gpm.dataset.decoding.dataarray_attrs.standardize_dataarrays_attrs(ds, product)

gpm.dataset.decoding.decode_1c_pmw module

This module contains functions to decode GPM PMW 1C products.

gpm.dataset.decoding.decode_1c_pmw.decode_Quality(da)

Decode the 1C-<PMW> variable Quality.

gpm.dataset.decoding.decode_1c_pmw.decode_product(ds)

Decode 1C-<PMW> products.

gpm.dataset.decoding.decode_2a_pmw module

This module contains functions to decode GPM PMW 2A products.

gpm.dataset.decoding.decode_2a_pmw.decode_airmassLiftIndex(da)

Decode the 2A-<PMW> variable airmassLiftIndex.

gpm.dataset.decoding.decode_2a_pmw.decode_cloudWaterPath(da)

Decode the 2A-<PMW> variable cloudWaterPath.

_FillValue is often reported as -9999.9, but in data the values are -9999.0 !

gpm.dataset.decoding.decode_2a_pmw.decode_iceWaterPath(da)

Decode the 2A-<PMW> variable iceWaterPath.

_FillValue is often reported as -9999.9, but in data the values are -9999.0 !

gpm.dataset.decoding.decode_2a_pmw.decode_pixelStatus(da)

Decode the 2A-<PMW> variable pixelStatus.

gpm.dataset.decoding.decode_2a_pmw.decode_precip1stTertial(da)

Decode the 2A-<PMW> variable precip1stTertial.

gpm.dataset.decoding.decode_2a_pmw.decode_precip2ndTertial(da)

Decode the 2A-<PMW> variable precip2ndTertial.

gpm.dataset.decoding.decode_2a_pmw.decode_precipitationYesNoFlag(da)

Decode the 2A-<PMW> variable precipitationYesNoFlag.

_FillValue is reported as -9999.0, but in data the values are -99. !

gpm.dataset.decoding.decode_2a_pmw.decode_product(ds)

Decode 2A-<PMW> products.

gpm.dataset.decoding.decode_2a_pmw.decode_qualityFlag(da)

Decode the 2A-<PMW> variable qualityFlag.

gpm.dataset.decoding.decode_2a_pmw.decode_rainWaterPath(da)

Decode the 2A-<PMW> variable rainWaterPath.

_FillValue is often reported as -9999.9, but in data the values are -9999.0 !

gpm.dataset.decoding.decode_2a_pmw.decode_sunGlintAngle(da)

Decode the 2A-<PMW> variable sunGlintAngle.

Set -88 value (sun below horizon) to np.nan

gpm.dataset.decoding.decode_2a_pmw.decode_surfacePrecipitation(da)

Decode the 2A-<PMW> variable surfacePrecipitation.

_FillValue is often reported as -9999.9, but in data the values are -9999.0 !

gpm.dataset.decoding.decode_2a_pmw.decode_surfaceTypeIndex(da)

Decode the 2A-<PMW> variable surfaceTypeIndex.

gpm.dataset.decoding.decode_2a_radar module

This module contains functions to decode GPM DPR, PR, Ka and Ku products.

gpm.dataset.decoding.decode_2a_radar.decode_attenuationNP(da)

Decode the 2A-<RADAR> variable flagBB.

gpm.dataset.decoding.decode_2a_radar.decode_binBBBottom(da)

Decode the 2A-<RADAR> variable binBBBottom.

gpm.dataset.decoding.decode_2a_radar.decode_binBBPeak(da)

Decode the 2A-<RADAR> variable binBBPeak.

gpm.dataset.decoding.decode_2a_radar.decode_binBBTop(da)

Decode the 2A-<RADAR> variable binBBTop.

gpm.dataset.decoding.decode_2a_radar.decode_binDFRmMLBottom(da)

Decode the 2A-<RADAR> variable binDFRmMLBottom.

gpm.dataset.decoding.decode_2a_radar.decode_binDFRmMLTop(da)

Decode the 2A-<RADAR> variable binDFRmMLTop.

gpm.dataset.decoding.decode_2a_radar.decode_binHeavyIcePrecipBottom(da)

Decode the 2A-<RADAR> variable binHeavyIcePrecipBottom.

gpm.dataset.decoding.decode_2a_radar.decode_binHeavyIcePrecipTop(da)

Decode the 2A-<RADAR> variable binHeavyIcePrecipTop.

gpm.dataset.decoding.decode_2a_radar.decode_flagAnvil(da)

Decode the 2A-<RADAR> variable flagAnvil.

gpm.dataset.decoding.decode_2a_radar.decode_flagBB(da)

Decode the 2A-<RADAR> variable flagBB.

gpm.dataset.decoding.decode_2a_radar.decode_flagGraupelHail(da)

Decode the 2A-<RADAR> variable flagGraupelHail.

gpm.dataset.decoding.decode_2a_radar.decode_flagHail(da)

Decode the 2A-<RADAR> variable flagHail.

gpm.dataset.decoding.decode_2a_radar.decode_flagHeavyIcePrecip(da)

Decode the 2A-<RADAR> variable flagHeavyIcePrecip.

gpm.dataset.decoding.decode_2a_radar.decode_flagPrecip(da)

Decode the 2A-<RADAR> variable flagPrecip.

gpm.dataset.decoding.decode_2a_radar.decode_flagShallowRain(da)

Decode the 2A-<RADAR> variable flagShallowRain.

gpm.dataset.decoding.decode_2a_radar.decode_flagSurfaceSnowfall(da)

Decode the 2A-<RADAR> variable flagSurfaceSnowfall.

gpm.dataset.decoding.decode_2a_radar.decode_heightBB(da)

Decode the 2A-<RADAR> variable heightBB.

gpm.dataset.decoding.decode_2a_radar.decode_landSurfaceType(da)

Decode the 2A-<RADAR> variable landSurfaceType.

gpm.dataset.decoding.decode_2a_radar.decode_phase(da)

Decode the 2A-<RADAR> variable phase.

gpm.dataset.decoding.decode_2a_radar.decode_phaseNearSurface(da)

Decode the 2A-<RADAR> variable phaseNearSurface.

gpm.dataset.decoding.decode_2a_radar.decode_product(ds)

Decode 2A-<RADAR> products.

gpm.dataset.decoding.decode_2a_radar.decode_qualityTypePrecip(da)

Decode the 2A-<RADAR> variable qualityTypePrecip.

gpm.dataset.decoding.decode_2a_radar.decode_widthBB(da)

Decode the 2A-<RADAR> variable widthBB.

gpm.dataset.decoding.decode_2a_radar.decode_zFactorMeasured(da)

Decode the 2A-<RADAR> variable flagBB.

gpm.dataset.decoding.decode_imerg module

This module contains functions to decode GPM PMW 2A products.

gpm.dataset.decoding.decode_imerg.decode_HQobservationTime(da)

Decode the IMERG V6 variable HQobservationTime.

gpm.dataset.decoding.decode_imerg.decode_HQprecipSource(da)

Decode the IMERG V6 variable HQprecipSource.

gpm.dataset.decoding.decode_imerg.decode_HQprecipitation(da)

Decode the IMERG V6 variable HQprecipitation.

gpm.dataset.decoding.decode_imerg.decode_IRinfluence(da)

Decode the IMERG V7 variable IRinfluence.

gpm.dataset.decoding.decode_imerg.decode_IRkalmanFilterWeight(da)

Decode the IMERG V6 variable IRkalmanFilterWeight.

gpm.dataset.decoding.decode_imerg.decode_IRprecipitation(da)

Decode the IMERG V6 and V7 variable IRprecipitation.

gpm.dataset.decoding.decode_imerg.decode_MWobservationTime(da)

Decode the IMERG V7 variable MWobservationTime.

gpm.dataset.decoding.decode_imerg.decode_MWprecipSource(da)

Decode the IMERG V7 variable MWprecipSource.

gpm.dataset.decoding.decode_imerg.decode_MWprecipitation(da)

Decode the IMERG V7 variable MWprecipitation.

gpm.dataset.decoding.decode_imerg.decode_precipitation(da)

Decode the IMERG V7 variable precipitation.

gpm.dataset.decoding.decode_imerg.decode_precipitationCal(da)

Decode the IMERG V6 variable precipitationCal.

gpm.dataset.decoding.decode_imerg.decode_precipitationQualityIndex(da)

Decode the IMERG V6 and V7 variable precipitationQualityIndex.

gpm.dataset.decoding.decode_imerg.decode_precipitationUncal(da)

Decode the IMERG V6 and V7 variable precipitationUncal.

gpm.dataset.decoding.decode_imerg.decode_probabilityLiquidPrecipitation(da)

Decode the IMERG V6 and V7 variable probabilityLiquidPrecipitation.

gpm.dataset.decoding.decode_imerg.decode_product(ds)

Decode IMERG products.

gpm.dataset.decoding.decode_imerg.decode_randomError(da)

Decode the IMERG V6 and V7 variable randomError.

gpm.dataset.decoding.routines module

This module contains functions to apply the products decoding routines.

gpm.dataset.decoding.routines.decode_variables(ds, product)

Decode the variables of a given GPM product.

gpm.dataset.decoding.utils module

This module contains utilities for the decoding of GPM product variables.

gpm.dataset.decoding.utils.add_decoded_flag(ds, variables)

Add gpm_api_decoded flag to GPM-API decoded variables.

gpm.dataset.decoding.utils.ceil_datarray(da)

Ceil a xr.DataArray.

gpm.dataset.decoding.utils.is_dataarray_decoded(da)

Check if a DataArray has been decoded by GPM-API.

gpm.dataset.decoding.utils.remap_numeric_array(arr, remapping_dict)

Remap the values of a numeric array.

Module contents

This directory contains the GPM-API dataset decoding functions.