`hipscat.pixel_math.polygon_filter`#

Module Contents#

`filter_pixels_by_polygon`(...)	Filter the leaf pixels in a pixel tree to return a list of healpix pixels that
`_generate_polygon_pixel_tree`(...)	Generates a pixel_tree filled with leaf nodes at a given order that overlap within

`SphericalCoordinates`
`CartesianCoordinates`

filter_pixels_by_polygon(pixel_tree: hipscat.pixel_tree.pixel_tree.PixelTree, vertices: List[CartesianCoordinates]) → List[hipscat.pixel_math.HealpixPixel][source]#

Filter the leaf pixels in a pixel tree to return a list of healpix pixels that overlap with a polygonal region.

Parameters:

pixel_tree (PixelTree) – The catalog tree to filter pixels from.
vertices (List[CartesianCoordinates]) – The vertices of the polygon to filter points with, in lists of (x,y,z) points on the unit sphere.

Returns:

List of HealpixPixel, representing only the pixels that overlap with the specified polygonal region, and the maximum pixel order.

_generate_polygon_pixel_tree(vertices: numpy.array, order: int) → hipscat.pixel_tree.pixel_tree.PixelTree[source]#: Generates a pixel_tree filled with leaf nodes at a given order that overlap within a polygon. Vertices is an array of 3D coordinates, in cartesian representation (x,y,z) and shape (Num vertices, 3), representing the vertices of the polygon.