First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tasansal merged 10 commits into from
Sep 7, 2025
Merged

First pass review and alignment of templates #643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
adc0e4d
rename things to be more sensible and add angle gathers configuration…
tasansal Sep 7, 2025
b4d7dda
align shot data template with prod
tasansal Sep 7, 2025
05927b5
fix tests for 3d pre-stack shot
tasansal Sep 7, 2025
47173f5
remove deleted attribute (processingStage)
tasansal Sep 7, 2025
a6e5d60
rename gatherType for coca
tasansal Sep 7, 2025
2af63f0
lint and fix 1 bug
tasansal Sep 7, 2025
70dadad
rename gather -> ensemble or raw field data
tasansal Sep 7, 2025
510a58f
add missing 2d shot
tasansal Sep 7, 2025
cd5f6b5
fix docstrings
tasansal Sep 7, 2025
2a871f4
fix wrong validation namings
tasansal Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/mdio/builder/template_registry.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
self.register(Seismic3DPostStackTemplate("depth"))

# CDP/CMP Ordered Data
self.register(Seismic2DPreStackCDPTemplate("time"))
self.register(Seismic2DPreStackCDPTemplate("depth"))
self.register(Seismic3DPreStackCDPTemplate("time"))
self.register(Seismic3DPreStackCDPTemplate("depth"))
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(Seismic3DPreStackCocaTemplate("time"))
self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down
12 changes: 9 additions & 3 deletions src/mdio/builder/templates/abstract_dataset_template.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
to override specific steps.
"""

def __init__(self, domain: str = "") -> None:
self._trace_domain = domain.lower()
def __init__(self, data_domain: SeismicDataDomain) -> None:
self._data_domain = data_domain.lower()

if self._data_domain not in ["depth", "time"]:
msg = "domain must be 'depth' or 'time'"
raise ValueError(msg)

self._coord_dim_names = ()
self._dim_names = ()
self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
@property
def trace_domain(self) -> str:
"""Returns the name of the trace domain."""
return self._trace_domain
return self._data_domain

@property
def dimension_names(self) -> tuple[str, ...]:
Expand Down
11 changes: 6 additions & 5 deletions src/mdio/builder/templates/seismic_2d_poststack.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
"""Seismic post-stack 2D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain):
super().__init__(data_domain=data_domain)

self._coord_dim_names = ("cdp",)
self._dim_names = (*self._coord_dim_names, self._trace_domain)
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("cdp_x", "cdp_y")
self._var_chunk_shape = (1024, 1024)

@property
def _name(self) -> str:
return f"PostStack2D{self._trace_domain.capitalize()}"
return f"PostStack2D{self._data_domain.capitalize()}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
return {"surveyType": "2D", "gatherType": "stacked"}
23 changes: 16 additions & 7 deletions src/mdio/builder/templates/seismic_2d_prestack_cdp.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
"""Seismic CDP pre-stack 2D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
super().__init__(data_domain=data_domain)
self._gather_domain = gather_domain.lower()

self._coord_dim_names = ("cdp", "offset")
self._dim_names = (*self._coord_dim_names, self._trace_domain)
if self._gather_domain not in ["offset", "angle"]:
msg = "gather_type must be 'offset' or 'angle'"
raise ValueError(msg)

self._coord_dim_names = ("cdp", self._gather_domain)
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("cdp_x", "cdp_y")
self._var_chunk_shape = (1, 512, 4096)
self._var_chunk_shape = (16, 64, 1024)

@property
def _name(self) -> str:
return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
gather_domain_suffix = self._gather_domain.capitalize()
data_domain_suffix = self._data_domain.capitalize()
return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
return {"surveyType": "2D", "gatherType": "cdp"}
21 changes: 11 additions & 10 deletions src/mdio/builder/templates/seismic_2d_prestack_shot.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
"""Seismic Shot pre-stack 2D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain):
super().__init__(data_domain=data_domain)

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_dim_names = ("shot_point", "channel")
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
self._var_chunk_shape = (1, 512, 4096)
self._var_chunk_shape = (16, 64, 1024)

