def set_crs(self, input_crs, inplace=True):
"""
Set the CRS value for the Dataset/DataArray without modifying
the dataset/data array.
Parameters
----------
input_crs: object
Anything accepted by `rasterio.crs.CRS.from_user_input`.
inplace: bool, optional
If True, it will write to the existing dataset. Default is False.
Returns
-------
:obj:`xarray.Dataset` | :obj:`xarray.DataArray`:
Dataset with crs attribute.
"""
crs = crs_from_user_input(input_crs)
obj = self._get_obj(inplace=inplace)
obj.rio._crs = crs
return obj
def clip(
self,
geometries,
crs=None,
all_touched=False,
drop=True,
invert=False,
from_disk=False,
):
"""
Crops a :obj:`xarray.DataArray` by geojson like geometry dicts.
Powered by `rasterio.features.geometry_mask`.
Examples:
>>> geometry = ''' {"type": "Polygon",
... "coordinates": [
... [[-94.07955380199459, 41.69085871273774],
... [-94.06082436942204, 41.69103313774798],
... [-94.06063203899649, 41.67932439500822],
... [-94.07935807746362, 41.679150041277325],
... [-94.07955380199459, 41.69085871273774]]]}'''
>>> cropping_geometries = [geojson.loads(geometry)]
>>> xds = xarray.open_rasterio('cool_raster.tif')
>>> cropped = xds.rio.clip(geometries=cropping_geometries, crs=4326)
.. versionadded:: 0.2 from_disk
Parameters
----------
geometries: list
A list of geojson geometry dicts or objects with __geom_interface__ with
if you have rasterio 1.2+.
crs: :obj:`rasterio.crs.CRS`, optional
The CRS of the input geometries. Default is to assume it is the same
as the dataset.
all_touched : bool, optional
If True, all pixels touched by geometries will be burned in. If
false, only pixels whose center is within the polygon or that
are selected by Bresenham's line algorithm will be burned in.
drop: bool, optional
If True, drop the data outside of the extent of the mask geoemtries
Otherwise, it will return the same raster with the data masked.
Default is True.
invert: boolean, optional
If False, pixels that do not overlap shapes will be set as nodata.
Otherwise, pixels that overlap the shapes will be set as nodata.
False by default.
from_disk: boolean, optional
If True, it will clip from disk using rasterio.mask.mask if possible.
This is beneficial when the size of the data is larger than memory.
Default is False.
Returns
-------
:obj:`xarray.DataArray`:
The clipped object.
"""
if self.crs is None:
raise MissingCRS(
"CRS not found. Please set the CRS with 'rio.write_crs()'."
f"{_get_data_var_message(self._obj)}")
crs = crs_from_user_input(crs) if crs is not None else self.crs
if self.crs != crs:
if LooseVersion(rasterio.__version__) >= LooseVersion("1.2"):
geometries = rasterio.warp.transform_geom(
crs, self.crs, geometries)
else:
geometries = [
rasterio.warp.transform_geom(crs, self.crs, geometry)
for geometry in geometries
]
cropped_ds = None
if from_disk:
cropped_ds = _clip_from_disk(
self._obj,
geometries=geometries,
all_touched=all_touched,
drop=drop,
invert=invert,
)
if cropped_ds is None:
cropped_ds = _clip_xarray(
self._obj,
geometries=geometries,
all_touched=all_touched,
drop=drop,
invert=invert,
)
if (cropped_ds.coords[self.x_dim].size < 1
or cropped_ds.coords[self.y_dim].size < 1):
raise NoDataInBounds(
f"No data found in bounds.{_get_data_var_message(self._obj)}")
# make sure correct attributes preserved & projection added
_add_attrs_proj(cropped_ds, self._obj)
return cropped_ds
def crs_to_wkt(input_crs):
"""
Convert CRS input to WKT format
"""
return crs_from_user_input(input_crs).to_wkt()