Rename Pre-Stack templates to be more clear (TGSAI#734)

* remove pre-stack from template names

* rename shot gather for clearer template names

* remove time from shot gathers since its obvious.

* `shot_streamer` to `streamer_shot`

---------

Co-authored-by: Altay Sansal <[email protected]>

Author: tasansal

src/mdio/builder/template_registry.py

@@ -20,13 +20,13 @@
 from typing import TYPE_CHECKING
 
 from mdio.builder.formatting_html import template_registry_repr_html
+from mdio.builder.templates.seismic_2d_cdp import Seismic2DCdpGathersTemplate
 from mdio.builder.templates.seismic_2d_poststack import Seismic2DPostStackTemplate
-from mdio.builder.templates.seismic_2d_prestack_cdp import Seismic2DPreStackCDPTemplate
-from mdio.builder.templates.seismic_2d_prestack_shot import Seismic2DPreStackShotTemplate
+from mdio.builder.templates.seismic_2d_streamer_shot import Seismic2DStreamerShotGathersTemplate
+from mdio.builder.templates.seismic_3d_cdp import Seismic3DCdpGathersTemplate
+from mdio.builder.templates.seismic_3d_coca import Seismic3DCocaGathersTemplate
 from mdio.builder.templates.seismic_3d_poststack import Seismic3DPostStackTemplate
-from mdio.builder.templates.seismic_3d_prestack_cdp import Seismic3DPreStackCDPTemplate
-from mdio.builder.templates.seismic_3d_prestack_coca import Seismic3DPreStackCocaTemplate
-from mdio.builder.templates.seismic_3d_prestack_shot import Seismic3DPreStackShotTemplate
+from mdio.builder.templates.seismic_3d_streamer_shot import Seismic3DStreamerShotGathersTemplate
 
 if TYPE_CHECKING:
     from mdio.builder.templates.base import AbstractDatasetTemplate
@@ -126,15 +126,15 @@ def _register_default_templates(self) -> None:
         # CDP/CMP Ordered Data
         for data_domain in ("time", "depth"):
             for gather_domain in ("offset", "angle"):
-                self.register(Seismic3DPreStackCDPTemplate(data_domain, gather_domain))
-                self.register(Seismic2DPreStackCDPTemplate(data_domain, gather_domain))
+                self.register(Seismic3DCdpGathersTemplate(data_domain, gather_domain))
+                self.register(Seismic2DCdpGathersTemplate(data_domain, gather_domain))
 
-        self.register(Seismic3DPreStackCocaTemplate("time"))
-        self.register(Seismic3DPreStackCocaTemplate("depth"))
+        self.register(Seismic3DCocaGathersTemplate("time"))
+        self.register(Seismic3DCocaGathersTemplate("depth"))
 
         # Field (shot) data
-        self.register(Seismic2DPreStackShotTemplate("time"))
-        self.register(Seismic3DPreStackShotTemplate("time"))
+        self.register(Seismic2DStreamerShotGathersTemplate())
+        self.register(Seismic3DStreamerShotGathersTemplate())
 
     def get(self, template_name: str) -> AbstractDatasetTemplate:
         """Get an instance of a template from the registry by its name.

src/mdio/builder/templates/seismic_2d_prestack_cdp.py renamed to src/mdio/builder/templates/seismic_2d_cdp.py

@@ -1,4 +1,4 @@
-"""Seismic2DPreStackCDPTemplate MDIO v1 dataset templates."""
+"""Seismic2DCDPGathersTemplate MDIO v1 dataset templates."""
 
 from typing import Any
 
@@ -7,7 +7,7 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
+class Seismic2DCdpGathersTemplate(AbstractDatasetTemplate):
     """Seismic CDP pre-stack 2D time or depth Dataset template."""
 
     def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
@@ -26,7 +26,7 @@ def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomai
     def _name(self) -> str:
         gather_domain_suffix = self._gather_domain.capitalize()
         data_domain_suffix = self._data_domain.capitalize()
-        return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"
+        return f"Cdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {"surveyType": "2D", "gatherType": "cdp"}

src/mdio/builder/templates/seismic_2d_prestack_shot.py renamed to src/mdio/builder/templates/seismic_2d_streamer_shot.py

@@ -1,4 +1,4 @@
-"""Seismic2DPreStackShotTemplate MDIO v1 dataset templates."""
+"""Seismic2DStreamerShotGathersTemplate MDIO v1 dataset templates."""
 
 from typing import Any
 
@@ -9,10 +9,10 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
+class Seismic2DStreamerShotGathersTemplate(AbstractDatasetTemplate):
     """Seismic Shot pre-stack 2D time or depth Dataset template."""
 
-    def __init__(self, data_domain: SeismicDataDomain):
+    def __init__(self, data_domain: SeismicDataDomain = "time"):
         super().__init__(data_domain=data_domain)
 
         self._dim_names = ("shot_point", "channel", self._data_domain)
@@ -21,7 +21,7 @@ def __init__(self, data_domain: SeismicDataDomain):
 
     @property
     def _name(self) -> str:
-        return f"PreStackShotGathers2D{self._data_domain.capitalize()}"
+        return "StreamerShotGathers2D"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {"surveyType": "2D", "ensembleType": "common_source"}

src/mdio/builder/templates/seismic_3d_prestack_cdp.py renamed to src/mdio/builder/templates/seismic_3d_cdp.py

@@ -1,4 +1,4 @@
-"""Seismic3DPreStackCDPTemplate MDIO v1 dataset templates."""
+"""Seismic3DCDPGathersTemplate MDIO v1 dataset templates."""
 
 from typing import Any
 
@@ -7,7 +7,7 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
+class Seismic3DCdpGathersTemplate(AbstractDatasetTemplate):
     """Seismic CDP pre-stack 3D gathers Dataset template."""
 
     def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
@@ -26,7 +26,7 @@ def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomai
     def _name(self) -> str:
         gather_domain_suffix = self._gather_domain.capitalize()
         data_domain_suffix = self._data_domain.capitalize()
-        return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"
+        return f"Cdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {"surveyType": "3D", "gatherType": "cdp"}

src/mdio/builder/templates/seismic_3d_prestack_coca.py renamed to src/mdio/builder/templates/seismic_3d_coca.py

@@ -1,4 +1,4 @@
-"""Seismic3DPreStackCocaTemplate MDIO v1 dataset templates."""
+"""Seismic3DCocaTemplate MDIO v1 dataset templates."""
 
 from typing import Any
 
@@ -9,7 +9,7 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
+class Seismic3DCocaGathersTemplate(AbstractDatasetTemplate):
     """Seismic CoCA (common offset, common azimuth) pre-stack 3D Dataset template."""
 
     def __init__(self, data_domain: SeismicDataDomain):
@@ -21,7 +21,7 @@ def __init__(self, data_domain: SeismicDataDomain):
 
     @property
     def _name(self) -> str:
-        return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"
+        return f"CocaGathers3D{self._data_domain.capitalize()}"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

src/mdio/builder/templates/seismic_3d_prestack_shot.py renamed to src/mdio/builder/templates/seismic_3d_streamer_shot.py

@@ -1,4 +1,4 @@
-"""Seismic3DPreStackShotTemplate MDIO v1 dataset templates."""
+"""Seismic3DStreamerShotGathersTemplate MDIO v1 dataset templates."""
 
 from typing import Any
 
@@ -9,10 +9,10 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
+class Seismic3DStreamerShotGathersTemplate(AbstractDatasetTemplate):
     """Seismic Shot pre-stack 3D time or depth Dataset template."""
 
-    def __init__(self, data_domain: SeismicDataDomain):
+    def __init__(self, data_domain: SeismicDataDomain = "time"):
         super().__init__(data_domain=data_domain)
 
         self._dim_names = ("shot_point", "cable", "channel", self._data_domain)
@@ -22,7 +22,7 @@ def __init__(self, data_domain: SeismicDataDomain):
 
     @property
     def _name(self) -> str:
-        return f"PreStackShotGathers3D{self._data_domain.capitalize()}"
+        return "StreamerShotGathers3D"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {"surveyType": "3D", "ensembleType": "common_source"}

tests/integration/test_import_streamer_grid_overrides.py

@@ -49,7 +49,7 @@ def test_import_4d_segy(  # noqa: PLR0913
 
         segy_to_mdio(
             segy_spec=segy_spec,
-            mdio_template=TemplateRegistry().get("PreStackShotGathers3DTime"),
+            mdio_template=TemplateRegistry().get("StreamerShotGathers3D"),
             input_path=segy_path,
             output_path=zarr_tmp,
             overwrite=True,
@@ -96,7 +96,7 @@ def test_import_4d_segy(  # noqa: PLR0913
 
         segy_to_mdio(
             segy_spec=segy_spec,
-            mdio_template=TemplateRegistry().get("PreStackShotGathers3DTime"),
+            mdio_template=TemplateRegistry().get("StreamerShotGathers3D"),
             input_path=segy_path,
             output_path=zarr_tmp,
             overwrite=True,
@@ -146,7 +146,7 @@ def test_import_4d_segy(  # noqa: PLR0913
         with pytest.raises(GridTraceSparsityError) as execinfo:
             segy_to_mdio(
                 segy_spec=segy_spec,
-                mdio_template=TemplateRegistry().get("PreStackShotGathers3DTime"),
+                mdio_template=TemplateRegistry().get("StreamerShotGathers3D"),
                 input_path=segy_path,
                 output_path=zarr_tmp,
                 overwrite=True,

tests/integration/test_segy_import_export_masked.py

@@ -116,7 +116,7 @@ def __iter__(self) -> Iterable[MaskedExportConfigTypes]:
 GATHER_2D_CONF = MaskedExportConfig(
     GridConfig(name="2d_gather", dims=[Dimension("cdp", 1, 40, 1), Dimension("offset", 25, 20, 25)]),
     SegyFactoryConfig(revision=1, header_byte_map={"cdp": 21, "offset": 37}, num_samples=201),
-    SegyToMdioConfig(chunks=[2, 12, 128], template="PreStackCdpOffsetGathers2DTime"),
+    SegyToMdioConfig(chunks=[2, 12, 128], template="CdpOffsetGathers2DTime"),
     SelectionMaskConfig(mask_num_dims=1, remove_frac=0.9),
 )
 
@@ -126,14 +126,14 @@ def __iter__(self) -> Iterable[MaskedExportConfigTypes]:
         dims=[Dimension("inline", 10, 8, 1), Dimension("crossline", 100, 10, 2), Dimension("offset", 25, 10, 25)],
     ),
     SegyFactoryConfig(revision=1, header_byte_map={"inline": 189, "crossline": 193, "offset": 37}, num_samples=201),
-    SegyToMdioConfig(chunks=[4, 4, 2, 128], template="PreStackCdpOffsetGathers3DTime"),
+    SegyToMdioConfig(chunks=[4, 4, 2, 128], template="CdpOffsetGathers3DTime"),
     SelectionMaskConfig(mask_num_dims=2, remove_frac=0.96),
 )
 
 STREAMER_2D_CONF = MaskedExportConfig(
     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], template="PreStackShotGathers2DTime"),
+    SegyToMdioConfig(chunks=[2, 12, 128], template="StreamerShotGathers2D"),
     SelectionMaskConfig(mask_num_dims=1, remove_frac=0.7),
 )
 
@@ -143,7 +143,7 @@ def __iter__(self) -> Iterable[MaskedExportConfigTypes]:
         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], template="PreStackShotGathers3DTime"),
+    SegyToMdioConfig(chunks=[1, 2, 12, 128], template="StreamerShotGathers3D"),
     SelectionMaskConfig(mask_num_dims=1, remove_frac=0.5),
 )
 
@@ -160,7 +160,7 @@ def __iter__(self) -> Iterable[MaskedExportConfigTypes]:
     SegyFactoryConfig(
         revision=1, header_byte_map={"inline": 189, "crossline": 193, "offset": 37, "azimuth": 232}, num_samples=201
     ),
-    SegyToMdioConfig(chunks=[4, 4, 4, 1, 128], template="PreStackCocaGathers3DTime"),
+    SegyToMdioConfig(chunks=[4, 4, 4, 1, 128], template="CocaGathers3DTime"),
     SelectionMaskConfig(mask_num_dims=2, remove_frac=0.9),
 )
 # fmt: on
@@ -301,11 +301,11 @@ def raw_headers_env(request: pytest.FixtureRequest) -> None:
     template_names = [
         "PostStack2DTime",
         "PostStack3DTime",
-        "PreStackCdpOffsetGathers2DTime",
-        "PreStackCdpOffsetGathers3DTime",
-        "PreStackShotGathers2DTime",
-        "PreStackShotGathers3DTime",
-        "PreStackCocaGathers3DTime",
+        "CdpOffsetGathers2DTime",
+        "CdpOffsetGathers3DTime",
+        "StreamerShotGathers2D",
+        "StreamerShotGathers3D",
+        "CocaGathers3DTime",
     ]
 
     for template_name in template_names:

tests/unit/v1/templates/test_seismic_2d_prestack_cdp.py renamed to tests/unit/v1/templates/test_seismic_2d_cdp.py

@@ -1,4 +1,4 @@
-"""Unit tests for Seismic2DPreStackCDPTemplate."""
+"""Unit tests for Seismic2DCdpGathersTemplate."""
 
 import pytest
 from tests.unit.v1.helpers import validate_variable
@@ -15,7 +15,7 @@
 from mdio.builder.schemas.v1.units import LengthUnitModel
 from mdio.builder.schemas.v1.units import TimeUnitEnum
 from mdio.builder.schemas.v1.units import TimeUnitModel
-from mdio.builder.templates.seismic_2d_prestack_cdp import Seismic2DPreStackCDPTemplate
+from mdio.builder.templates.seismic_2d_cdp import Seismic2DCdpGathersTemplate
 from mdio.builder.templates.types import CdpGatherDomain
 from mdio.builder.templates.types import SeismicDataDomain
 
@@ -101,12 +101,12 @@ def validate_coordinates_headers_trace_mask(
 
 @pytest.mark.parametrize("data_domain", ["depth", "time"])
 @pytest.mark.parametrize("gather_domain", ["offset", "angle"])
-class TestSeismic2DPreStackCDPTemplate:
-    """Unit tests for Seismic2DPreStackCDPTemplate."""
+class TestSeismic2DCdpGathersTemplate:
+    """Unit tests for Seismic2DCdpGathersTemplate."""
 
     def test_configuration(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain) -> None:
-        """Unit tests for Seismic2DPreStackCDPTemplate."""
-        t = Seismic2DPreStackCDPTemplate(data_domain, gather_domain)
+        """Unit tests for Seismic2DCdpGathersTemplate."""
+        t = Seismic2DCdpGathersTemplate(data_domain, gather_domain)
 
         # Template attributes for prestack CDP
         assert t._dim_names == ("cdp", gather_domain, data_domain)
@@ -128,15 +128,15 @@ def test_build_dataset(
         gather_domain: CdpGatherDomain,
         structured_headers: StructuredType,
     ) -> None:
-        """Unit tests for Seismic2DPreStackCDPDepthTemplate build."""
-        t = Seismic2DPreStackCDPTemplate(data_domain, gather_domain)
+        """Unit tests for Seismic2DCdpGathersDepthTemplate build."""
+        t = Seismic2DCdpGathersTemplate(data_domain, gather_domain)
         t.add_units({"cdp_x": UNITS_METER, "cdp_y": UNITS_METER})  # spatial domain units
         t.add_units({"offset": UNITS_METER, "angle": UNITS_DEGREE})  # gather domain units
         t.add_units({"time": UNITS_SECOND, "depth": UNITS_METER})  # data domain units
 
         gather_domain_suffix = gather_domain.capitalize()
         data_domain_suffix = data_domain.capitalize()
-        assert t.name == f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"
+        assert t.name == f"Cdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"
         dataset = t.build_dataset("North Sea 2D Prestack", sizes=(512, 36, 1536), header_dtype=structured_headers)
 
         assert dataset.metadata.name == "North Sea 2D Prestack"
@@ -164,9 +164,9 @@ def test_build_dataset(
 @pytest.mark.parametrize("gather_domain", ["Offset", "OffSeT"])
 def test_domain_case_handling(data_domain: str, gather_domain: str) -> None:
     """Test that domain parameter handles different cases correctly."""
-    template = Seismic2DPreStackCDPTemplate(data_domain, gather_domain)
+    template = Seismic2DCdpGathersTemplate(data_domain, gather_domain)
     assert template._data_domain == data_domain.lower()
 
     gather_domain_suffix = gather_domain.lower().capitalize()
     data_domain_suffix = data_domain.lower().capitalize()
-    assert template.name == f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"
+    assert template.name == f"Cdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

tests/unit/v1/templates/test_seismic_2d_prestack_shot.py renamed to tests/unit/v1/templates/test_seismic_2d_streamer_shot.py

@@ -1,6 +1,5 @@
-"""Unit tests for Seismic2DPreStackShotTemplate."""
+"""Unit tests for Seismic2DStreamerShotGathersTemplate."""
 
-import pytest
 from tests.unit.v1.helpers import validate_variable
 
 from mdio.builder.schemas.chunk_grid import RegularChunkGrid
@@ -13,7 +12,7 @@
 from mdio.builder.schemas.v1.units import LengthUnitModel
 from mdio.builder.schemas.v1.units import TimeUnitEnum
 from mdio.builder.schemas.v1.units import TimeUnitModel
-from mdio.builder.templates.seismic_2d_prestack_shot import Seismic2DPreStackShotTemplate
+from mdio.builder.templates.seismic_2d_streamer_shot import Seismic2DStreamerShotGathersTemplate
 
 UNITS_METER = LengthUnitModel(length=LengthUnitEnum.METER)
 UNITS_SECOND = TimeUnitModel(time=TimeUnitEnum.SECOND)
@@ -106,12 +105,12 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
     assert group_coord_y.metadata.units_v1 == UNITS_METER
 
 
-class TestSeismic2DPreStackShotTemplate:
-    """Unit tests for Seismic2DPreStackShotTemplate."""
+class TestSeismic2DStreamerShotGathersTemplate:
+    """Unit tests for Seismic2DStreamerShotGathersTemplate."""
 
     def test_configuration(self) -> None:
-        """Unit tests for Seismic2DPreStackShotTemplate."""
-        t = Seismic2DPreStackShotTemplate(data_domain="time")
+        """Unit tests for Seismic2DStreamerShotGathersTemplate."""
+        t = Seismic2DStreamerShotGathersTemplate(data_domain="time")
 
         # Template attributes for prestack shot
         assert t._data_domain == "time"
@@ -127,16 +126,16 @@ def test_configuration(self) -> None:
         attrs = t._load_dataset_attributes()
         assert attrs == {"surveyType": "2D", "ensembleType": "common_source"}
 
-        assert t.name == "PreStackShotGathers2DTime"
+        assert t.name == "StreamerShotGathers2D"
 
     def test_build_dataset(self, structured_headers: StructuredType) -> None:
-        """Unit tests for Seismic2DPreStackShotTemplate build in time domain."""
-        t = Seismic2DPreStackShotTemplate(data_domain="time")
+        """Unit tests for Seismic2DStreamerShotGathersTemplate build in time domain."""
+        t = Seismic2DStreamerShotGathersTemplate(data_domain="time")
         t.add_units({"source_coord_x": UNITS_METER, "source_coord_y": UNITS_METER})  # spatial domain units
         t.add_units({"group_coord_x": UNITS_METER, "group_coord_y": UNITS_METER})  # spatial domain units
         t.add_units({"time": UNITS_SECOND})  # data domain units
 
-        assert t.name == "PreStackShotGathers2DTime"
+        assert t.name == "StreamerShotGathers2D"
         dataset = t.build_dataset("North Sea 2D Shot Time", sizes=(256, 24, 2048), header_dtype=structured_headers)
 
         assert dataset.metadata.name == "North Sea 2D Shot Time"
@@ -158,11 +157,3 @@ def test_build_dataset(self, structured_headers: StructuredType) -> None:
         assert isinstance(seismic.metadata.chunk_grid, RegularChunkGrid)
         assert seismic.metadata.chunk_grid.configuration.chunk_shape == (16, 32, 2048)
         assert seismic.metadata.stats_v1 is None
-
-
-@pytest.mark.parametrize("data_domain", ["Time", "TiME"])
-def test_domain_case_handling(data_domain: str) -> None:
-    """Test that domain parameter handles different cases correctly."""
-    template = Seismic2DPreStackShotTemplate(data_domain=data_domain)
-    assert template._data_domain == data_domain.lower()
-    assert template.name.endswith(data_domain.capitalize())