data.MeteosatFCI

EUAF

Import path: earth2studio.data.MeteosatFCI

View source on GitHub

Documentation

EUMETSAT MTG-I FCI Level-1C Full Disk calibrated radiance data source.

This data source provides access to Meteosat Third Generation (MTG) Flexible Combined Imager (FCI) Level-1C Full Disk products via the EUMETSAT Data Store. The 16 spectral channels in the Full Disk High Spectral Imagery (FDHSI) product cover visible, near-IR, water-vapour and infrared bands at 1 km or 2 km nadir resolution. Four channels are also available in the High Resolution Fast Imagery (HRFI) product at 500 m or 1 km. Variables are read from either collection depending on which resolution is set.

Parameters:

• resolution (Literal['2km', '1km', '500m'], default: '2km' ) –

  Grid resolution — '2km', '1km', or '500m'. FDHSI channels are available at '2km' (IR/WV bands) or '1km' (VIS/NIR bands); HRFI channels are available at '1km' or '500m'. By default '2km'.

• lat_lon_bbox (tuple[tuple[float, float], tuple[float, float]] | None, default: None ) –

  Bounding box ((lat_min, lat_max), (lon_min, lon_max)) in degrees to crop the full-disk image. Only BODY segments that overlap the requested latitude range are read, saving disk and memory. When None the full disk is returned, by default None

• pixel_bbox (tuple[tuple[int, int], tuple[int, int]] | None, default: None ) –

  Bounding box ((row_start, row_end), (col_start, col_end)) in pixel coordinates (native FCI order: row 0 = south, end-exclusive) to crop the full-disk image. Mutually exclusive with lat_lon_bbox. When None the full disk is returned, by default None

• flip_north_south (bool, default: False ) –

  When True the output array row 0 is north and latitude increases downward (conventional image orientation). When False (the default) the native FCI convention is preserved: row 0 is south and latitude increases upward.

• cache (bool, default: True ) –

  Cache downloaded products on local disk, by default True

• verbose (bool, default: True ) –

  Print download progress, by default True

• async_timeout (int, default: 1200 ) –

  Total timeout in seconds for the entire fetch operation, by default 1200

• retries (int, default: 3 ) –

  Number of retry attempts per failed fetch task with exponential backoff, by default 3

Warning

This is a remote data source and can potentially download a large amount of data to your local machine for large requests.

Note

Requires EUMETSAT Data Store credentials. Set the following environment variables:

• EUMETSAT_CONSUMER_KEY: Your EUMETSAT API consumer key
• EUMETSAT_CONSUMER_SECRET: Your EUMETSAT API consumer secret

Register at eoportal.eumetsat.int/ to obtain credentials.

Note

Additional information on the data repository:

• data.eumetsat.int/product/EO:EUM:DAT:0662
• www.eumetsat.int/mtg-fci-level-1c-full-disk

__call__

__call__(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Retrieve MTG FCI data.

Parameters:

• time (datetime | list[datetime] | TimeArray) –

  Timestamps to return data for (UTC).

• variable (str | list[str] | VariableArray) –

  Variables to return. Must be in the MeteosatFCILexicon.

Returns:

• DataArray –

  Data array with dimensions [time, variable, y, x].

fetch async

fetch(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Async function to retrieve MTG FCI data.

Parameters:

• time (datetime | list[datetime] | TimeArray) –

  Timestamps to return data for (UTC).

• variable (str | list[str] | VariableArray) –

  Variables to return.

Returns:

• DataArray –

  Data array with dimensions [time, variable, y, x].

available classmethod

available(time: datetime | datetime64) -> bool

Check if a given datetime is available.

Parameters:

• time (datetime | datetime64) –

  Date time to check

Returns:

• bool –

  Whether the requested date time is available.