healpix_geo.nested.polygon_coverage#

healpix_geo.nested.polygon_coverage(vertices, depth, *, ellipsoid='sphere', flat=True)#

Search the cells covering the given polygon.

Parameters:

  • vertices (numpy.ndarray) – The vertices of the polygon without holes. Must be an array of shape (n, 2).

  • depth (int) – The maximum depth of the cells to be returned.

  • ellipsoid (ellipsoid-like, default: "sphere") – Reference ellipsoid to evaluate healpix on. If the reference ellipsoid is spherical, this will return the same result as cdshealpix.nested.polygon_search().

  • flat (bool, default: True) – If True, the cells returned will all be at the passed depth.

Returns:

  • cell_ids (numpy.ndarray) – The rasterized cell ids.

  • depths (numpy.ndarray) – The depths of the cell ids. If flat is True, these will all have the same value.

  • fully_covered (numpy.ndarray) – Boolean array marking whether the cells are fully covered by the polygon.