Skip to content

Preprocessing Reference

darts_preprocessing

Data preprocessing and feature engineering for the DARTS dataset.

load_and_preprocess_planet_scene(planet_scene_path, arcticdem_dir, cache_dir=None)

Load and preprocess a Planet Scene (PSOrthoTile or PSScene) into an xr.Dataset.

Parameters:

Name Type Description Default
planet_scene_path Path

path to the Planet Scene

 required
arcticdem_dir Path

path to the ArcticDEM directory

 required
cache_dir Path | None

The cache directory. If None, no caching will be used. Defaults to None.

 None

Returns:

Type Description
Dataset

xr.Dataset: preprocessed Planet Scene

Examples:

Data directory structure:

    data/input
    └── planet
        ├── ArcticDEM
        │   ├── relative_elevation
        │   │   └── 4372514_relative_elevation_100.tif
        │   └── slope
        │       └── 4372514_slope.tif
        └── planet
            └── PSOrthoTile
                └── 4372514/5790392_4372514_2022-07-16_2459
                    ├── 5790392_4372514_2022-07-16_2459_BGRN_Analytic_metadata.xml
                    ├── 5790392_4372514_2022-07-16_2459_BGRN_DN_udm.tif
                    ├── 5790392_4372514_2022-07-16_2459_BGRN_SR.tif
                    ├── 5790392_4372514_2022-07-16_2459_metadata.json
                    ├── 5790392_4372514_2022-07-16_2459_udm2.tif

Load and preprocess a Planet Scene:

    from pathlib import Path
    from darts_preprocessing.preprocess import load_and_preprocess_planet_scene

    fpath = Path("data/input/planet/planet/PSOrthoTile/4372514/5790392_4372514_2022-07-16_2459")
    arcticdem_dir = input_data_dir / "ArcticDEM" / "relative_elevation" / f"{scene_id}_relative_elevation_100.tif"
    tile = load_and_preprocess_planet_scene(fpath, arcticdem_dir)
Source code in darts-preprocessing/src/darts_preprocessing/preprocess.py 
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def load_and_preprocess_planet_scene(
    planet_scene_path: Path, arcticdem_dir: Path, cache_dir: Path | None = None
) -> xr.Dataset:
    """Load and preprocess a Planet Scene (PSOrthoTile or PSScene) into an xr.Dataset.

    Args:
        planet_scene_path (Path): path to the Planet Scene
        arcticdem_dir (Path): path to the ArcticDEM directory
        cache_dir (Path | None): The cache directory. If None, no caching will be used. Defaults to None.

    Returns:
        xr.Dataset: preprocessed Planet Scene

    Examples:
        Data directory structure:

        ```sh
            data/input
            └── planet
                ├── ArcticDEM
                │   ├── relative_elevation
                │   │   └── 4372514_relative_elevation_100.tif
                │   └── slope
                │       └── 4372514_slope.tif
                └── planet
                    └── PSOrthoTile
                        └── 4372514/5790392_4372514_2022-07-16_2459
                            ├── 5790392_4372514_2022-07-16_2459_BGRN_Analytic_metadata.xml
                            ├── 5790392_4372514_2022-07-16_2459_BGRN_DN_udm.tif
                            ├── 5790392_4372514_2022-07-16_2459_BGRN_SR.tif
                            ├── 5790392_4372514_2022-07-16_2459_metadata.json
                            ├── 5790392_4372514_2022-07-16_2459_udm2.tif
        ```

        Load and preprocess a Planet Scene:

        ```python
            from pathlib import Path
            from darts_preprocessing.preprocess import load_and_preprocess_planet_scene

            fpath = Path("data/input/planet/planet/PSOrthoTile/4372514/5790392_4372514_2022-07-16_2459")
            arcticdem_dir = input_data_dir / "ArcticDEM" / "relative_elevation" / f"{scene_id}_relative_elevation_100.tif"
            tile = load_and_preprocess_planet_scene(fpath, arcticdem_dir)
        ```

    """  # noqa: E501
    # load planet scene
    ds_planet = load_planet_scene(planet_scene_path)

    # calculate xr.dataset ndvi
    ds_ndvi = calculate_ndvi(ds_planet)

    ds_articdem = load_arcticdem(arcticdem_dir, ds_planet)

    ds_tcvis = load_tcvis(ds_planet, cache_dir)

    # load udm2
    ds_data_masks = load_planet_masks(planet_scene_path)

    # merge to final dataset
    ds_merged = xr.merge([ds_planet, ds_ndvi, ds_articdem, ds_tcvis, ds_data_masks])

    return ds_merged