shot_point (TGSAI#602)

Author: dmitriyrepin

src/mdio/schemas/v1/templates/abstract_dataset_template.py

@@ -38,7 +38,7 @@ def __init__(self, domain: str = "") -> None:
         # e.g. ["cdp", "depth"] for 2D post-stack depth
         # e.g. ["inline", "crossline", "depth"] for 3D post-stack depth
         # e.g. ["inline", "crossline", "offset", "depth"] for 3D pre-stack depth CPD gathers
-        # e.g. ["energy_source_point_num", "cable", "channel", "time"] for 3D pre-stack
+        # e.g. ["shot_point", "cable", "channel", "time"] for 3D pre-stack
         #      time Shot gathers
         self._dim_names = []
         # Names of all coordinates in the dataset

src/mdio/schemas/v1/templates/seismic_2d_prestack_shot.py

@@ -12,7 +12,7 @@ class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
     def __init__(self, domain: str):
         super().__init__(domain=domain)
 
-        self._coord_dim_names = ["energy_source_point_num", "channel"]  # Custom coordinate definition for shot gathers
+        self._coord_dim_names = ["shot_point", "channel"]  # Custom coordinate definition for shot gathers
         self._dim_names = [*self._coord_dim_names, self._trace_domain]
         self._coord_names = ["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"]
         self._var_chunk_shape = [1, 512, 4096]
@@ -25,7 +25,7 @@ def _load_dataset_attributes(self) -> UserAttributes:
         return UserAttributes(
             attributes={
                 "surveyDimensionality": "2D",
-                "ensembleType": "shot",
+                "ensembleType": "shot_point",
                 "processingStage": "pre-stack",
             }
         )
@@ -43,31 +43,31 @@ def _add_coordinates(self) -> None:
         # Add non-dimension coordinates
         self._builder.add_coordinate(
             "gun",
-            dimensions=["energy_source_point_num", "channel"],
+            dimensions=["shot_point", "channel"],
             data_type=ScalarType.UINT8,
             metadata_info=[AllUnits(units_v1=None)],
         )
         self._builder.add_coordinate(
             "source_coord_x",
-            dimensions=["energy_source_point_num", "channel"],
+            dimensions=["shot_point", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "source_coord_y",
-            dimensions=["energy_source_point_num", "channel"],
+            dimensions=["shot_point", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "group_coord_x",
-            dimensions=["energy_source_point_num", "channel"],
+            dimensions=["shot_point", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "group_coord_y",
-            dimensions=["energy_source_point_num", "channel"],
+            dimensions=["shot_point", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )

src/mdio/schemas/v1/templates/seismic_3d_prestack_shot.py

@@ -12,7 +12,7 @@ class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
     def __init__(self, domain: str):
         super().__init__(domain=domain)
 
-        self._coord_dim_names = ["energy_source_point_num", "cable", "channel"]  # Custom coordinates for shot gathers
+        self._coord_dim_names = ["shot_point", "cable", "channel"]  # Custom coordinates for shot gathers
         self._dim_names = [*self._coord_dim_names, self._trace_domain]
         self._coord_names = ["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"]
         self._var_chunk_shape = [1, 1, 512, 4096]
@@ -25,7 +25,7 @@ def _load_dataset_attributes(self) -> UserAttributes:
         return UserAttributes(
             attributes={
                 "surveyDimensionality": "3D",
-                "ensembleType": "shot",
+                "ensembleType": "shot_point",
                 "processingStage": "pre-stack",
             }
         )
@@ -43,31 +43,31 @@ def _add_coordinates(self) -> None:
         # Add non-dimension coordinates
         self._builder.add_coordinate(
             "gun",
-            dimensions=["energy_source_point_num", "cable", "channel"],
+            dimensions=["shot_point", "cable", "channel"],
             data_type=ScalarType.UINT8,
             metadata_info=[AllUnits(units_v1=None)],
         )
         self._builder.add_coordinate(
             "source_coord_x",
-            dimensions=["energy_source_point_num", "cable", "channel"],
+            dimensions=["shot_point", "cable", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "source_coord_y",
-            dimensions=["energy_source_point_num", "cable", "channel"],
+            dimensions=["shot_point", "cable", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "group_coord_x",
-            dimensions=["energy_source_point_num", "cable", "channel"],
+            dimensions=["shot_point", "cable", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )
         self._builder.add_coordinate(
             "group_coord_y",
-            dimensions=["energy_source_point_num", "cable", "channel"],
+            dimensions=["shot_point", "cable", "channel"],
             data_type=ScalarType.FLOAT64,
             metadata_info=[self._horizontal_coord_unit],
         )

tests/integration/test_segy_import_export_masked.py

@@ -128,15 +128,15 @@ def __iter__(self) -> Iterable[MaskedExportConfigTypes]:
 )
 
 STREAMER_2D_CONF = MaskedExportConfig(
-    GridConfig(name="2d_streamer", dims=[Dimension("energy_source_point_num", 10, 10, 1), Dimension("channel", 25, 60, 25)]),
-    SegyFactoryConfig(revision=1, header_byte_map={"energy_source_point_num": 7, "channel": 131}, num_samples=201),
+    GridConfig(name="2d_streamer", dims=[Dimension("shot_point", 10, 10, 1), Dimension("channel", 25, 60, 25)]),
+    SegyFactoryConfig(revision=1, header_byte_map={"shot_point": 7, "channel": 131}, num_samples=201),
     SegyToMdioConfig(chunks=[2, 12, 128]),
     SelectionMaskConfig(mask_num_dims=1, remove_frac=0.7),
 )
 
 STREAMER_3D_CONF = MaskedExportConfig(
-    GridConfig(name="3d_streamer", dims=[Dimension("energy_source_point_num", 10, 5, 1), Dimension("cable", 1, 6, 1), Dimension("channel", 25, 60, 25)]),
-    SegyFactoryConfig(revision=1, header_byte_map={"energy_source_point_num": 7, "cable": 193, "channel": 131}, num_samples=201),
+    GridConfig(name="3d_streamer", dims=[Dimension("shot_point", 10, 5, 1), Dimension("cable", 1, 6, 1), Dimension("channel", 25, 60, 25)]),
+    SegyFactoryConfig(revision=1, header_byte_map={"shot_point": 7, "cable": 193, "channel": 131}, num_samples=201),
     SegyToMdioConfig(chunks=[1, 2, 12, 128]),
     SelectionMaskConfig(mask_num_dims=1, remove_frac=0.5),
 )

tests/unit/test_segy_grid_overrides.py

@@ -133,7 +133,7 @@ class TestStreamerGridOverrides:
 
     def test_channel_wrap(self, mock_streamer_headers: dict[str, npt.NDArray]) -> None:
         """Test the ChannelWrap command."""
-        index_names = ("shot", "cable", "channel")
+        index_names = ("shot_point", "cable", "channel")
         grid_overrides = {"ChannelWrap": True, "ChannelsPerCable": len(RECEIVERS)}
 
         new_headers, new_names, new_chunks = run_override(grid_overrides, index_names, mock_streamer_headers)
@@ -152,7 +152,7 @@ def test_calculate_cable(
         mock_streamer_headers: dict[str, npt.NDArray],
     ) -> None:
         """Test the CalculateCable command."""
-        index_names = ("shot", "cable", "channel")
+        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)
@@ -177,7 +177,7 @@ def test_wrap_and_calc_cable(
         mock_streamer_headers: dict[str, npt.NDArray],
     ) -> None:
         """Test the combined ChannelWrap and CalculateCable commands."""
-        index_names = ("shot", "cable", "channel")
+        index_names = ("shot_point", "cable", "channel")
         grid_overrides = {
             "CalculateCable": True,
             "ChannelWrap": True,
@@ -199,7 +199,7 @@ def test_wrap_and_calc_cable(
 
     def test_missing_param(self, mock_streamer_headers: dict[str, npt.NDArray]) -> None:
         """Test missing parameters for the commands."""
-        index_names = ("shot", "cable", "channel")
+        index_names = ("shot_point", "cable", "channel")
         chunksize = None
         overrider = GridOverrider()
 
@@ -214,7 +214,7 @@ def test_incompatible_overrides(
         mock_streamer_headers: dict[str, npt.NDArray],
     ) -> None:
         """Test commands that can't be run together."""
-        index_names = ("shot", "cable", "channel")
+        index_names = ("shot_point", "cable", "channel")
         chunksize = None
         overrider = GridOverrider()
 
@@ -231,7 +231,7 @@ def test_unknown_override(
         mock_streamer_headers: dict[str, npt.NDArray],
     ) -> None:
         """Test exception if user provides a command that's not allowed."""
-        index_names = ("shot", "cable", "channel")
+        index_names = ("shot_point", "cable", "channel")
         chunksize = None
         overrider = GridOverrider()
         with pytest.raises(GridOverrideUnknownError):

tests/unit/v1/templates/test_seismic_3d_prestack_shot.py

@@ -28,25 +28,25 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     validate_variable(
         dataset,
         name="headers",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"],
         dtype=headers,
     )
 
     validate_variable(
         dataset,
         name="trace_mask",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"],
         dtype=ScalarType.BOOL,
     )
 
     # Verify dimension coordinate variables
     inline = validate_variable(
         dataset,
-        name="energy_source_point_num",
-        dims=[("energy_source_point_num", 256)],
-        coords=["energy_source_point_num"],
+        name="shot_point",
+        dims=[("shot_point", 256)],
+        coords=["shot_point"],
         dtype=ScalarType.INT32,
     )
     assert inline.metadata is None
@@ -82,15 +82,15 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     validate_variable(
         dataset,
         name="gun",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["gun"],
         dtype=ScalarType.UINT8,
     )
 
     source_coord_x = validate_variable(
         dataset,
         name="source_coord_x",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["source_coord_x"],
         dtype=ScalarType.FLOAT64,
     )
@@ -99,7 +99,7 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     source_coord_y = validate_variable(
         dataset,
         name="source_coord_y",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["source_coord_y"],
         dtype=ScalarType.FLOAT64,
     )
@@ -108,7 +108,7 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     group_coord_x = validate_variable(
         dataset,
         name="group_coord_x",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["group_coord_x"],
         dtype=ScalarType.FLOAT64,
     )
@@ -117,7 +117,7 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     group_coord_y = validate_variable(
         dataset,
         name="group_coord_y",
-        dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24)],
+        dims=[("shot_point", 256), ("cable", 512), ("channel", 24)],
         coords=["group_coord_y"],
         dtype=ScalarType.FLOAT64,
     )
@@ -133,8 +133,8 @@ def test_configuration_depth(self) -> None:
 
         # Template attributes for prestack shot
         assert t._trace_domain == "depth"
-        assert t._coord_dim_names == ["energy_source_point_num", "cable", "channel"]
-        assert t._dim_names == ["energy_source_point_num", "cable", "channel", "depth"]
+        assert t._coord_dim_names == ["shot_point", "cable", "channel"]
+        assert t._dim_names == ["shot_point", "cable", "channel", "depth"]
         assert t._coord_names == ["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"]
         assert t._var_chunk_shape == [1, 1, 512, 4096]
 
@@ -147,7 +147,7 @@ def test_configuration_depth(self) -> None:
         attrs = t._load_dataset_attributes()
         assert attrs.attributes == {
             "surveyDimensionality": "3D",
-            "ensembleType": "shot",
+            "ensembleType": "shot_point",
             "processingStage": "pre-stack",
         }
         assert t.trace_variable_name == "amplitude"
@@ -158,8 +158,8 @@ def test_configuration_time(self) -> None:
 
         # Template attributes for prestack shot
         assert t._trace_domain == "time"
-        assert t._coord_dim_names == ["energy_source_point_num", "cable", "channel"]
-        assert t._dim_names == ["energy_source_point_num", "cable", "channel", "time"]
+        assert t._coord_dim_names == ["shot_point", "cable", "channel"]
+        assert t._dim_names == ["shot_point", "cable", "channel", "time"]
         assert t._coord_names == ["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"]
         assert t._var_chunk_shape == [1, 1, 512, 4096]
 
@@ -172,7 +172,7 @@ def test_configuration_time(self) -> None:
         attrs = t._load_dataset_attributes()
         assert attrs.attributes == {
             "surveyDimensionality": "3D",
-            "ensembleType": "shot",
+            "ensembleType": "shot_point",
             "processingStage": "pre-stack",
         }
 
@@ -204,7 +204,7 @@ def test_build_dataset_depth(self, structured_headers: StructuredType) -> None:
 
         assert dataset.metadata.name == "Gulf of Mexico 3D Shot Depth"
         assert dataset.metadata.attributes["surveyDimensionality"] == "3D"
-        assert dataset.metadata.attributes["ensembleType"] == "shot"
+        assert dataset.metadata.attributes["ensembleType"] == "shot_point"
         assert dataset.metadata.attributes["processingStage"] == "pre-stack"
 
         _validate_coordinates_headers_trace_mask(dataset, structured_headers, "depth")
@@ -213,7 +213,7 @@ def test_build_dataset_depth(self, structured_headers: StructuredType) -> None:
         seismic = validate_variable(
             dataset,
             name="amplitude",
-            dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24), ("depth", 2048)],
+            dims=[("shot_point", 256), ("cable", 512), ("channel", 24), ("depth", 2048)],
             coords=["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"],
             dtype=ScalarType.FLOAT32,
         )
@@ -237,7 +237,7 @@ def test_build_dataset_time(self, structured_headers: StructuredType) -> None:
 
         assert dataset.metadata.name == "North Sea 3D Shot Time"
         assert dataset.metadata.attributes["surveyDimensionality"] == "3D"
-        assert dataset.metadata.attributes["ensembleType"] == "shot"
+        assert dataset.metadata.attributes["ensembleType"] == "shot_point"
         assert dataset.metadata.attributes["processingStage"] == "pre-stack"
 
         _validate_coordinates_headers_trace_mask(dataset, structured_headers, "time")
@@ -246,7 +246,7 @@ def test_build_dataset_time(self, structured_headers: StructuredType) -> None:
         seismic = validate_variable(
             dataset,
             name="amplitude",
-            dims=[("energy_source_point_num", 256), ("cable", 512), ("channel", 24), ("time", 2048)],
+            dims=[("shot_point", 256), ("cable", 512), ("channel", 24), ("time", 2048)],
             coords=["gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y"],
             dtype=ScalarType.FLOAT32,
         )