refactor: update GridFromPolygon (#241)

* added GridFromPolygon

* style(pre-commit.ci): auto fixes [...]

* shapely for all logic, and refactored pydantic bit

* style(pre-commit.ci): auto fixes [...]

* feat: brought tile formation in line with other gridplans, and updated plotting

* style(pre-commit.ci): auto fixes [...]

* refactored docstrings

* style(pre-commit.ci): auto fixes [...]

* moved polygon manipulation to initialization, added plotting offsetted polygon

Moved offset and convex hull before bounding box creation of prepared polygon.
Offset polygon is now used for plotting.
Some skipped tiles seem to be present when offsetting, different buffer style may fix that.

Not happy yet with the coverage of the exterior line of the polygon, may be because of the bounding box is under/over-influenced by fov-size.

* style(pre-commit.ci): auto fixes [...]

* Added docstrings, removed some non functional pydantic annotations, enlarged initial bounding box

enlarged the initial bounding box slightly by fov, this ensures to-be-checked tiles will also be created on the extreme edges of the polygon.

* Import PrivateAttr to hide some attributes in the signature gridfrompolygon

* Fix private attributes

* feat: update polygon

* fix: fix MDASequence

* fix: fix MDASequence

* feat: update plot methods

* fix: set default

* feat: handle plot figure size

* fix ZeroDivisionError

* fix overlap

* style(pre-commit.ci): auto fixes [...]

* fix mypy

* fix again

* ignore deprecation

* change semantics of polygon bounds

* remove caching

* format

* fix test

* skip win3.9

---------

Co-authored-by: rlokkie <re.lokhorst@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Talley Lambert <talley.lambert@gmail.com>
Co-authored-by: rlokkie <93552211+rlokkie@users.noreply.github.com>

Author: 4 people

examples/grid_from_poly.py

@@ -0,0 +1,10 @@
+from useq import GridFromPolygon
+
+grid = GridFromPolygon(
+    vertices=[(0, 0), (3, 0), (3, 0.82), (1, 1), (0.7, 3), (0, 3)],
+    fov_height=0.4,
+    fov_width=0.4,
+    # convex_hull=True,
+)
+
+grid.plot(show=True)

pyproject.toml

@@ -42,6 +42,7 @@ dependencies = [
     "numpy >=1.26.0; python_version >= '3.12'",
     "numpy >=1.25.2",
     "typing-extensions >=4",
+    "shapely>=2.0.7",
 ]
 
 # extras
@@ -131,7 +132,10 @@ ban-relative-imports = "all"
 [tool.pytest.ini_options]
 minversion = "6.0"
 testpaths = ["tests"]
-filterwarnings = ["error"]
+filterwarnings = [
+    "error",
+    "ignore:'mode' parameter is deprecated and will be removed:DeprecationWarning",
+]
 
 # https://mypy.readthedocs.io/en/stable/config_file.html
 [tool.mypy]

src/useq/_base_model.py

@@ -20,7 +20,7 @@
 
     from typing_extensions import Self
 
-    ReprArgs = Iterable[tuple[str | None, Any]]
+    ReprArgs = Iterable[tuple["str | None", Any]]
 
 __all__ = ["FrozenModel", "UseqModel"]