Skip to content

Streamline docstrings from tile_coverage option #113

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

Merged
kysolvik merged 1 commit into from
Jul 24, 2026
Merged

Streamline docstrings from tile_coverage option #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions src/geebeam/pipeline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,8 +424,7 @@ def grid_and_run_pipeline(
tile_coverage: Which grid tiles to keep relative to ``sampling_region``.
'clip' (default): keep a tile only if its sampling point (the patch reference
point set by ``position``) falls inside the region.
'center_clip': keep a tile only if its patch center falls inside the region,
regardless of ``position``.
'center_clip': keep a tile only if its patch center falls inside the region.
'intersect': keep any tile whose full ``patch_size`` footprint touches the region,
guaranteeing gap-free coverage at the edges.
**kwargs: Additional keyword arguments are documented in :meth:`pipeline.run_pipeline`.
Expand Down
6 changes: 3 additions & 3 deletions src/geebeam/sampler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,9 @@ def sample_region_grid(
'top-left', 'top-right', 'bottom-left', or 'bottom-right'. Only
matters when ``tile_coverage`` is not 'clip'.
tile_coverage: Which tiles to keep relative to ``roi``. 'clip' (default)
keeps a tile if its sampling point falls inside ``roi``; 'center_clip'
keeps a tile if its patch center falls inside ``roi``, regardless of
``position``; 'intersect' keeps a tile if any part of its patch footprint
keeps a tile if its sampling point falls inside ``roi``;
'center_clip' keeps a tile if its patch center falls inside ``roi``.;
'intersect' keeps a tile if any part of its patch footprint
touches ``roi``. The latter two require ``patch_size``.

Returns:
Expand Down