onstove.VectorLayer.mask

VectorLayer.mask(mask_layer: GeoDataFrame, output_path: str = None)

Wrapper for the geopandas.GeoDataFrame.clip method.

Clip points, lines, or polygon geometries to the mask extent.

Parameters:

mask_layer: GeoDataFrame

A geopandas.GeoDataFrame object.

output_path: str, optional

A folder path where to save the output dataset. If not defined then the clipped dataset is not saved.