Skip to content

modis_ornl

MODIS ORNL Reader. Deprecated wrapper — use monetio.load('modis_ornl', ...) instead.

open_dataset(date, product='MOD12A2H', band='Lai_500m', quality_control=None, latitude=0, longitude=0, kmAboveBelow=100, kmLeftRight=100, **kwargs)

Open MODIS data from ORNL DAAC web service.

Parameters:

Name Type Description Default
date str or datetime - like

Date to retrieve.

 required
product str

MODIS product name.

 'MOD12A2H'
band str

MODIS band name.

 'Lai_500m'
quality_control str

Quality control band name.

 None
latitude float

Latitude of the point of interest.

 0
longitude float

Longitude of the point of interest.

 0
kmAboveBelow int

Km above and below the point.

 100
kmLeftRight int

Km left and right of the point.

 100
**kwargs dict

Additional arguments forwarded to MODISORNLReader.open_dataset.

 {}

Returns:

Type Description
DataArray
Source code in monetio/sat/modis_ornl.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@deprecated_wrapper(
    "monetio.sat.modis_ornl.open_dataset",
    'monetio.load("modis_ornl", files=...)',
)
def open_dataset(
    date,
    product="MOD12A2H",
    band="Lai_500m",
    quality_control=None,
    latitude=0,
    longitude=0,
    kmAboveBelow=100,
    kmLeftRight=100,
    **kwargs,
):
    """Open MODIS data from ORNL DAAC web service.

    Parameters
    ----------
    date : str or datetime-like
        Date to retrieve.
    product : str
        MODIS product name.
    band : str
        MODIS band name.
    quality_control : str, optional
        Quality control band name.
    latitude : float
        Latitude of the point of interest.
    longitude : float
        Longitude of the point of interest.
    kmAboveBelow : int
        Km above and below the point.
    kmLeftRight : int
        Km left and right of the point.
    **kwargs : dict
        Additional arguments forwarded to ``MODISORNLReader.open_dataset``.

    Returns
    -------
    xarray.DataArray
    """
    return MODISORNLReader().open_dataset(
        dates=date,
        product=product,
        band=band,
        quality_control=quality_control,
        latitude=latitude,
        longitude=longitude,
        kmAboveBelow=kmAboveBelow,
        kmLeftRight=kmLeftRight,
        **kwargs,
    )

open_mfdataset(dates, product='MOD12A2H', band='Lai_500m', quality_control=None, latitude=0, longitude=0, kmAboveBelow=100, kmLeftRight=100, **kwargs)

Open multiple MODIS data from ORNL DAAC web service.

Parameters:

Name Type Description Default
dates sequence of datetime-like

Dates to retrieve.

 required
product str

MODIS product name.

 'MOD12A2H'
band str

MODIS band name.

 'Lai_500m'
quality_control str

Quality control band name.

 None
latitude float

Latitude of the point of interest.

 0
longitude float

Longitude of the point of interest.

 0
kmAboveBelow int

Km above and below the point.

 100
kmLeftRight int

Km left and right of the point.

 100
**kwargs dict

Additional arguments forwarded to MODISORNLReader.open_dataset.

 {}

Returns:

Type Description
DataArray
Source code in monetio/sat/modis_ornl.py 
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
@deprecated_wrapper(
    "monetio.sat.modis_ornl.open_mfdataset",
    'monetio.load("modis_ornl", files=...)',
)
def open_mfdataset(
    dates,
    product="MOD12A2H",
    band="Lai_500m",
    quality_control=None,
    latitude=0,
    longitude=0,
    kmAboveBelow=100,
    kmLeftRight=100,
    **kwargs,
):
    """Open multiple MODIS data from ORNL DAAC web service.

    Parameters
    ----------
    dates : sequence of datetime-like
        Dates to retrieve.
    product : str
        MODIS product name.
    band : str
        MODIS band name.
    quality_control : str, optional
        Quality control band name.
    latitude : float
        Latitude of the point of interest.
    longitude : float
        Longitude of the point of interest.
    kmAboveBelow : int
        Km above and below the point.
    kmLeftRight : int
        Km left and right of the point.
    **kwargs : dict
        Additional arguments forwarded to ``MODISORNLReader.open_dataset``.

    Returns
    -------
    xarray.DataArray
    """
    return MODISORNLReader().open_dataset(
        dates=dates,
        product=product,
        band=band,
        quality_control=quality_control,
        latitude=latitude,
        longitude=longitude,
        kmAboveBelow=kmAboveBelow,
        kmLeftRight=kmLeftRight,
        **kwargs,
    )