raster.rasterio_open() – freezebase

raster.rasterio_open()

Open a local or S3-backed rasterio dataset.

Usage

raster.rasterio_open(path: AnyPath, mode: Literal['r'] = ..., kwargs: Any = {}) -> AbstractContextManager[DatasetReader]
 
raster.rasterio_open(path: AnyPath, mode: Literal['r+', 'w', 'w+'], kwargs: Any = {}) -> AbstractContextManager[DatasetWriter]

On S3, a write mode opens a local copy that is uploaded once the dataset closes without an error; "r+" downloads the object first.

Parameters

path: str | Path | UPath: Raster path. An S3 UPath supplies its storage options to GDAL.
mode: ("r", "r+", "w", "w+") = "r": File mode passed directly to rasterio.open. Defaults to "r".
**kwargs: Any: Additional arguments for rasterio.open.

Returns

AbstractContextManager: Context manager yielding a dataset reader or writer.

Raises

ValueError: If path uses a protocol other than local ("") or "s3".