Skip to content

export

darts_export.export

Darts export module for inference results.

logger module-attribute 

logger = logging.getLogger(
    __name__.replace("darts_", "darts.")
)

_export_binarized 

_export_binarized(
    tile: xarray.Dataset,
    out_dir: pathlib.Path,
    ensemble_subsets: list[str] = [],
)
Source code in darts-export/src/darts_export/export.py 
44
45
46
47
48
49
50
51
52
def _export_binarized(tile: xr.Dataset, out_dir: Path, ensemble_subsets: list[str] = []):
    _export_raster(tile, "binarized_segmentation", out_dir, fname="binarized")
    for ensemble_subset in ensemble_subsets:
        _export_raster(
            tile,
            f"binarized_segmentation-{ensemble_subset}",
            out_dir,
            fname=f"binarized-{ensemble_subset}",
        )

_export_polygonized 

_export_polygonized(
    tile: xarray.Dataset,
    out_dir: pathlib.Path,
    ensemble_subsets: list[str] = [],
)
Source code in darts-export/src/darts_export/export.py 
33
34
35
36
37
38
39
40
41
def _export_polygonized(tile: xr.Dataset, out_dir: Path, ensemble_subsets: list[str] = []):
    _export_vector(tile, "binarized_segmentation", out_dir, fname="prediction_segments")
    for ensemble_subset in ensemble_subsets:
        _export_vector(
            tile,
            f"binarized_segmentation-{ensemble_subset}",
            out_dir,
            fname=f"prediction_segments-{ensemble_subset}",
        )

_export_probabilities 

_export_probabilities(
    tile: xarray.Dataset,
    out_dir: pathlib.Path,
    ensemble_subsets: list[str] = [],
)
Source code in darts-export/src/darts_export/export.py 
55
56
57
58
59
60
61
62
63
def _export_probabilities(tile: xr.Dataset, out_dir: Path, ensemble_subsets: list[str] = []):
    _export_raster(tile, "probabilities", out_dir, fname="probabilities")
    for ensemble_subset in ensemble_subsets:
        _export_raster(
            tile,
            f"probabilities-{ensemble_subset}",
            out_dir,
            fname=f"probabilities-{ensemble_subset}",
        )

_export_raster 

_export_raster(
    tile: xarray.Dataset,
    name: str,
    out_dir: pathlib.Path,
    fname: str | None = None,
)
Source code in darts-export/src/darts_export/export.py 
14
15
16
17
18
19
def _export_raster(tile: xr.Dataset, name: str, out_dir: Path, fname: str | None = None):
    if fname is None:
        fname = name
    fpath = out_dir / f"{fname}.tif"
    with stopwatch(f"Exporting {name} to {fpath.resolve()}", printer=logger.debug):
        tile[name].rio.to_raster(fpath, driver="GTiff", compress="LZW")

_export_thumbnail 

_export_thumbnail(
    tile: xarray.Dataset, out_dir: pathlib.Path
)
Source code in darts-export/src/darts_export/export.py 
66
67
68
69
70
71
def _export_thumbnail(tile: xr.Dataset, out_dir: Path):
    fpath = out_dir / "thumbnail.jpg"
    with stopwatch(f"Exporting thumbnail to {fpath}", printer=logger.debug):
        fig = miniviz.thumbnail(tile)
        fig.savefig(fpath)
        fig.clear()

_export_vector 

_export_vector(
    tile: xarray.Dataset,
    name: str,
    out_dir: pathlib.Path,
    fname: str | None = None,
)
Source code in darts-export/src/darts_export/export.py 
22
23
24
25
26
27
28
29
30
def _export_vector(tile: xr.Dataset, name: str, out_dir: Path, fname: str | None = None):
    if fname is None:
        fname = name
    fpath_gpkg = out_dir / f"{fname}.gpkg"
    fpath_parquet = out_dir / f"{fname}.parquet"
    with stopwatch(f"Exporting {name} to {fpath_gpkg.resolve()} and {fpath_parquet.resolve()}", printer=logger.debug):
        polygon_gdf = vectorization.vectorize(tile, name)
        polygon_gdf.to_file(fpath_gpkg, layer=f"{fname}")
        polygon_gdf.to_parquet(fpath_parquet)

export_tile 

export_tile(
    tile: xarray.Dataset,
    out_dir: pathlib.Path,
    bands: list[str] = [
        "probabilities",
        "binarized",
        "polygonized",
        "extent",
        "thumbnail",
    ],
    ensemble_subsets: list[str] = [],
)

Export a tile to a file.

Parameters:

  • tile (xarray.Dataset) –

    The tile to export.

  • out_dir (pathlib.Path) –

    The path where to export to.

  • bands (list[str], default: ['probabilities', 'binarized', 'polygonized', 'extent', 'thumbnail'] ) –

    The bands to export. Defaults to ["probabilities"].

  • ensemble_subsets (list[str], default: [] ) –

    The ensemble subsets to export. Defaults to [].

Raises:

  • ValueError –

    If the band is not found in the tile.

Source code in darts-export/src/darts_export/export.py 
 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
115
116
117
118
119
@stopwatch.f("Exporting tile", printer=logger.debug, print_kwargs=["bands", "ensemble_subsets"])
def export_tile(  # noqa: C901
    tile: xr.Dataset,
    out_dir: Path,
    bands: list[str] = ["probabilities", "binarized", "polygonized", "extent", "thumbnail"],
    ensemble_subsets: list[str] = [],
):
    """Export a tile to a file.

    Args:
        tile (xr.Dataset): The tile to export.
        out_dir (Path): The path where to export to.
        bands (list[str], optional): The bands to export. Defaults to ["probabilities"].
        ensemble_subsets (list[str], optional): The ensemble subsets to export. Defaults to [].

    Raises:
        ValueError: If the band is not found in the tile.

    """
    out_dir.mkdir(parents=True, exist_ok=True)

    for band in bands:
        match band:
            case "polygonized":
                _export_polygonized(tile, out_dir, ensemble_subsets)
            case "binarized":
                _export_binarized(tile, out_dir, ensemble_subsets)
            case "probabilities":
                _export_probabilities(tile, out_dir, ensemble_subsets)
            case "extent":
                _export_vector(tile, "extent", out_dir, fname="prediction_extent")
            case "thumbnail":
                _export_thumbnail(tile, out_dir)
            case "optical":
                _export_raster(tile, ["red", "green", "blue", "nir"], out_dir, fname="optical")
            case "dem":
                _export_raster(tile, ["slope", "relative_elevation"], out_dir, fname="dem")
            case "tcvis":
                _export_raster(tile, ["tc_brightness", "tc_greenness", "tc_wetness"], out_dir, fname="tcvis")
            case _:
                if band not in tile.data_vars:
                    raise ValueError(
                        f"Band {band} not found in tile for export. Available bands are: {list(tile.data_vars.keys())}"
                    )
                # Export the band as a raster
                _export_raster(tile, band, out_dir)