@property
def _name(self) -> str:
return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
return {"surveyType": "2D", "ensembleType": "common_source"}

def _add_coordinates(self) -> None:
# Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
self._builder.add_coordinate(
"gun",
dimensions=("shot_point", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.UINT8,
)
self._builder.add_coordinate(
"source_coord_x",
dimensions=("shot_point", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.FLOAT64,
metadata=coordinate_metadata,
)
self._builder.add_coordinate(
"source_coord_y",
dimensions=("shot_point", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.FLOAT64,
metadata=coordinate_metadata,
)
Expand Down
14 changes: 8 additions & 6 deletions src/mdio/builder/templates/seismic_3d_poststack.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
"""Seismic post-stack 3D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
# Template attributes to be overridden by subclasses
def __init__(self, data_domain: SeismicDataDomain):
super().__init__(data_domain=data_domain)

self._coord_dim_names = ("inline", "crossline")
self._dim_names = (*self._coord_dim_names, self._trace_domain)
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("cdp_x", "cdp_y")
self._var_chunk_shape = (128, 128, 128)

@property
def _name(self) -> str:
return f"PostStack3D{self._trace_domain.capitalize()}"
domain_suffix = self._data_domain.capitalize()
return f"PostStack3D{domain_suffix}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
return {"surveyType": "3D", "gatherType": "stacked"}
25 changes: 17 additions & 8 deletions src/mdio/builder/templates/seismic_3d_prestack_cdp.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
"""Seismic CDP pre-stack 3D time or depth Dataset template."""
"""Seismic CDP pre-stack 3D gathers Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
super().__init__(data_domain=data_domain)
self._gather_domain = gather_domain.lower()

self._coord_dim_names = ("inline", "crossline", "offset")
self._dim_names = (*self._coord_dim_names, self._trace_domain)
if self._gather_domain not in ["offset", "angle"]:
msg = "gather_type must be 'offset' or 'angle'"
raise ValueError(msg)

self._coord_dim_names = ("inline", "crossline", self._gather_domain)
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("cdp_x", "cdp_y")
self._var_chunk_shape = (1, 1, 512, 4096)
self._var_chunk_shape = (8, 8, 32, 512)

@property
def _name(self) -> str:
return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
gather_domain_suffix = self._gather_domain.capitalize()
data_domain_suffix = self._data_domain.capitalize()
return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
return {"surveyType": "3D", "gatherType": "cdp"}
11 changes: 6 additions & 5 deletions src/mdio/builder/templates/seismic_3d_prestack_coca.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
"""Seismic Shot pre-stack 3D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain):
super().__init__(data_domain=data_domain)

self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
self._dim_names = (*self._coord_dim_names, self._trace_domain)
self._dim_names = (*self._coord_dim_names, self._data_domain)
self._coord_names = ("cdp_x", "cdp_y")
self._var_chunk_shape = (8, 8, 32, 1, 1024)

@property
def _name(self) -> str:
return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

def _add_coordinates(self) -> None:
# Add dimension coordinates
Expand Down
21 changes: 11 additions & 10 deletions src/mdio/builder/templates/seismic_3d_prestack_shot.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
"""Seismic Shot pre-stack 3D time or depth Dataset template."""

def __init__(self, domain: str):
super().__init__(domain=domain)
def __init__(self, data_domain: SeismicDataDomain):
super().__init__(data_domain=data_domain)

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_dim_names = ("shot_point", "cable", "channel")
self._dim_names = (*self._coord_dim_names, self._data_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)
self._var_chunk_shape = (8, 2, 128, 1024)

@property
def _name(self) -> str:
return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

def _load_dataset_attributes(self) -> dict[str, Any]:
return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
return {"surveyType": "3D", "ensembleType": "common_source"}

def _add_coordinates(self) -> None:
# Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
# Add non-dimension coordinates
self._builder.add_coordinate(
"gun",
dimensions=("shot_point", "cable", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.UINT8,
)
self._builder.add_coordinate(
"source_coord_x",
dimensions=("shot_point", "cable", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.FLOAT64,
metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
)
self._builder.add_coordinate(
"source_coord_y",
dimensions=("shot_point", "cable", "channel"),
dimensions=("shot_point",),
data_type=ScalarType.FLOAT64,
metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
)
Expand Down
8 changes: 8 additions & 0 deletions src/mdio/builder/templates/types.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]
7 changes: 3 additions & 4 deletions tests/integration/test_segy_import_export.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

attributes = ds.attrs["attributes"]
assert attributes is not None
assert len(attributes) == 6
assert len(attributes) == 5
# Validate all attributes provided by the abstract template
assert attributes["defaultVariableName"] == "amplitude"
assert attributes["surveyDimensionality"] == "3D"
assert attributes["ensembleType"] == "line"
assert attributes["processingStage"] == "post-stack"
assert attributes["surveyType"] == "3D"
assert attributes["gatherType"] == "stacked"
assert attributes["textHeader"] == text_header_teapot_dome()
assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down
4 changes: 2 additions & 2 deletions tests/integration/test_segy_import_export_masked.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
case "3d_stack":
template_name = "PostStack3D" + domain
case "2d_gather":
template_name = "PreStackCdpGathers2D" + domain
template_name = "PreStackCdpOffsetGathers2D" + domain
case "3d_gather":
template_name = "PreStackCdpGathers3D" + domain
template_name = "PreStackCdpOffsetGathers3D" + domain
case "2d_streamer":
template_name = "PreStackShotGathers2D" + domain
case "3d_streamer":
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
First pass review and alignment of templates#643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tasansal
merged 10 commits into

from

Sep 7, 2025
 Merged


First pass review and alignment of templates
#643
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
adc0e4d

rename things to be more sensible and add angle gathers configuration…


tasansal Sep 7, 2025
b4d7dda

align shot data template with prod


tasansal Sep 7, 2025
05927b5

fix tests for 3d pre-stack shot


tasansal Sep 7, 2025
47173f5

remove deleted attribute (processingStage)


tasansal Sep 7, 2025
a6e5d60

rename gatherType for coca


tasansal Sep 7, 2025
2af63f0

lint and fix 1 bug


tasansal Sep 7, 2025
70dadad

rename gather -> ensemble or raw field data


tasansal Sep 7, 2025
510a58f

add missing 2d shot


tasansal Sep 7, 2025
cd5f6b5

fix docstrings


tasansal Sep 7, 2025
2a871f4

fix wrong validation namings


tasansal Sep 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
src/mdio/builder/template_registry.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,10 +76,11 @@ def _register_default_templates(self) -> None:
 self.register(Seismic3DPostStackTemplate("depth"))

 # CDP/CMP Ordered Data
 self.register(Seismic2DPreStackCDPTemplate("time"))
 self.register(Seismic2DPreStackCDPTemplate("depth"))
 self.register(Seismic3DPreStackCDPTemplate("time"))
 self.register(Seismic3DPreStackCDPTemplate("depth"))
 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(Seismic3DPreStackCocaTemplate("time"))
 self.register(Seismic3DPreStackCocaTemplate("depth"))

Expand Down

12 changes: 9 additions & 3 deletions
src/mdio/builder/templates/abstract_dataset_template.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
from mdio.builder.schemas.v1.units import LengthUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.schemas.v1.variable import VariableMetadata
from mdio.builder.templates.types import SeismicDataDomain


class AbstractDatasetTemplate(ABC):
Expand All@@ -24,8 +25,13 @@ class AbstractDatasetTemplate(ABC):
 to override specific steps.
 """

 def __init__(self, domain: str = "") -> None:
 self._trace_domain = domain.lower()
 def __init__(self, data_domain: SeismicDataDomain) -> None:
 self._data_domain = data_domain.lower()

 if self._data_domain not in ["depth", "time"]:
 msg = "domain must be 'depth' or 'time'"
 raise ValueError(msg)

 self._coord_dim_names = ()
 self._dim_names = ()
 self._coord_names = ()
Expand DownExpand Up@@ -80,7 +86,7 @@ def default_variable_name(self) -> str:
 @property
 def trace_domain(self) -> str:
 """Returns the name of the trace domain."""
 return self._trace_domain
 return self._data_domain

 @property
 def dimension_names(self) -> tuple[str, ...]:
Expand Down

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_2d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,23 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("cdp",)
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1024, 1024)

 @property
 def _name(self) -> str:
 return f"PostStack2D{self._trace_domain.capitalize()}"
 return f"PostStack2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "2D", "gatherType": "stacked"}

23 changes: 16 additions & 7 deletions
src/mdio/builder/templates/seismic_2d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic2DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("cdp", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("cdp", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers2D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers2D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "gatherType": "cdp"}

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_2d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic2DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 2D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("gun", "source_coord_x", "source_coord_y", "group_coord_x", "group_coord_y")
 self._var_chunk_shape = (1, 512, 4096)
 self._var_chunk_shape = (16, 64, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers2D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers2D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "2D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "2D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -34,18 +35,18 @@ def _add_coordinates(self) -> None:
 coordinate_metadata = CoordinateMetadata(units_v1=self._horizontal_coord_unit)
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=coordinate_metadata,
 )
Expand Down

14 changes: 8 additions & 6 deletions
src/mdio/builder/templates/seismic_3d_poststack.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,24 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPostStackTemplate(AbstractDatasetTemplate):
 """Seismic post-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 # Template attributes to be overridden by subclasses
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (128, 128, 128)

 @property
 def _name(self) -> str:
 return f"PostStack3D{self._trace_domain.capitalize()}"
 domain_suffix = self._data_domain.capitalize()
 return f"PostStack3D{domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "line", "processingStage": "post-stack"}
 return {"surveyType": "3D", "gatherType": "stacked"}

25 changes: 17 additions & 8 deletions
src/mdio/builder/templates/seismic_3d_prestack_cdp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,22 +3,31 @@
from typing import Any

from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain
from mdio.builder.templates.types import CdpGatherDomain


class Seismic3DPreStackCDPTemplate(AbstractDatasetTemplate):
 """Seismic CDP pre-stack 3D time or depth Dataset template."""
 """Seismic CDP pre-stack 3D gathers Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain, gather_domain: CdpGatherDomain):
 super().__init__(data_domain=data_domain)
 self._gather_domain = gather_domain.lower()

 self._coord_dim_names = ("inline", "crossline", "offset")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 if self._gather_domain not in ["offset", "angle"]:
 msg = "gather_type must be 'offset' or 'angle'"
 raise ValueError(msg)

 self._coord_dim_names = ("inline", "crossline", self._gather_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (1, 1, 512, 4096)
 self._var_chunk_shape = (8, 8, 32, 512)

 @property
 def _name(self) -> str:
 return f"PreStackCdpGathers3D{self._trace_domain.capitalize()}"
 gather_domain_suffix = self._gather_domain.capitalize()
 data_domain_suffix = self._data_domain.capitalize()
 return f"PreStackCdp{gather_domain_suffix}Gathers3D{data_domain_suffix}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "cdp"}

11 changes: 6 additions & 5 deletions
src/mdio/builder/templates/seismic_3d_prestack_coca.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,25 +6,26 @@
from mdio.builder.schemas.v1.units import AngleUnitModel
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackCocaTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 self._coord_dim_names = ("inline", "crossline", "offset", "azimuth")
 self._dim_names = (*self._coord_dim_names, self._trace_domain)
 self._dim_names = (*self._coord_dim_names, self._data_domain)
 self._coord_names = ("cdp_x", "cdp_y")
 self._var_chunk_shape = (8, 8, 32, 1, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackCocaGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackCocaGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "cdp_coca", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "gatherType": "common_offset_common_azimuth"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand Down

21 changes: 11 additions & 10 deletions
src/mdio/builder/templates/seismic_3d_prestack_shot.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,25 +5,26 @@
from mdio.builder.schemas.dtype import ScalarType
from mdio.builder.schemas.v1.variable import CoordinateMetadata
from mdio.builder.templates.abstract_dataset_template import AbstractDatasetTemplate
from mdio.builder.templates.abstract_dataset_template import SeismicDataDomain


class Seismic3DPreStackShotTemplate(AbstractDatasetTemplate):
 """Seismic Shot pre-stack 3D time or depth Dataset template."""

 def __init__(self, domain: str):
 super().__init__(domain=domain)
 def __init__(self, data_domain: SeismicDataDomain):
 super().__init__(data_domain=data_domain)

 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_dim_names = ("shot_point", "cable", "channel")
 self._dim_names = (*self._coord_dim_names, self._data_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)
 self._var_chunk_shape = (8, 2, 128, 1024)

 @property
 def _name(self) -> str:
 return f"PreStackShotGathers3D{self._trace_domain.capitalize()}"
 return f"PreStackShotGathers3D{self._data_domain.capitalize()}"

 def _load_dataset_attributes(self) -> dict[str, Any]:
 return {"surveyDimensionality": "3D", "ensembleType": "shot_point", "processingStage": "pre-stack"}
 return {"surveyType": "3D", "ensembleType": "common_source"}

 def _add_coordinates(self) -> None:
 # Add dimension coordinates
Expand All@@ -33,18 +34,18 @@ def _add_coordinates(self) -> None:
 # Add non-dimension coordinates
 self._builder.add_coordinate(
 "gun",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.UINT8,
 )
 self._builder.add_coordinate(
 "source_coord_x",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
 self._builder.add_coordinate(
 "source_coord_y",
 dimensions=("shot_point", "cable", "channel"),
 dimensions=("shot_point",),
 data_type=ScalarType.FLOAT64,
 metadata=CoordinateMetadata(units_v1=self._horizontal_coord_unit),
 )
Expand Down

8 changes: 8 additions & 0 deletions
src/mdio/builder/templates/types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
"""Module that contains type aliases for templates."""

from typing import Literal
from typing import TypeAlias

SeismicDataDomain: TypeAlias = Literal["depth", "time"]

CdpGatherDomain: TypeAlias = Literal["offset", "angle"]

7 changes: 3 additions & 4 deletions
tests/integration/test_segy_import_export.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,12 +255,11 @@ def test_dataset_metadata(self, zarr_tmp: Path) -> None:

 attributes = ds.attrs["attributes"]
 assert attributes is not None
 assert len(attributes) == 6
 assert len(attributes) == 5
 # Validate all attributes provided by the abstract template
 assert attributes["defaultVariableName"] == "amplitude"
 assert attributes["surveyDimensionality"] == "3D"
 assert attributes["ensembleType"] == "line"
 assert attributes["processingStage"] == "post-stack"
 assert attributes["surveyType"] == "3D"
 assert attributes["gatherType"] == "stacked"
 assert attributes["textHeader"] == text_header_teapot_dome()
 assert attributes["binaryHeader"] == binary_header_teapot_dome()

Expand Down

4 changes: 2 additions & 2 deletions
tests/integration/test_segy_import_export_masked.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,9 +280,9 @@ def test_import(self, test_conf: MaskedExportConfig, export_masked_path: Path) -
 case "3d_stack":
 template_name = "PostStack3D" + domain
 case "2d_gather":
 template_name = "PreStackCdpGathers2D" + domain
 template_name = "PreStackCdpOffsetGathers2D" + domain
 case "3d_gather":
 template_name = "PreStackCdpGathers3D" + domain
 template_name = "PreStackCdpOffsetGathers3D" + domain
 case "2d_streamer":
 template_name = "PreStackShotGathers2D" + domain
 case "3d_streamer":
Expand Down
Loading
Loading