xtgeo 4.14.1__cp313-cp313-win_amd64.whl

xtgeo/grid3d/_gridprop_roxapi.py

@@ -0,0 +1,301 @@
+# coding: utf-8
+"""Roxar API functions for XTGeo Grid Property."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Literal
+from warnings import warn
+
+import numpy as np
+from numpy import ma
+
+from xtgeo.common import null_logger
+from xtgeo.common.constants import UNDEF, UNDEF_INT, UNDEF_INT_LIMIT, UNDEF_LIMIT
+from xtgeo.roxutils import RoxUtils
+from xtgeo.roxutils._roxar_loader import roxar
+
+if TYPE_CHECKING:
+    from xtgeo.grid3d.grid_property import GridProperty
+
+    if roxar is not None:
+        from roxar import Project as RoxarProjectType
+        from roxar.grids import Grid3D as RoxarGrid3DType
+
+logger = null_logger(__name__)
+
+VALID_ROXAR_DTYPES = [np.uint8, np.uint16, np.float32]
+
+
+def import_prop_roxapi(
+    project: RoxarProjectType,
+    gname: str,
+    pname: str,
+    realisation: int,
+    faciescodes: bool,
+) -> dict[str, Any]:
+    """Import a Property via ROXAR API spec."""
+    logger.info("Opening RMS project ...")
+
+    rox = RoxUtils(project, readonly=True)
+
+    result = _get_gridprop_data(rox, gname, pname, realisation, faciescodes)
+
+    rox.safe_close()
+    return result
+
+
+def _get_gridprop_data(
+    rox: RoxUtils, gname: str, pname: str, realisation: int, faciescodes: bool
+) -> dict[str, Any]:
+    # inside a RMS project
+
+    if gname not in rox.project.grid_models:
+        raise ValueError(f"No gridmodel with name {gname}")
+    if pname not in rox.project.grid_models[gname].properties:
+        raise ValueError(f"No property in {gname} with name {pname}")
+
+    try:
+        return _convert_to_xtgeo_prop(rox, gname, pname, realisation, faciescodes)
+    except KeyError as keyerror:
+        raise RuntimeError(keyerror) from keyerror
+
+
+def _convert_to_xtgeo_prop(
+    rox: RoxUtils, gname: str, pname: str, realisation: int, faciescodes: bool
+) -> dict[str, Any]:
+    result: dict[str, Any] = {}
+    roxgrid = rox.project.grid_models[gname]
+    roxprop = roxgrid.properties[pname]
+
+    discrete = str(roxprop.type) in ("discrete", "body_facies")
+    result["discrete"] = discrete
+
+    result["roxorigin"] = True
+    indexer = roxgrid.get_grid(realisation=realisation).grid_indexer
+    result["ncol"], result["nrow"], result["nlay"] = indexer.dimensions
+
+    logger.info(indexer.ijk_handedness)
+
+    pvalues = roxprop.get_values(realisation=realisation)
+
+    if str(roxprop.type) == "body_facies" and faciescodes:
+        fmap = roxprop.get_facies_map(realisation=realisation)
+        pvalues = fmap[pvalues]  # numpy magics
+
+    result["roxar_dtype"] = pvalues.dtype
+
+    mybuffer: np.ndarray = np.ndarray(
+        indexer.dimensions, dtype=np.int32 if discrete else np.float64
+    )
+    mybuffer.fill(UNDEF_INT if discrete else UNDEF)
+
+    cellno = indexer.get_cell_numbers_in_range((0, 0, 0), indexer.dimensions)
+
+    ijk = indexer.get_indices(cellno)
+
+    iind = ijk[:, 0]
+    jind = ijk[:, 1]
+    kind = ijk[:, 2]
+
+    mybuffer[iind, jind, kind] = pvalues[cellno]
+
+    mybuffer = ma.masked_greater(mybuffer, UNDEF_INT_LIMIT if discrete else UNDEF_LIMIT)
+
+    result["values"] = mybuffer
+    result["name"] = pname
+
+    if discrete:
+        result["codes"] = _fix_codes(
+            result["values"].reshape(-1).compressed(), roxprop.code_names
+        )
+        logger.info("Fixed codes: %s", result["codes"])
+    return result
+
+
+def export_prop_roxapi(
+    self: GridProperty,
+    project: RoxarProjectType,
+    gname: str,
+    pname: str,
+    realisation: int = 0,
+    casting: Literal["no", "equiv", "safe", "same_kind", "unsafe"] | None = "unsafe",
+) -> None:
+    """Export (i.e. store or save) to a Property icon in RMS via ROXAR API spec."""
+    rox = RoxUtils(project, readonly=False)
+
+    try:
+        roxgrid = rox.project.grid_models[gname]
+        _store_in_roxar(self, pname, roxgrid, realisation, casting)
+
+    except KeyError as keyerror:
+        raise RuntimeError(keyerror)
+
+    if rox._roxexternal:
+        rox.project.save()
+
+    rox.safe_close()
+
+
+def _validate_dtype_in_roxar(
+    pval: np.ndarray, original_dtype: Any, dtype: Any, allow_unsafe_casting: bool = True
+) -> None:
+    """Local routine that check the range in xtgeo's parameter vs Roxar dtype"""
+    message = ""
+
+    if dtype != original_dtype:
+        message += (
+            f"Existing RMS icon has data type {original_dtype} while "
+            f"GridProperty has RMS data type {dtype}. This may cause issues in data "
+            "content while saving to RMS."
+        )
+
+    try:
+        # for mypy
+        min_val: int | float
+        max_val: int | float
+
+        if np.issubdtype(dtype, np.integer):
+            # Integer type
+            min_val = int(np.iinfo(dtype).min)
+            max_val = int(np.iinfo(dtype).max)
+        elif np.issubdtype(dtype, np.floating):
+            # Float type
+            min_val = float(np.finfo(dtype).min)
+            max_val = float(np.finfo(dtype).max)
+        else:
+            # Unknown type
+            raise RuntimeError("Probable bug, values array not integer or float")
+
+        if pval.min() < min_val or pval.max() > max_val:
+            message += (
+                f"Values outside {dtype} range [{min_val}, {max_val}] found. "
+                f"Range in xtgeo values are [{pval.min()}, {pval.max()}]"
+            )
+
+    except (ValueError, OverflowError):
+        # Handle edge cases gracefully
+        message += f"Could not validate range for dtype {dtype}. "
+
+    if message and allow_unsafe_casting:
+        message += (
+            "\nUnsafe casting is allowed; this means that original values may "
+            "be truncated which may give unpredictable results and/or mess "
+            "up code names and values settings."
+        )
+
+    if message:
+        warn(message, UserWarning)
+
+
+def _store_in_roxar(
+    self: GridProperty,
+    pname: str,
+    roxgrid: RoxarGrid3DType,
+    realisation: int,
+    casting: Literal["no", "equiv", "safe", "same_kind", "unsafe"] | None,
+) -> None:
+    """Store property in RMS."""
+    indexer = roxgrid.get_grid(realisation=realisation).grid_indexer
+
+    logger.info("Store in RMS...")
+
+    roxtype: Any = roxar  # needed for mypy
+    roxar_property_type = (
+        roxtype.GridPropertyType.discrete
+        if self.isdiscrete
+        else roxtype.GridPropertyType.continuous
+    )
+
+    val3d = self.values.copy()
+
+    dtype = self._roxar_dtype
+    logger.info("DTYPE is %s for %s", dtype, pname)
+
+    if dtype not in VALID_ROXAR_DTYPES:
+        raise TypeError(
+            f"Roxar dtype is not valid: {dtype} must be in {VALID_ROXAR_DTYPES}"
+        )
+
+    properties = roxgrid.properties
+    original_dtype = dtype
+    if pname not in properties:
+        rprop = properties.create(
+            pname, property_type=roxar_property_type, data_type=dtype
+        )
+    else:
+        rprop = properties[pname]
+        original_dtype = rprop.data_type
+
+    _validate_dtype_in_roxar(val3d, original_dtype, dtype, casting == "unsafe")
+
+    dtype = original_dtype
+    val3d = val3d.astype(dtype, casting=casting)
+
+    cellno = indexer.get_cell_numbers_in_range((0, 0, 0), indexer.dimensions)
+
+    ijk = indexer.get_indices(cellno)
+
+    iind = ijk[:, 0]
+    jind = ijk[:, 1]
+    kind = ijk[:, 2]
+
+    pvalues = roxgrid.get_grid(realisation=realisation).generate_values(data_type=dtype)
+
+    pvalues[cellno] = val3d[iind, jind, kind]
+    rprop.set_values(pvalues, realisation=realisation)
+
+    if self.isdiscrete and "float" not in str(original_dtype):
+        try:
+            rprop.code_names = _rox_compatible_codes(self.codes)
+        except ValueError as verr:
+            message = (
+                f"Trying to set codes in Roxar: {self.codes} for type "
+                f"{self._roxar_dtype}. {str(verr)} Consider editing the codes!"
+            )
+            raise ValueError(message)
+
+
+def _fix_codes(
+    active_values: np.ndarray, codes: dict[str | int, str]
+) -> dict[int, str]:
+    """Roxar may provide a code list with empty strings values, fix this issue here.
+
+    Roxar may also interpolate code values which are actually not present in the
+    property. Here, the presence of actual codes is also checked.
+    """
+    newcodes = {}
+    codes_data = {val: str(val) for val in np.unique(active_values)}
+
+    for code, name in codes.items():
+        if not isinstance(code, int):
+            code = int(code)
+
+        if not name:
+            name = str(code)
+
+        if code not in codes_data:
+            continue
+
+        newcodes[code] = name
+
+    return newcodes
+
+
+def _rox_compatible_codes(codes: dict) -> dict:
+    """Ensure that keys in codes are int's prior to storage in RMS."""
+
+    newcodes = {}
+    for code, name in codes.items():
+        if code is None:
+            continue  # skip codes of type None; assumed to be spurious
+        if not isinstance(code, int):
+            try:
+                code = int(code)
+            except ValueError:
+                raise ValueError(
+                    "The keys in codes must be an integer prior to RMS "
+                    f"storage. Actual key found here is '{code}' of type {type(code)}"
+                )
+
+        newcodes[code] = name
+    return newcodes

xtgeo/grid3d/_gridprop_value_init.py

@@ -0,0 +1,140 @@
+"""GridProperty (not GridProperies) some etc functions"""
+
+from __future__ import annotations
+
+import numbers
+from typing import TYPE_CHECKING
+
+import numpy as np
+
+import xtgeo
+from xtgeo.common import null_logger
+
+logger = null_logger(__name__)
+
+if TYPE_CHECKING:
+    from xtgeo.grid3d import Grid, GridProperty
+
+
+def gridproperty_non_dummy_values(
+    gridlike: Grid | GridProperty | None,
+    dimensions: tuple[int, int, int],
+    values: np.ndarray | float | int | None,
+    isdiscrete: bool,
+) -> np.ma.MaskedArray:
+    """
+    Gives the initial values array of an gridprop.
+
+    Args:
+        gridlike: Either Grid or GridProperty, giving the mask to replicate.
+        dimensions: The (ncol, nrow, nlay) dimensions of the grid property.
+        values: The values parameter given to init.
+        isdiscrete: The discrete parameter given to init.
+
+    Returns:
+        The array to be set to GridProperty._values.
+
+    """
+    if values is None:
+        _values = initial_gridprop_values_zero(dimensions, isdiscrete)
+    elif isinstance(values, numbers.Number):
+        _values = initial_gridprop_values_from_scalar(dimensions, values, isdiscrete)
+    elif isinstance(values, np.ndarray):
+        _values = initial_gridprop_values_from_array(dimensions, values, isdiscrete)
+    else:
+        raise ValueError(
+            f"Cannot create GridProperty with values type '{type(values).__name__}.' "
+            "Expected an nd.array, float, int, or None"
+        )
+
+    if gridlike:
+        if isinstance(gridlike, xtgeo.grid3d.Grid):
+            act = gridlike.get_actnum(asmasked=True)
+            _values = np.ma.array(_values, mask=np.ma.getmaskarray(act.values))
+        else:
+            assert isinstance(gridlike, xtgeo.grid3d.GridProperty)
+            _values = np.ma.array(_values, mask=np.ma.getmaskarray(gridlike.values))
+
+    return _values
+
+
+def gridproperty_dummy_values(isdiscrete: bool) -> np.ma.MaskedArray:
+    """
+    Given no parameters to init, these dummy values should be set for backwards
+    compatability.
+
+    Args:
+        isdiscrete: If the grid property values are discrete.
+
+    Returns:
+        The array to be set to GridProperty._values.
+
+    """
+    values: np.ma.MaskedArray = np.ma.MaskedArray(
+        np.full((4, 3, 5), 99.0), dtype=np.int32 if isdiscrete else np.float64
+    )
+    values[0:4, 0, 0:2] = np.ma.masked
+    return values
+
+
+def initial_gridprop_values_zero(
+    dimensions: tuple[int, int, int], isdiscrete: bool
+) -> np.ma.MaskedArray:
+    """
+    Initial values for an GridProperty with zeros.
+
+    Given that the user supplies at least some parameters, but not a values array,
+    values should be initialized to zero.
+
+    Args:
+        dimensions: The (ncol, nrow, nlay) dimensions of the grid property.
+
+    Returns:
+        Zero initialized values array.
+
+    """
+    return np.ma.zeros(dimensions, dtype=np.int32 if isdiscrete else np.float64)
+
+
+def initial_gridprop_values_from_scalar(
+    dimensions: tuple[int, int, int], value: float | int, isdiscrete: bool
+) -> np.ma.MaskedArray:
+    """
+    Initial grid property values from scalar.
+
+    Given scalar values, the gridproperties value array should be
+    filled with that value, with possible conversion depending
+    on the isdiscrete parameter.
+
+    Args:
+        dimensions: The (ncol, nrow, nlay) dimensions of the grid property.
+        value: The scalar value to initialize with.
+        isdiscrete: If the values are discrete.
+
+    Returns:
+        Filled array with given scalar value.
+
+    """
+    if not isinstance(value, numbers.Number):
+        raise ValueError("Scalar input values of invalid type")
+    return np.ma.zeros(dimensions, dtype=np.int32 if isdiscrete else np.float64) + value
+
+
+def initial_gridprop_values_from_array(
+    dimensions: tuple[int, int, int], values: np.ndarray, isdiscrete: bool
+) -> np.ma.MaskedArray:
+    """
+    Initial GridProperty values from numpy array.
+
+    Args:
+        dimensions: The (ncol, nrow, nlay) dimensions of the grid property.
+        value: The numpy array to initialize with.
+        isdiscrete: If the values are discrete.
+
+    Returns:
+        GridProperty with values initialized from a numpy array.
+
+    """
+    return np.ma.MaskedArray(
+        values.reshape(dimensions), dtype=np.int32 if isdiscrete else np.float64
+    )