(scipy 2022 branch) Add an "options" argument to Index.from_variables() #6800
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.
It allows passing options to the constructor of a custom
Index
subclass, in case there's any relevant build options to expose to users. This could for example be the distance metric chosen for an index based onsklearn.neighbors.BallTree
, or the CRS definition for a geospatial index.The
**options
arguments ofDataset.set_xindex()
are passed through.An alternative way would be to pass options via coordinate metadata, like the
spatial_ref
coordinate in rioxarray. Perhaps both alternatives may co-exist?This PR also adds type annotations to
set_xindex()
.