Skip to content

modis_l2

MODIS L2 Reader. Deprecated wrapper — use monetio.load('modis_l2', ...) instead.

apply_quality_flag(ds, **kwargs)

Apply quality flag to a MODIS L2 dataset.

Parameters:

Name Type Description Default
ds Dataset

Dataset with quality_flag attribute.

 required
**kwargs dict

Additional arguments.

 {}
Source code in monetio/sat/modis_l2.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@deprecated_wrapper(
    "monetio.sat.modis_l2.apply_quality_flag",
    'monetio.load("modis_l2", files=...)',
)
def apply_quality_flag(ds, **kwargs):
    """Apply quality flag to a MODIS L2 dataset.

    Parameters
    ----------
    ds : xarray.Dataset
        Dataset with quality_flag attribute.
    **kwargs : dict
        Additional arguments.
    """
    return MODISL2Reader().apply_quality_flag(ds, **kwargs)

read_dataset(fname, variable_dict, **kwargs)

Read a single MODIS L2 HDF file.

Parameters:

Name Type Description Default
fname str

Input file path.

 required
variable_dict dict

Variable configuration dictionary.

 required
**kwargs dict

Additional arguments forwarded to MODISL2Reader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/sat/modis_l2.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@deprecated_wrapper(
    "monetio.sat.modis_l2.read_dataset",
    'monetio.load("modis_l2", files=...)',
)
def read_dataset(fname, variable_dict, **kwargs):
    """Read a single MODIS L2 HDF file.

    Parameters
    ----------
    fname : str
        Input file path.
    variable_dict : dict
        Variable configuration dictionary.
    **kwargs : dict
        Additional arguments forwarded to ``MODISL2Reader.open_dataset``.

    Returns
    -------
    xarray.Dataset
    """
    return MODISL2Reader().open_dataset(files=fname, variable_dict=variable_dict, **kwargs)

read_mfdataset(fnames, variable_dict, debug=False, **kwargs)

Read multiple MODIS L2 HDF files.

Parameters:

Name Type Description Default
fnames str

Regular expression for input file paths.

 required
variable_dict dict

Variable configuration dictionary.

 required
debug bool

Enable debug logging.

 False
**kwargs dict

Additional arguments forwarded to MODISL2Reader.open_dataset.

 {}

Returns:

Type Description
dict

Ordered dict of granules keyed by datetime string.
Source code in monetio/sat/modis_l2.py 
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
@deprecated_wrapper(
    "monetio.sat.modis_l2.read_mfdataset",
    'monetio.load("modis_l2", files=...)',
)
def read_mfdataset(fnames, variable_dict, debug=False, **kwargs):
    """Read multiple MODIS L2 HDF files.

    Parameters
    ----------
    fnames : str
        Regular expression for input file paths.
    variable_dict : dict
        Variable configuration dictionary.
    debug : bool
        Enable debug logging.
    **kwargs : dict
        Additional arguments forwarded to ``MODISL2Reader.open_dataset``.

    Returns
    -------
    dict
        Ordered dict of granules keyed by datetime string.
    """
    return MODISL2Reader().open_dataset(
        files=fnames, variable_dict=variable_dict, debug=debug, **kwargs
    )