polartoolkit.mask_from_polygon

mask_from_polygon(polygon, hemisphere=None, epsg=None, invert=False, drop_nans=False, grid=None, region=None, spacing=None, **kwargs)

convert the output of ptk.draw_region to a mask or use it to mask a grid

Parameters:

• polygon (list[float]) – list of polygon vertices

• hemisphere (str | None) – set projection based on “north” or “south” hemispheres, by default None

• epsg (str | None) – set projection from EPSG code string (“3031”), by default None

• invert (bool) – reverse the sense of masking, by default False

• drop_nans (bool) – drop nans after masking, by default False

• grid (str | DataArray | None) – grid to mask, by default None

• region (tuple[float, float, float, float] | None) – region to create a grid if none is supplied, in format [xmin, xmax, ymin, ymax], by default None

• spacing (int | None) – spacing to create a grid if none is supplied, by default None

• kwargs (Any)

Returns:

masked grid or mask grid with 1’s inside the mask.

Return type:

DataArray