updates to 1xMxN vs MxN issue

tobac-project · Jan 24, 2025 · d6ee0a1 · d6ee0a1
1 parent 1364012
commit d6ee0a1
Show file tree

Hide file tree

Showing 3 changed files with 243 additions and 953 deletions.
diff --git a/...ple_Track_on_Radar_Segment_on_Satellite/Example_Track_on_Radar_Segment_on_Satellite.ipynb b/...ple_Track_on_Radar_Segment_on_Satellite/Example_Track_on_Radar_Segment_on_Satellite.ipynb
diff --git a/tobac/segmentation/watershed_segmentation.py b/tobac/segmentation/watershed_segmentation.py
@@ -34,6 +34,7 @@
 import copy
 import logging
 import datetime
+import warnings
 
 import iris.cube
 import xarray as xr
@@ -353,7 +354,7 @@ def segmentation_timestep(
 
     Parameters
     ----------
-    field_in : iris.cube.Cube
+    field_in : xr.DataArray
         Input field to perform the watershedding on (2D or 3D for one
         specific point in time).
 
@@ -1264,6 +1265,13 @@ def segmentation(
     else:
         all_times = features["time"].map(np.datetime64)
 
+    if len(field.coords[time_var_name]) == 1:
+        warnings.warn(
+            "As of v1.6.0, segmentation with time length 1 will return time as a coordinate"
+            " instead of dropping it (i.e., output will now be 1xMxN instead of MxN). ",
+            UserWarning,
+        )
+
     for time_iteration_number, time_iteration_value in enumerate(
         field.coords[time_var_name]
     ):

diff --git a/tobac/tests/segmentation_tests/test_iris_xarray_segmentation.py b/tobac/tests/segmentation_tests/test_iris_xarray_segmentation.py