io

gridkit.io.read_raster(path: str, bounds: Tuple[float, float, float, float] | None = None, bounds_crs: CRS | None = None, border_buffer: float = 0)[source]

Read data from a GeoTIFF

Parameters:

  • path (str) – The path to the file. This needs to be a file that is supported by rasterio.

  • bounds (Tuple(float, float, float, float), None) – The bounds of the are of interest. Only the data within the supplied bounds is read from the input file.

  • bounds_crs (pyproj.CRS, None) – The Coordinte Reference System (CRS) of the supploed bounds. If the CRS of the bounds does not match that of the input files, the bounds are converted to that of the input file before reading.

  • border_buffer (int, 0) – A buffer to apply to the supplied bounds to read in a larger slice of the area.

Returns:

The contents of the GeoTIFF in the form of a BoundedRectGrid

Return type:

BoundedRectGrid

See also

write_raster()

gridkit.io.read_geotiff(*args, bands=1, **kwargs)[source]

Deprecated, please refer to read_raster()

gridkit.io.write_raster(data, path)[source]

Write a BoundedRectGrid to a raster file (eg .tiff).

Parameters:

  • grid (DataTile | BoundedRectGrid) – The data to write to a raster file. This can either be a BoundedRectGrid or a DataTile on a rectangular grid.

  • path (str) – The locatin of the file to write to (eg ./my_raster.tiff).

Returns:

The path pointing to the written file

Return type:

str

See also

read_raster()

gridkit.io.raster_to_data_tile(path, bounds=None, bounds_crs: CRS | None = None, border_buffer: float = 0, band=1)[source]

Read a raster as a DataTile. Only a single band can be read.

Parameters:

  • path (str, file object, PathLike object, FilePath, or MemoryFile) – A filename or URL, a file object opened in binary (‘rb’) mode, a Path object, or one of the rasterio classes that provides the dataset-opening interface.

  • bounds (Tuple(float, float, float, float), None) – The bounding box of the data to read in (min-x, min-y, max-x, max-y). Can be used to read a smaller section of the dataset. If the bounds are larger than the raster bounds, the full raster will be read.

  • bounds_crs (pyproj.CRS, None) –

    The Coordinate Reference System (CRS) that matches the supplied bounds argument. The bounds are then converted to the CRS that matches the dataset before reading the tile. This allows for reading a section of the dataset defined in any CRS, unrelated to the CRS of the dataset.

    Note

    The dataset will be read in the CRS corresponding to the data file, not the bounds_crs.

  • border_buffer (float, 0) – Enlarge the supplied bounds with the specified border_radius. A negative border_radius can be supplied to decrease the bounds. The unit of the border_radius is that of bounds_crs, or that of the dataset CRS if bounds_crs is not supplied.

  • band (int, 0) – The index of the band to read. Default: 1. Note that raster bands start at 1, so if you want to read the first band, supply band=1, not band=0.

Returns:

class – A data tile with spatial properties based on the input raster

Return type:

.DataTile