omf_io.gridsurface.grid_surface.GridSurfaceIO

class omf_io.gridsurface.grid_surface.GridSurfaceIO(surface_data)[source]

Handles the creation and consumption of grid surface (raster) objects.

__init__(surface_data)[source]

Initialize the GridSurfaceIO instance.

Parameters:

surface_data (xarray.DataArray) – The grid surface data.

Methods

__init__(surface_data)

Initialize the GridSurfaceIO instance.

from_raster(raster_file, **kwargs)

Create a GridSurfaceIO instance from a raster file.

to_raster(output_file[, format])

Prepare the grid surface data for export to a raster file.
classmethod from_raster(raster_file, **kwargs)[source]

Create a GridSurfaceIO instance from a raster file.

Parameters:

  • raster_file (Path) – The input raster file path.

  • **kwargs – Additional arguments for the import function.

Returns:

An instance of the class.

Return type:

GridSurfaceIO

to_raster(output_file, format='GeoTIFF', **kwargs)[source]

Prepare the grid surface data for export to a raster file.

Parameters:

  • output_file (Path) – The output raster file path.

  • format (str) – The format of the output raster file. Default is “GeoTIFF”.

  • **kwargs – Additional arguments for the export function.