Introduce basic classes for regions of interest #396
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
Why is this PR needed?
A first step towards addressing #377 - introduces the low-level classes that we will need to represent these in the codebase.
As stated on the issue, we have to use wrapper classes since inheriting from
shapely
classes is problematic. This doesn't really matter too much though - if anything, it is rather helpful for separating the underlying (and rather counter-intuitive at times)shapely
objects from the higher-level analysis functions that we're going to implement.What does this PR do?
roi
submodule, which contains a base class and two derived classes for representing RoIs.References
#377
How has this PR been tested?
Addition of tests to the testing suite.
Docs successfully build.
Is this a breaking change?
No
Does this PR require an update to the documentation?
Checklist: