Refactor CRS-aware index #27
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ProjIndexMixin class: - replace the ``_proj_get_crs`` abstract method by the ``crs`` abstract (public) property. - add ``_proj_crs_equals`` helper method Xproj now identifies an Xarray index as CRS-aware if it has a ``crs`` property that returns either a ``pyproj.CRS`` object or ``None``. A CRS-aware index may have an undefined CRS (``None``). Add ``CRSAwareIndex`` protocol class.
Copied and adapted from xvec.
benbovy
commented
Jun 6, 2025
Comment on lines
+34
to
+35
| # TODO: eventually we won't need to copy the xarray.Index interface here? | ||
| # (https://github.com/python/typing/issues/213) |
There was a problem hiding this comment.
Unfortunately AFAIK there's no current way around copying the xarray Index interface. I didn't copied the whole Index interface, just the main functions to avoid maintenance hassle.
scottyhq
reviewed
Jun 6, 2025
scottyhq
approved these changes
Jun 6, 2025
|
We already soft depend on xproj so having it as a hard dep makes it only easier. |
|
If everyone is OK with this, I'm going to proceed like this:
|
|
Happy to defer to your judgement, @benbovy ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have copied here some CRS-specific code from
xvecso it can be easily reused elsewhere.@martinfleis -- to give you a bit more context, we are adding CRS-aware functionality to RasterIndex in https://github.com/dcherian/rasterix/pull/31. The functionality is very similar to the CRS functionality implemented in
xvec.GeometryIndex, so instead of copying the CRS stuff into RasterIndex I thought it would be nice to have it implemented in a common place (xproj would nicely fit).With this PR, we could refactor
xvec.GeometryIndexlike this:and internally reuse the CRS helper methods that are provided by
xproj.ProjIndexMixin(i.e., move the maintenance of most CRS stuff to xproj). Another benefit is better integration betweenxvecandxproj.Of course this would mean that
xprojbecomes a required dependency ofxvec, but that's probably fine I guess?xprojonly depends on Xarray and Pyproj...If you agree with this, I'm happy to submit a PR to
xvecafter merging this PR and making a new release ofxproj.