Skip to content

data.PlanetaryComputerMODISFire

Global

Import path: earth2studio.data.PlanetaryComputerMODISFire

View source on GitHub

Documentation

Bases: _PlanetaryComputerData

MODIS Thermal Anomalies/Fire Daily (FireMask, MaxFRP, QA).

Parameters:

  • tile (str, default: 'h35v10' ) –

    The MODIS tile identifier (hXXvYY) to prioritize during STAC searches.

  • cache (bool, default: True ) –

    Cache data source on local memory, by default True

  • verbose (bool, default: True ) –

    Whether to print progress information, by default True

  • max_workers (int, default: 24 ) –

    Upper bound on concurrent download and processing tasks, by default 24

  • request_timeout (int, default: DEFAULT_TIMEOUT ) –

    Timeout (seconds) applied to individual HTTP requests, by default 60

  • max_retries (int, default: DEFAULT_RETRIES ) –

    Maximum retry attempts for transient network failures, by default 4

  • async_timeout (int, default: DEFAULT_ASYNC_TIMEOUT ) –

    Time in sec after which download will be cancelled if not finished successfully, by default 600

Note

Additional information on the data repository can be referenced here:

Warning

Tile searches are best-effort. If no tile identifiers are provided (the default), the first available tile returned by the Planetary Computer search is used.

__call__

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

Function to get data

Parameters:

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

    Timestamps to return data for (UTC).

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

    String, list of strings or array of strings that refer to variables to return. Must be in the ARCO lexicon.

Returns:

  • DataArray –

    Data array from planetary computer

fetch async

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

Async function to get data

Parameters:

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

    Timestamps to return data for (UTC).

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

    String, list of strings or array of strings that refer to variables to return. Must be in the data source's lexicon.

Returns:

  • DataArray –

    Plantary computer data array