Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

h3shape_to_cells_experimental takes string containment modes #436

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
+98 −103
Open

h3shape_to_cells_experimental takes string containment modes #436

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a579efb
polygon to cells just takes string arguments
ajfriend Dec 31, 2024
fb2cf65
don't need enum
ajfriend Dec 31, 2024
c5a5d65
docstrings
ajfriend Dec 31, 2024
c627dca
have tests use h3shape_to_cells_experimental
ajfriend Dec 31, 2024
0a5eac0
clean up tests
ajfriend Dec 31, 2024
81a96e2
don't repeat tests
ajfriend Dec 31, 2024
022de27
experimental warning
ajfriend Dec 31, 2024
49dbf59
Being experimental, try `contain` instead of `containment` in params
ajfriend Dec 31, 2024
4b805bf
try typing with literal
ajfriend Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docstrings
  • Loading branch information
@ajfriend
ajfriend committed Dec 31, 2024
commit c5a5d65986cad68038d22389943f350ffa7b4d0c
10 changes: 10 additions & 0 deletions docs/api_quick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,16 @@ Note that this is reversed from [``__geo_interface__``](https://gist.github.com/
cells_to_geo
```

#### Additional functions

```{eval-rst}
.. currentmodule:: h3

.. autosummary::
polygon_to_cells
h3shape_to_cells_experimental
```


## Specialized functions

Expand Down
9 changes: 7 additions & 2 deletions src/h3/api/basic_int/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,8 +535,13 @@ def h3shape_to_cells_experimental(h3shape, res, containment='center'):
h3shape : ``H3Shape``
res : int
Resolution of the output cells
containment: str
'center', 'full', 'overlap', 'bbox_overlap'
containment : {'center', 'full', 'overlap', 'bbox_overlap'}
Specifies the containment condition.
- 'center': Cell center is contained in shape
- 'full': Cell is fully contained in shape
- 'overlap': Cell is partially contained in shape
- 'bbox_overlap': Cell bounding box is partially contained in shape


Returns
-------
Expand Down
Loading