add point_is_inside to BaseRegionOfInterest

[stellaprins]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
To enable implementation of event arrays.
What does this PR do?
Enables to determine if a position (a Shapely 2D or 3D point) is inside the region of interest (by default including the boundary of the region).

References

#408

How has this PR been tested?

Tests added for a polygon with a hole and a line (with and without boundaries)

Is this a breaking change?

No.

Does this PR require an update to the documentation?

No, not necessarily. But down the line the functionality could be used in an example. See #415.

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.83%. Comparing base (0e1951d) to head (e7c8a52).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #413   +/-   ##
=======================================
  Coverage   99.83%   99.83%           
=======================================
  Files          22       22           
  Lines        1207     1219   +12     
=======================================
+ Hits         1205     1217   +12     
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[niksirbi]

Looks good to go @stellaprins (apart from a few pedantic suggestions).

I would also like to put forward a suggesiton for naming the method as contains_point instead of point_is_inside.

My reasoning is explained in the following mock code snippet:

poly = PolygonOfInterest(exterior_boundary)
poly.contains_point(data_array)   # this reads more natural to me
poly.point_is_inside(data_array)  # understandable, but doesn't flow as nicely

Opinions on this @stellaprins, @willGraham01?

[niksirbi]

I also opened a new issue #415 to showcase this feature in an example (assigned to myself).

[willGraham01]

I would also like to put forward a suggesiton for naming the method as contains_point instead of point_is_inside.

No strong opinions, happy to go with this - you are right that "polygon contains point" reads better than "polygon point is inside"

[stellaprins]

Thanks for the suggestions @niksirbi

I would also like to put forward a suggesiton for naming the method as contains_point instead of point_is_inside.
Sounds good!

All done.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud