Skip to content

Commit 40d961b

Browse files
committed
Improved docstring for grid_density_qc.
1 parent 95bd831 commit 40d961b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/mdio/converters/segy.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,16 @@ def grid_density_qc(grid: Grid, num_traces: int) -> None:
6161
Basic qc of the grid to check density and provide warning/exception
6262
when indexing is problematic to provide user with insights to the use.
6363
If trace density on the specified grid is less than 50% a warning is
64-
logged. If denisty is less than 1% an exception is raised.
64+
logged. If density is less than 10% an exception is raised. To ignore
65+
trace sparsity check set environment variable:
66+
MDIO_IGNORE_CHECKS = True
6567
6668
Args:
6769
grid: The grid instance to check.
6870
num_traces: Expected number of traces.
6971
7072
Raises:
71-
GridTraceCountError: When the grid is too sparse.
73+
GridTraceSparsityError: When the grid is too sparse.
7274
"""
7375
grid_traces = np.prod(grid.shape[:-1], dtype=np.uint64) # Exclude sample
7476
dims = {k: v for k, v in zip(grid.dim_names, grid.shape)} # noqa: B905

0 commit comments

Comments
 (0)