Point In Face & Get Faces Containing Point

[aaronzedwick]

Closes #905, #1141

Overview

Expected Usage

from uxarray.grid.geometry import point_in_polygon

# Defined polygon
polygon = [ [-10,  10, -10, 10], [10, 10, -10, -10]]

# Point to check
point = [10, 10]

point_in_polygon(polygon, point, inclusive=True)

PR Checklist

General

• An issue is linked created and linked
• Add appropriate labels
• Filled out Overview and Expected Usage (if applicable) sections

Testing

• Adequate tests are created if there is new functionality
• Tests cover all possible logical paths in your function
• Tests are not too basic (such as simply calling a function and nothing else)

Documentation

• Docstrings have been added to all new functions
• Docstrings have updated with any function changes
• Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
• User functions have been added to docs/user_api/index.rst

[aaronzedwick]

@ philipc2 do you think this should be an internal function or exposed to the user?

[philipc2]

Please include an ASV benchmark. I'd suggest doing a parameterized benchmark for the 120 and 480 km MPAS grids.

[philipc2]

Please use the optimized functions from #1072 and try to write the function entirely in Numba. This may require us to pass in both the cartesian and spherical versions of point & polygon. Let me know if you have any questions!

[rajeeja]

we need a tolerance, probably controllable by the user for this implementation

[philipc2]

Excellent work @aaronzedwick

A few small comments below.

Also, may you please run a few small benchmarks and profile the code on the 30km MPAS grid, similar to what I shared above.

Something like the following would be a good example:

• Assume some fixed grid of center points, perhaps from a structured grid.
• Compute the time it takes to determine which face each point lies within

Share the timing, with a screenshot of the profiling output like what I shared above.

[aaronzedwick]

@philipc2 @rajeeja Here are the profiling results you asked for!

Most of the time comes from the subsetting method, the actual _find_faces function takes up very little time:

[philipc2]

@philipc2 @rajeeja Here are the profiling results you asked for!

Most of the time comes from the subsetting method, the actual _find_faces function takes up very little time:

Excellent! Once we optimize isel (and perhaps node_x) we will be in a great spot performance wise.