Remove CalculateCable grid override

Author: BrianMichell

src/mdio/commands/segy.py

@@ -257,8 +257,7 @@ def segy_import(  # noqa: PLR0913
         --header-names shot,cable,chan
         --header-types int32,None,int32
         --chunk-size 8,2,256,512
-        --grid-overrides '{"ChannelWrap": True, "ChannelsPerCable": 800,
-                           "CalculateCable": True}'
+        --grid-overrides '{"ChannelWrap": True, "ChannelsPerCable": 800}'
 
         \b
         If we do have cable numbers in the headers, but channels are still sequential (aka.

src/mdio/segy/geometry.py

@@ -374,9 +374,6 @@ def validate(self, index_headers: HeaderArray, grid_overrides: dict[str, bool |
         if "ChannelWrap" in grid_overrides:
             raise GridOverrideIncompatibleError(self.name, "ChannelWrap")
 
-        if "CalculateCable" in grid_overrides:
-            raise GridOverrideIncompatibleError(self.name, "CalculateCable")
-
         if self.required_keys is not None:
             self.check_required_keys(index_headers)
         self.check_required_params(grid_overrides)
@@ -437,9 +434,6 @@ def validate(self, index_headers: HeaderArray, grid_overrides: dict[str, bool |
         if "ChannelWrap" in grid_overrides:
             raise GridOverrideIncompatibleError(self.name, "ChannelWrap")
 
-        if "CalculateCable" in grid_overrides:
-            raise GridOverrideIncompatibleError(self.name, "CalculateCable")
-
         self.check_required_keys(index_headers)
         self.check_required_params(grid_overrides)
 
@@ -493,34 +487,6 @@ def transform(self, index_headers: HeaderArray, grid_overrides: dict[str, bool |
         return index_headers
 
 
-class CalculateCable(GridOverrideCommand):
-    """Calculate cable numbers from unwrapped channels."""
-
-    required_keys = {"shot_point", "cable", "channel"}
-    required_parameters = {"ChannelsPerCable"}
-
-    def validate(self, index_headers: HeaderArray, grid_overrides: dict[str, bool | int]) -> None:
-        """Validate if this transform should run on the type of data."""
-        if "AutoChannelWrap" in grid_overrides:
-            raise GridOverrideIncompatibleError(self.name, "AutoCableChannel")
-
-        self.check_required_keys(index_headers)
-        self.check_required_params(grid_overrides)
-
-    def transform(
-        self,
-        index_headers: HeaderArray,
-        grid_overrides: dict[str, bool | int],
-    ) -> NDArray:
-        """Perform the grid transform."""
-        self.validate(index_headers, grid_overrides)
-
-        channels_per_cable = grid_overrides["ChannelsPerCable"]
-        index_headers["cable"] = (index_headers["channel"] - 1) // channels_per_cable + 1
-
-        return index_headers
-
-
 class AutoShotWrap(GridOverrideCommand):
     """Automatically determine ShotGun acquisition type."""
 
@@ -574,7 +540,6 @@ def __init__(self) -> None:
         self.commands = {
             "AutoChannelWrap": AutoChannelWrap(),
             "AutoShotWrap": AutoShotWrap(),
-            "CalculateCable": CalculateCable(),
             "ChannelWrap": ChannelWrap(),
             "NonBinned": NonBinned(),
             "HasDuplicates": DuplicateIndex(),

tests/unit/test_segy_grid_overrides.py

@@ -147,56 +147,6 @@ def test_channel_wrap(self, mock_streamer_headers: dict[str, npt.NDArray]) -> No
         assert_array_equal(dims[1].coords, CABLES)
         assert_array_equal(dims[2].coords, RECEIVERS)
 
-    def test_calculate_cable(
-        self,
-        mock_streamer_headers: dict[str, npt.NDArray],
-    ) -> None:
-        """Test the CalculateCable command."""
-        index_names = ("shot_point", "cable", "channel")
-        grid_overrides = {"CalculateCable": True, "ChannelsPerCable": len(RECEIVERS)}
-
-        new_headers, new_names, new_chunks = run_override(grid_overrides, index_names, mock_streamer_headers)
-
-        assert new_names == index_names
-        assert new_chunks is None
-
-        dims = get_dims(new_headers)
-
-        # We need channels because unwrap isn't done here
-        channels = unique(mock_streamer_headers["channel"])
-
-        # We reset the cables to start from 1.
-        cables = arange(1, len(CABLES) + 1, dtype="uint32")
-
-        assert_array_equal(dims[0].coords, SHOTS)
-        assert_array_equal(dims[1].coords, cables)
-        assert_array_equal(dims[2].coords, channels)
-
-    def test_wrap_and_calc_cable(
-        self,
-        mock_streamer_headers: dict[str, npt.NDArray],
-    ) -> None:
-        """Test the combined ChannelWrap and CalculateCable commands."""
-        index_names = ("shot_point", "cable", "channel")
-        grid_overrides = {
-            "CalculateCable": True,
-            "ChannelWrap": True,
-            "ChannelsPerCable": len(RECEIVERS),
-        }
-
-        new_headers, new_names, new_chunks = run_override(grid_overrides, index_names, mock_streamer_headers)
-
-        assert new_names == index_names
-        assert new_chunks is None
-
-        dims = get_dims(new_headers)
-        # We reset the cables to start from 1.
-        cables = arange(1, len(CABLES) + 1, dtype="uint32")
-
-        assert_array_equal(dims[0].coords, SHOTS)
-        assert_array_equal(dims[1].coords, cables)
-        assert_array_equal(dims[2].coords, RECEIVERS)
-
     def test_missing_param(self, mock_streamer_headers: dict[str, npt.NDArray]) -> None:
         """Test missing parameters for the commands."""
         index_names = ("shot_point", "cable", "channel")
@@ -206,9 +156,6 @@ def test_missing_param(self, mock_streamer_headers: dict[str, npt.NDArray]) -> N
         with pytest.raises(GridOverrideMissingParameterError):
             overrider.run(mock_streamer_headers, index_names, {"ChannelWrap": True}, chunksize)
 
-        with pytest.raises(GridOverrideMissingParameterError):
-            overrider.run(mock_streamer_headers, index_names, {"CalculateCable": True}, chunksize)
-
     def test_incompatible_overrides(
         self,
         mock_streamer_headers: dict[str, npt.NDArray],
@@ -222,10 +169,6 @@ def test_incompatible_overrides(
         with pytest.raises(GridOverrideIncompatibleError):
             overrider.run(mock_streamer_headers, index_names, grid_overrides, chunksize)
 
-        grid_overrides = {"CalculateCable": True, "AutoChannelWrap": True}
-        with pytest.raises(GridOverrideIncompatibleError):
-            overrider.run(mock_streamer_headers, index_names, grid_overrides, chunksize)
-
     def test_unknown_override(
         self,
         mock_streamer_headers: dict[str, npt.NDArray],