GPM

pansat.products.satellite.gpm

This module defines the GPM product class, which is used to represent all GPM products.

class pansat.products.satellite.gpm.GPMProduct(level, platform, sensor, name, version, variant, description)

Base class representing GPM products.

__init__(level, platform, sensor, name, version, variant, description)

Initialize self. See help(type(self)) for accurate signature.

__str__()

Should return a string representation of the product name.

_get_provider()

Find a provider that provides the product.

property default_destination

The default destination for GPM product is GPM/<product_name>>

download(start_time, end_time, destination=None, provider=None)

Download data product for given time range.

Parameters

• start_time (datetime) – datetime object defining the start date of the time range.

• end_time (datetime) – datetime object defining the end date of the of the time range.

• destination (str or pathlib.Path) – The destination where to store the output data.

filename_to_date(filename)

Extract timestamp from filename.

Parameters

filename (str) – Filename of a GPM product.

Returns

datetime object representing the timestamp of the filename.

matches(filename)

Determines whether a given filename matches the pattern used for the product.

Parameters

filename (str) – The filename

Returns

True if the filename matches the product, False otherwise.

open(filename)

Open file as xarray dataset.

Parameters

filename (pathlib.Path or str) – The GPM file to open.

class pansat.products.satellite.gpm.GPROFProduct(platform, sensor, version, variant='')

Specialization of GPM product for GPROF products, which all have the same data format.

__init__(platform, sensor, version, variant='')

Initialize self. See help(type(self)) for accurate signature.

exception pansat.products.satellite.gpm.NoAvailableProviderError

Exception indicating that no suitable provider could be found for a product.

__weakref__

list of weak references to the object (if defined)

pansat.products.satellite.gpm._extract_scantime(scantime_group)

Extract scan time as numpy object.

This function is use

Parameters

scantime_group – The HDF5 group containing the scantime data.

Returns

numpy.datetime64 object representing the scantime.