pygmt.GMTBackendEntrypoint.open_dataset

GMTBackendEntrypoint.open_dataset(filename_or_obj, *, drop_variables=None, raster_kind, region=None)[source]

Backend open_dataset method used by Xarray in open_dataset.

Parameters:

filename_or_obj (str | PathLike) – File path to a netCDF (.nc), GeoTIFF (.tif) or other grid/image file format that can be read by GMT via the netCDF or GDAL C libraries. See also https://docs.generic-mapping-tools.org/6.5/reference/features.html#grid-file-format.
raster_kind (Literal['grid', 'image']) – Whether to read the file as a “grid” (single-band) or “image” (multi-band).
region (Sequence[float] | str | None, default: None) – The subregion of the grid or image to load, in the form of a sequence [xmin, xmax, ymin, ymax] or an ISO country code.

Return type:

Dataset