Fix add_bounds() breaking when time coords are cftime objects
#241
Conversation
This file contains 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
- Remove `dataset` param from `TemporalAccessor.center_times()` to allow for standalone usage - Update names of tests for private functions in `test_dataset.py`
tomvothecoder
added
type: bug
tomvothecoder
commented
May 26, 2022
xcdat/bounds.py
Outdated
Comment on lines
258
to
282
| # Add beginning and end points to account for lower and upper bounds. | ||
| # np.array of string values with `dtype="timedelta64[ns]"` | ||
| diffs = np.insert(diffs, 0, diffs[0]) | ||
| diffs = np.append(diffs, diffs[-1]) | ||
|
|
||
| # Get lower and upper bounds by using the width relative to nearest point. | ||
| # Transpose both bound arrays into a 2D array. | ||
| lower_bounds = da_coord - diffs[:-1] * width | ||
| upper_bounds = da_coord + diffs[1:] * (1 - width) | ||
| # In xarray and xCDAT, time coordinates with non-CF compliant calendars | ||
| # (360-day, noleap) and/or units ("months", "years") are decoded using | ||
| # `cftime` objects instead of `datetime` objects. `cftime` objects only | ||
| # support arithmetic using `timedelta` objects, so the values of `diffs` | ||
| # must be casted from `dtype="timedelta64[ns]"` to `timedelta`. | ||
| if da_coord.name in ("T", "time") and issubclass( | ||
| type(da_coord.values[0]), cftime.datetime | ||
| ): | ||
| diffs = pd.to_timedelta(diffs) | ||
|
|
||
| # FIXME: These lines produces the warning: `PerformanceWarning: | ||
| # Adding/subtracting object-dtype array to TimedeltaArray not | ||
| # vectorized` after converting diffs to `timedelta`. I (Tom) was not | ||
| # able to find an alternative, vectorized solution at the time of this | ||
| # implementation. | ||
| with warnings.catch_warnings(): | ||
| warnings.simplefilter("ignore", category=pd.errors.PerformanceWarning) | ||
| lower_bounds = da_coord - diffs[:-1] * width | ||
| upper_bounds = da_coord + diffs[1:] * (1 - width) | ||
|
|
There was a problem hiding this comment.
The primary code change
tomvothecoder
commented
May 26, 2022
| if hasattr(self, "_time_bounds") is False: | ||
| self._time_bounds = ds.bounds.get_bounds("time") | ||
| ds = self._dataset.copy() | ||
| time_bounds = ds.bounds.get_bounds("time") |
There was a problem hiding this comment.
This update to center_times() makes it callable as a standalone method, instead of having to pass a dataset object to it. (from ds.temporal.center_times(ds) to ds.temporal.center_times())
tomvothecoder
commented
May 26, 2022
tomvothecoder
commented
May 26, 2022
Codecov Report
@@ Coverage Diff @@
## main #241 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 9 8 -1
Lines 742 728 -14
=========================================
- Hits 742 728 -14
Continue to review full report at Codecov.
|
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.
Description
add_bounds()breaks when time coordinates are incftimeobjects instead ofdatetime#240Summary of Changes
add_bounds()breaking when time coords arecftimeobjectsdsas a keyword arg forTemporalAccessor.center_times()to allow for standalone usagetest_temporal.pywith masked dataChecklist
pd.PerformanceWarning. There is a#FIXMEcomment to address this in the future.If applicable: