CloudSat

pansat.products.satellite.cloud_sat

This module defines the CloudSat product class, which represents all supported CloudSat products.

class pansat.products.satellite.cloud_sat.CloudSatProduct(name, description)

The CloudSat class defines a generic interface for CloudSat products.

name

The name of the product

Type:

str

description

List of variable names provided by this product.

Type:

list

__init__(name, description)

__str__()

The full product name.

_get_provider()

Find a provider that provides the product.

property default_destination

The default destination for CloudSat product is CloudSat/<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 CloudSat 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 CloudSat file to open.

pansat.products.satellite.cloud_sat._cloud_scenario_to_algorithm_flag(cloud_scenario)

Extract algorithm flag from CloudSat cloud scenario data.

Extract bits 9-10 from the combined integer values, which encode the algorithm used for classification.

pansat.products.satellite.cloud_sat._cloud_scenario_to_cloud_class(cloud_scenario)

Extract cloud class from CloudSat cloud scenario data.

Extract bits 1-4 from the combined integer values, which encode the cloud class.

pansat.products.satellite.cloud_sat._cloud_scenario_to_cloud_scenario_flag(cloud_scenario)

Extract cloud class from CloudSat cloud scenario data.

Extract bits 0 from the combined integer values, which encode the whether the cloud type could be determined.

pansat.products.satellite.cloud_sat._cloud_scenario_to_land_sea_flag(cloud_scenario)

Extract sea flag from CloudSat cloud scenario data.

Extract bits 5-6 from the combined integer values, which encode the land-sea flag.

pansat.products.satellite.cloud_sat._cloud_scenario_to_latitude_flag(cloud_scenario)

Extract latitude flag from CloudSat cloud scenario data.

Extract bits 7-8 from the combined integer values, which encode the latitude flag.

pansat.products.satellite.cloud_sat._cloud_scenario_to_precipitation_flag(cloud_scenario)

Extract precipitation flag from CloudSat cloud scenario data.

Extract bits 13-14 from the combined integer values, which encode the precipitation flag.

pansat.products.satellite.cloud_sat._cloud_scenario_to_quality_flag(cloud_scenario)

Extract quality flag from CloudSat cloud scenario data.

Extract bits 11-12 from the combined integer values, which encode the data quality.