Use more correct template name

Author: BrianMichell

src/mdio/builder/template_registry.py

@@ -26,8 +26,10 @@
 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_field_records import Seismic3DPreStackFieldRecordsTemplate
 from mdio.builder.templates.seismic_3d_prestack_shot import Seismic3DPreStackShotTemplate
+from mdio.builder.templates.seismic_3d_prestack_streamer_field_records import (
+    Seismic3DPreStackStreamerFieldRecordsTemplate,
+)
 
 if TYPE_CHECKING:
     from mdio.builder.templates.base import AbstractDatasetTemplate
@@ -134,7 +136,7 @@ def _register_default_templates(self) -> None:
         self.register(Seismic3DPreStackCocaTemplate("depth"))
 
         # Field (shot) data
-        self.register(Seismic3DPreStackFieldRecordsTemplate("time"))
+        self.register(Seismic3DPreStackStreamerFieldRecordsTemplate("time"))
         self.register(Seismic2DPreStackShotTemplate("time"))
         self.register(Seismic3DPreStackShotTemplate("time"))
 

src/mdio/builder/templates/seismic_3d_prestack_field_records.py renamed to src/mdio/builder/templates/seismic_3d_prestack_streamer_field_records.py

@@ -8,10 +8,12 @@
 from mdio.builder.templates.types import SeismicDataDomain
 
 
-class Seismic3DPreStackFieldRecordsTemplate(AbstractDatasetTemplate):
+class Seismic3DPreStackStreamerFieldRecordsTemplate(AbstractDatasetTemplate):
     """Seismic pre-stack time Dataset template.
 
-    This should be used for both 2D and 3D datasets. Common-shot or common-channel datasets
+    A generalized template for pre-stack field records in either 2D or 3D.
+        - Common-shot dataset
+        - Common-channel dataset
 
     Args:
         data_domain: The domain of the dataset.
@@ -31,7 +33,7 @@ def __init__(self, data_domain: SeismicDataDomain):
 
     @property
     def _name(self) -> str:
-        return f"PreStackFieldRecords3D{self._data_domain.capitalize()}"
+        return f"PreStackStreamerFieldRecords3D{self._data_domain.capitalize()}"
 
     def _load_dataset_attributes(self) -> dict[str, Any]:
         return {

tests/integration/test_import_streamer_grid_overrides.py

@@ -178,7 +178,7 @@ def test_import_6d_segy(  # noqa: PLR0913
 
         segy_to_mdio(
             segy_spec=segy_spec,
-            mdio_template=TemplateRegistry().get("PreStackFieldRecords3DTime"),
+            mdio_template=TemplateRegistry().get("PreStackStreamerFieldRecords3DTime"),
             input_path=segy_path,
             output_path=zarr_tmp,
             overwrite=True,

tests/unit/v1/templates/test_seismic_3d_prestack_field_records.py renamed to tests/unit/v1/templates/test_seismic_3d_prestack_streamer_field_records.py

@@ -13,7 +13,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_3d_prestack_field_records import Seismic3DPreStackFieldRecordsTemplate
+from mdio.builder.templates.seismic_3d_prestack_streamer_field_records import Seismic3DPreStackStreamerFieldRecordsTemplate
 
 UNITS_METER = LengthUnitModel(length=LengthUnitEnum.METER)
 UNITS_SECOND = TimeUnitModel(time=TimeUnitEnum.SECOND)
@@ -79,15 +79,15 @@ def _validate_coordinates_headers_trace_mask(dataset: Dataset, headers: Structur
         assert coord.metadata.units_v1.length == LengthUnitEnum.METER
 
 
-class TestSeismic3DPreStackFieldRecordsTemplate:
-    """Unit tests for Seismic3DPreStackFieldRecordsTemplate."""
+class TestSeismic3DPreStackStreamerFieldRecordsTemplate:
+    """Unit tests for Seismic3DPreStackStreamerFieldRecordsTemplate."""
 
     def test_configuration(self) -> None:
-        """Unit tests for Seismic3DPreStackFieldRecordsTemplate."""
-        t = Seismic3DPreStackFieldRecordsTemplate(data_domain="time")
+        """Unit tests for Seismic3DPreStackStreamerFieldRecordsTemplate."""
+        t = Seismic3DPreStackStreamerFieldRecordsTemplate(data_domain="time")
 
         # Template attributes
-        assert t.name == "PreStackFieldRecords3DTime"
+        assert t.name == "PreStackStreamerFieldRecords3DTime"
         assert t._dim_names == ("shot_line", "gun", "shot_point", "cable", "channel", "time")
         assert t._physical_coord_names == ("source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
         # TODO(Anyone): Disable chunking in time domain when support is merged.
@@ -104,17 +104,17 @@ def test_configuration(self) -> None:
         assert t.default_variable_name == "amplitude"
 
     def test_build_dataset(self, structured_headers: StructuredType) -> None:
-        """Unit tests for Seismic3DPreStackFieldRecordsTemplate build."""
-        t = Seismic3DPreStackFieldRecordsTemplate(data_domain="time")
+        """Unit tests for Seismic3DPreStackStreamerFieldRecordsTemplate build."""
+        t = Seismic3DPreStackStreamerFieldRecordsTemplate(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
 
         dataset = t.build_dataset(
-            "North Sea 3D Field Records", sizes=(1, 3, 256, 512, 24, 2048), header_dtype=structured_headers
+            "North Sea 3D Streamer Field Records", sizes=(1, 3, 256, 512, 24, 2048), header_dtype=structured_headers
         )
 
-        assert dataset.metadata.name == "North Sea 3D Field Records"
+        assert dataset.metadata.name == "North Sea 3D Streamer Field Records"
         assert dataset.metadata.attributes["surveyDimensionality"] == "3D"
         assert dataset.metadata.attributes["ensembleType"] == "shot_point"
         assert dataset.metadata.attributes["processingStage"] == "pre-stack"
@@ -139,6 +139,6 @@ def test_build_dataset(self, structured_headers: StructuredType) -> 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 = Seismic3DPreStackFieldRecordsTemplate(data_domain=data_domain)
+    template = Seismic3DPreStackStreamerFieldRecordsTemplate(data_domain=data_domain)
     assert template._data_domain == data_domain.lower()
     assert template.name.endswith(data_domain.capitalize())

tests/unit/v1/templates/test_template_registry.py

@@ -31,7 +31,7 @@
     "PreStackCdpAngleGathers3DDepth",
     "PreStackCocaGathers3DTime",
     "PreStackCocaGathers3DDepth",
-    "PreStackFieldRecords3DTime",
+    "PreStackStreamerFieldRecords3DTime",
     "PreStackShotGathers2DTime",
     "PreStackShotGathers3DTime",
 ]