astropy / astropy/regions

Introduce PixelRegion.overlaps

Open
#438 0 comments 0 reactions 0 assignees View on GitHub
feature-request shapes
Dominant language
Python
Stars
65
Forks
64
Avg merge
2d 13h
Merged PRs (30d)
4

Description

For some use cases e.g. when placing regions algorithmically a method like `PixelRegion.overlaps(other_region)` would be useful. This will be easily to implement once e.g. `CompoundRegion.area` is supported (see #433). In this case the implementation would reduce to:
```python3
def overlaps(self, other):
intersection = self.intersection(other)
return intersection.area > 0
```
For some specific cases it could also be implemented analytically if needed.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating PixelRegion and CompoundRegion, then read issue #433 about CompoundRegion.area and inspect the existing intersection behavior. Determine how overlap should handle the region types and boundary cases; done means PixelRegion.overlaps(other_region) reliably reports whether the intersection has positive area.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.