From fb0b315c83c41b2b8b0cf8adadce9ded0a69175e Mon Sep 17 00:00:00 2001 From: Kylen Solvik Date: Fri, 24 Jul 2026 14:55:38 -0400 Subject: [PATCH] Streamline docstrings from tile_coverage option --- src/geebeam/pipeline.py | 3 +-- src/geebeam/sampler.py | 6 +++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/geebeam/pipeline.py b/src/geebeam/pipeline.py index 536aaf3..cca1a25 100644 --- a/src/geebeam/pipeline.py +++ b/src/geebeam/pipeline.py @@ -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`. diff --git a/src/geebeam/sampler.py b/src/geebeam/sampler.py index 516fef1..7862153 100644 --- a/src/geebeam/sampler.py +++ b/src/geebeam/sampler.py @@ -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: