uxarray.grid.geometry._pole_point_inside_polygon

uxarray.grid.geometry._pole_point_inside_polygon(pole, face_edge_cart)

Determines if a pole point is inside a polygon.

Note

• If the pole point is on the edge of the polygon, it will be considered “inside the polygon”.

Parameters:

• pole (str) – Either ‘North’ or ‘South’.

• face_edge_cart (np.ndarray) – A face polygon represented by edges in Cartesian coordinates. Shape: (n_edges, 2, 3)

Returns:

True if pole point is inside polygon, False otherwise.

Return type:

bool

Raises:

ValueError – If the provided pole is neither ‘North’ nor ‘South’.

Warning

UserWarning

Raised if the face contains both pole points.