subsurface-terra 2025.1.0rc15__py3-none-any.whl → 2025.1.0rc17__py3-none-any.whl

subsurface/modules/reader/mesh/mx_reader.py

@@ -1,232 +1,232 @@
-import re
-import warnings
-from typing import Optional, TextIO
-import numpy as np
-from subsurface.core.structs import UnstructuredData
-from ._GOCAD_mesh import GOCADMesh
-
-
-def mx_to_unstruc_from_binary(stream: TextIO) -> UnstructuredData:
-    content = stream.read()
-    goCADMeshes = _parse_lines(content)
-    unstruct_data = _meshes_to_unstruct(goCADMeshes)
-    return unstruct_data
-
-
-def mx_to_unstruct_from_file(filename: str) -> UnstructuredData:
-    # Split the file into meshes
-    with open(filename, 'r') as f:
-        content: str = f.read()
-    goCAD_meshes = _parse_lines(content)
-    unstruct_data = _meshes_to_unstruct(goCAD_meshes)
-
-    return unstruct_data
-
-
-def _parse_lines(content: str) -> list[GOCADMesh]:
-    meshes = []
-    mesh_blocks = re.split(r'(?=GOCAD TSurf 1)', content)
-    # Remove any empty strings from the list
-
-    mesh_blocks = [block for block in mesh_blocks if block.strip()]
-    # Use multiprocessing Pool to parse meshes in parallel
-    # with Pool(processes=cpu_count()) as pool:
-    #     meshes = pool.map(process_mesh, mesh_blocks)
-    for mesh_block in mesh_blocks:
-        mesh_lines = mesh_block.split('\n')
-        mesh = _process_mesh(mesh_lines)
-        if mesh:
-            meshes.append(mesh)
-    return meshes
-
-
-def _meshes_to_unstruct(meshes: list[GOCADMesh]) -> UnstructuredData:
-    # ? I added this function to the Solutions class
-    n_meshes = len(meshes)
-
-    vertex_array = np.concatenate([meshes[i].vertices for i in range(n_meshes)])
-    simplex_array = np.concatenate([meshes[i].vectorized_edges for i in range(n_meshes)])
-    unc, count = np.unique(simplex_array, axis=0, return_counts=True)
-
-    # * Prepare the simplex array
-    simplex_array = meshes[0].vectorized_edges
-    adder = 0
-    for i in range(1, n_meshes):
-        adder += np.max(meshes[i - 1].vectorized_edges) + 1
-        add_mesh = meshes[i].vectorized_edges + adder
-        simplex_array = np.append(simplex_array, add_mesh, axis=0)
-
-    # * Prepare the cells_attr array
-    ids_array = np.ones(simplex_array.shape[0])
-    l0 = 0
-    id = 1
-    for mesh in meshes:
-        l1 = l0 + mesh.vectorized_edges.shape[0]
-        ids_array[l0:l1] = id
-        l0 = l1
-        id += 1
-
-    # * Create the unstructured data
-    import pandas as pd
-    unstructured_data = UnstructuredData.from_array(
-        vertex=vertex_array,
-        cells=simplex_array,
-        cells_attr=pd.DataFrame(ids_array, columns=['id'])  # TODO: We have to create an array with the shape of simplex array with the id of each simplex
-    )
-
-    return unstructured_data
-
-
-def _process_mesh(mesh_lines) -> Optional[GOCADMesh]:
-    mesh = GOCADMesh()
-    in_header = False
-    in_coord_sys = False
-    in_property_class_header = False
-    in_tface = False
-    current_property_class_header = {}
-    vertex_list = []
-    vertex_indices = []
-    triangle_list = []
-    vid_to_index = {}  # Map from vertex id to index in vertex_list
-
-    for line in mesh_lines:
-        line = line.strip()
-
-        if line.startswith('HEADER {'):
-            in_header = True
-            continue
-
-        if in_header:
-            if line == '}':
-                in_header = False
-            else:
-                key_value = line.split(':', 1)
-                if len(key_value) == 2:
-                    key, value = key_value
-                    mesh.header[key.strip()] = value.strip()
-                else:
-                    parts = line.split()
-                    if len(parts) == 2:
-                        key, value = parts
-                        mesh.header[key.strip()] = value.strip()
-                    else:
-                        mesh.header[line.strip()] = None
-            continue
-
-        if line.startswith('GOCAD_ORIGINAL_COORDINATE_SYSTEM'):
-            in_coord_sys = True
-            continue
-        if in_coord_sys:
-            if line == 'END_ORIGINAL_COORDINATE_SYSTEM':
-                in_coord_sys = False
-            else:
-                key_value = line.split(' ', 1)
-                if len(key_value) == 2:
-                    key, value = key_value
-                    mesh.coordinate_system[key.strip()] = value.strip()
-                else:
-                    mesh.coordinate_system[line.strip()] = None
-            continue
-
-        if line.startswith('PROPERTY_CLASS_HEADER'):
-            in_property_class_header = True
-            current_property_class_header = {'name': line[len('PROPERTY_CLASS_HEADER'):].strip()}
-            continue
-
-        if in_property_class_header:
-            if line == '}':
-                in_property_class_header = False
-                mesh.property_class_headers.append(current_property_class_header)
-                current_property_class_header = {}
-            else:
-                key_value = line.split(':', 1)
-                if len(key_value) == 2:
-                    key, value = key_value
-                    current_property_class_header[key.strip()] = value.strip()
-                else:
-                    key_value = line.split(' ', 1)
-                    if len(key_value) == 2:
-                        key, value = key_value
-                        current_property_class_header[key.strip()] = value.strip()
-                    else:
-                        current_property_class_header[line.strip()] = None
-            continue
-
-        if line == 'TFACE':
-            in_tface = True
-            continue
-
-        if in_tface:
-            if line.startswith('VRTX') or line.startswith('PVRTX'):
-                # Parse vertex line
-                parts = line.split()
-                if len(parts) >= 5:
-                    _, vid, x, y, z = parts[:5]
-                    vid = int(vid)
-                    x, y, z = float(x), float(y), float(z)
-                    vertex_indices.append(vid)
-                    vertex_list.append([x, y, z])
-                    vid_to_index[vid] = len(vertex_list) - 1
-                    # If PVRTX then there could be more columns with property values. For now, we are just parsing the vertex coordinates.
-                continue
-            elif line.startswith('ATOM'):
-                # Parse ATOM line
-                parts = line.split()
-                if len(parts) == 3:
-                    _, vid, ref_vid = parts
-                    vid = int(vid)
-                    ref_vid = int(ref_vid)
-                    if ref_vid in vid_to_index:
-                        ref_index = vid_to_index[ref_vid]
-                        coord = vertex_list[ref_index]
-                        vertex_indices.append(vid)
-                        vertex_list.append(coord)
-                        vid_to_index[vid] = len(vertex_list) - 1
-                    else:
-                        warnings.warn(f"Reference vertex {ref_vid} not found for ATOM {vid}")
-                continue
-            elif line.startswith('TRGL'):
-                # Parse triangle line
-                parts = line.split()
-                if len(parts) == 4:
-                    _, v1, v2, v3 = parts
-                elif len(parts) == 3:
-                    v1, v2, v3 = parts
-                else:
-                    continue
-                triangle_list.append([int(v1), int(v2), int(v3)])
-                continue
-            elif line.startswith('BSTONE'):
-                _, value = line.split()
-                mesh.bstones.append(int(value))
-                continue
-            elif line.startswith('BORDER'):
-                parts = line.split()
-                if len(parts) >= 4:
-                    _, bid, v1, v2 = parts[:4]
-                    mesh.borders.append({'id': int(bid), 'v1': int(v1), 'v2': int(v2)})
-                continue
-            elif line == 'END':
-                in_tface = False
-                continue
-            else:
-                pass
-            continue
-
-        # Other lines, possibly store as metadata
-        if line:
-            key_value = line.split(':', 1)
-            if len(key_value) == 2:
-                key, value = key_value
-                mesh.metadata[key.strip()] = value.strip()
-            else:
-                pass
-
-    # Convert lists to NumPy arrays
-    mesh.vertices = np.array(vertex_list)
-    mesh.vertex_indices = np.array(vertex_indices)
-    mesh.edges = np.array(triangle_list)
-
-    # Check the number of vertices, indices, and triangles to avoid errors (optional)
-
-    return mesh
+import re
+import warnings
+from typing import Optional, TextIO
+import numpy as np
+from subsurface.core.structs import UnstructuredData
+from ._GOCAD_mesh import GOCADMesh
+
+
+def mx_to_unstruc_from_binary(stream: TextIO) -> UnstructuredData:
+    content = stream.read()
+    goCADMeshes = _parse_lines(content)
+    unstruct_data = _meshes_to_unstruct(goCADMeshes)
+    return unstruct_data
+
+
+def mx_to_unstruct_from_file(filename: str) -> UnstructuredData:
+    # Split the file into meshes
+    with open(filename, 'r') as f:
+        content: str = f.read()
+    goCAD_meshes = _parse_lines(content)
+    unstruct_data = _meshes_to_unstruct(goCAD_meshes)
+
+    return unstruct_data
+
+
+def _parse_lines(content: str) -> list[GOCADMesh]:
+    meshes = []
+    mesh_blocks = re.split(r'(?=GOCAD TSurf 1)', content)
+    # Remove any empty strings from the list
+
+    mesh_blocks = [block for block in mesh_blocks if block.strip()]
+    # Use multiprocessing Pool to parse meshes in parallel
+    # with Pool(processes=cpu_count()) as pool:
+    #     meshes = pool.map(process_mesh, mesh_blocks)
+    for mesh_block in mesh_blocks:
+        mesh_lines = mesh_block.split('\n')
+        mesh = _process_mesh(mesh_lines)
+        if mesh:
+            meshes.append(mesh)
+    return meshes
+
+
+def _meshes_to_unstruct(meshes: list[GOCADMesh]) -> UnstructuredData:
+    # ? I added this function to the Solutions class
+    n_meshes = len(meshes)
+
+    vertex_array = np.concatenate([meshes[i].vertices for i in range(n_meshes)])
+    simplex_array = np.concatenate([meshes[i].vectorized_edges for i in range(n_meshes)])
+    unc, count = np.unique(simplex_array, axis=0, return_counts=True)
+
+    # * Prepare the simplex array
+    simplex_array = meshes[0].vectorized_edges
+    adder = 0
+    for i in range(1, n_meshes):
+        adder += np.max(meshes[i - 1].vectorized_edges) + 1
+        add_mesh = meshes[i].vectorized_edges + adder
+        simplex_array = np.append(simplex_array, add_mesh, axis=0)
+
+    # * Prepare the cells_attr array
+    ids_array = np.ones(simplex_array.shape[0])
+    l0 = 0
+    id = 1
+    for mesh in meshes:
+        l1 = l0 + mesh.vectorized_edges.shape[0]
+        ids_array[l0:l1] = id
+        l0 = l1
+        id += 1
+
+    # * Create the unstructured data
+    import pandas as pd
+    unstructured_data = UnstructuredData.from_array(
+        vertex=vertex_array,
+        cells=simplex_array,
+        cells_attr=pd.DataFrame(ids_array, columns=['id'])  # TODO: We have to create an array with the shape of simplex array with the id of each simplex
+    )
+
+    return unstructured_data
+
+
+def _process_mesh(mesh_lines) -> Optional[GOCADMesh]:
+    mesh = GOCADMesh()
+    in_header = False
+    in_coord_sys = False
+    in_property_class_header = False
+    in_tface = False
+    current_property_class_header = {}
+    vertex_list = []
+    vertex_indices = []
+    triangle_list = []
+    vid_to_index = {}  # Map from vertex id to index in vertex_list
+
+    for line in mesh_lines:
+        line = line.strip()
+
+        if line.startswith('HEADER {'):
+            in_header = True
+            continue
+
+        if in_header:
+            if line == '}':
+                in_header = False
+            else:
+                key_value = line.split(':', 1)
+                if len(key_value) == 2:
+                    key, value = key_value
+                    mesh.header[key.strip()] = value.strip()
+                else:
+                    parts = line.split()
+                    if len(parts) == 2:
+                        key, value = parts
+                        mesh.header[key.strip()] = value.strip()
+                    else:
+                        mesh.header[line.strip()] = None
+            continue
+
+        if line.startswith('GOCAD_ORIGINAL_COORDINATE_SYSTEM'):
+            in_coord_sys = True
+            continue
+        if in_coord_sys:
+            if line == 'END_ORIGINAL_COORDINATE_SYSTEM':
+                in_coord_sys = False
+            else:
+                key_value = line.split(' ', 1)
+                if len(key_value) == 2:
+                    key, value = key_value
+                    mesh.coordinate_system[key.strip()] = value.strip()
+                else:
+                    mesh.coordinate_system[line.strip()] = None
+            continue
+
+        if line.startswith('PROPERTY_CLASS_HEADER'):
+            in_property_class_header = True
+            current_property_class_header = {'name': line[len('PROPERTY_CLASS_HEADER'):].strip()}
+            continue
+
+        if in_property_class_header:
+            if line == '}':
+                in_property_class_header = False
+                mesh.property_class_headers.append(current_property_class_header)
+                current_property_class_header = {}
+            else:
+                key_value = line.split(':', 1)
+                if len(key_value) == 2:
+                    key, value = key_value
+                    current_property_class_header[key.strip()] = value.strip()
+                else:
+                    key_value = line.split(' ', 1)
+                    if len(key_value) == 2:
+                        key, value = key_value
+                        current_property_class_header[key.strip()] = value.strip()
+                    else:
+                        current_property_class_header[line.strip()] = None
+            continue
+
+        if line == 'TFACE':
+            in_tface = True
+            continue
+
+        if in_tface:
+            if line.startswith('VRTX') or line.startswith('PVRTX'):
+                # Parse vertex line
+                parts = line.split()
+                if len(parts) >= 5:
+                    _, vid, x, y, z = parts[:5]
+                    vid = int(vid)
+                    x, y, z = float(x), float(y), float(z)
+                    vertex_indices.append(vid)
+                    vertex_list.append([x, y, z])
+                    vid_to_index[vid] = len(vertex_list) - 1
+                    # If PVRTX then there could be more columns with property values. For now, we are just parsing the vertex coordinates.
+                continue
+            elif line.startswith('ATOM'):
+                # Parse ATOM line
+                parts = line.split()
+                if len(parts) == 3:
+                    _, vid, ref_vid = parts
+                    vid = int(vid)
+                    ref_vid = int(ref_vid)
+                    if ref_vid in vid_to_index:
+                        ref_index = vid_to_index[ref_vid]
+                        coord = vertex_list[ref_index]
+                        vertex_indices.append(vid)
+                        vertex_list.append(coord)
+                        vid_to_index[vid] = len(vertex_list) - 1
+                    else:
+                        warnings.warn(f"Reference vertex {ref_vid} not found for ATOM {vid}")
+                continue
+            elif line.startswith('TRGL'):
+                # Parse triangle line
+                parts = line.split()
+                if len(parts) == 4:
+                    _, v1, v2, v3 = parts
+                elif len(parts) == 3:
+                    v1, v2, v3 = parts
+                else:
+                    continue
+                triangle_list.append([int(v1), int(v2), int(v3)])
+                continue
+            elif line.startswith('BSTONE'):
+                _, value = line.split()
+                mesh.bstones.append(int(value))
+                continue
+            elif line.startswith('BORDER'):
+                parts = line.split()
+                if len(parts) >= 4:
+                    _, bid, v1, v2 = parts[:4]
+                    mesh.borders.append({'id': int(bid), 'v1': int(v1), 'v2': int(v2)})
+                continue
+            elif line == 'END':
+                in_tface = False
+                continue
+            else:
+                pass
+            continue
+
+        # Other lines, possibly store as metadata
+        if line:
+            key_value = line.split(':', 1)
+            if len(key_value) == 2:
+                key, value = key_value
+                mesh.metadata[key.strip()] = value.strip()
+            else:
+                pass
+
+    # Convert lists to NumPy arrays
+    mesh.vertices = np.array(vertex_list)
+    mesh.vertex_indices = np.array(vertex_indices)
+    mesh.edges = np.array(triangle_list)
+
+    # Check the number of vertices, indices, and triangles to avoid errors (optional)
+
+    return mesh

subsurface/modules/reader/mesh/obj_reader.py

@@ -1,53 +1,53 @@
-from typing import Union, TextIO
-import io
-
-from ._trimesh_reader import load_with_trimesh, trimesh_to_unstruct, TriMeshReaderFromBlob, TriMeshTransformations
-from ....core.structs import TriSurf
-
-
-
-def load_obj_with_trimesh_from_binary(obj_stream: TextIO, mtl_stream: list[TextIO], 
-                                      texture_stream: list[io.BytesIO], coord_system: TriMeshTransformations) -> TriSurf:
-    tri_surf: TriSurf = TriMeshReaderFromBlob.OBJ_stream_to_trisurf(
-        obj_stream=obj_stream,
-        mtl_stream=mtl_stream,
-        texture_stream=texture_stream,
-        coord_system=coord_system
-    )
-    
-    return tri_surf
-    
-
-def load_obj_with_trimesh(path_to_obj: str, plot: bool = False) -> TriSurf:
-    """
-    Load and process an OBJ file, returning trimesh-compatible objects.
-
-    This function loads an OBJ file using `trimesh`, optionally plots it,
-    and converts the loaded mesh or scene into a suitable unstructured format
-    using the `trimesh_to_unstruct` function. Depending on the input and the 
-    contents of the OBJ file, it may return a Trimesh object or a Scene object.
-
-    Note: 
-    This implementation does not include the capability to force a PNG as a 
-    texture if the material does not already have an associated image. 
-    `trimesh` ignores UVs when this condition occurs. Modifications to 
-    `trimesh`'s loading function would be necessary to address this limitation.
-
-    Args:
-        path_to_obj: Path to the OBJ file to be loaded.
-                     This must be a valid file path to a 3D object in OBJ format.
-        plot: Boolean flag indicating whether to visually plot the loaded model.
-              Defaults to False.
-
-    Returns:
-        A `trimesh.Trimesh` object if a single mesh is loaded, or a `trimesh.Scene`
-        object if the file contains multiple meshes or a scene.
-
-    Raises:
-        `FileNotFoundError`: If the provided file path does not exist.
-        `ValueError`: If the OBJ file could not be properly processed.
-
-    """
-    trimesh = load_with_trimesh(path_to_obj, file_type="obj", plot=plot)
-    trisurf = trimesh_to_unstruct(trimesh)
-    return trisurf
+from typing import Union, TextIO
+import io
+
+from ._trimesh_reader import load_with_trimesh, trimesh_to_unstruct, TriMeshReaderFromBlob, TriMeshTransformations
+from ....core.structs import TriSurf
+
+
+
+def load_obj_with_trimesh_from_binary(obj_stream: TextIO, mtl_stream: list[TextIO], 
+                                      texture_stream: list[io.BytesIO], coord_system: TriMeshTransformations) -> TriSurf:
+    tri_surf: TriSurf = TriMeshReaderFromBlob.OBJ_stream_to_trisurf(
+        obj_stream=obj_stream,
+        mtl_stream=mtl_stream,
+        texture_stream=texture_stream,
+        coord_system=coord_system
+    )
+    
+    return tri_surf
+    
+
+def load_obj_with_trimesh(path_to_obj: str, plot: bool = False) -> TriSurf:
+    """
+    Load and process an OBJ file, returning trimesh-compatible objects.
+
+    This function loads an OBJ file using `trimesh`, optionally plots it,
+    and converts the loaded mesh or scene into a suitable unstructured format
+    using the `trimesh_to_unstruct` function. Depending on the input and the 
+    contents of the OBJ file, it may return a Trimesh object or a Scene object.
+
+    Note: 
+    This implementation does not include the capability to force a PNG as a 
+    texture if the material does not already have an associated image. 
+    `trimesh` ignores UVs when this condition occurs. Modifications to 
+    `trimesh`'s loading function would be necessary to address this limitation.
+
+    Args:
+        path_to_obj: Path to the OBJ file to be loaded.
+                     This must be a valid file path to a 3D object in OBJ format.
+        plot: Boolean flag indicating whether to visually plot the loaded model.
+              Defaults to False.
+
+    Returns:
+        A `trimesh.Trimesh` object if a single mesh is loaded, or a `trimesh.Scene`
+        object if the file contains multiple meshes or a scene.
+
+    Raises:
+        `FileNotFoundError`: If the provided file path does not exist.
+        `ValueError`: If the OBJ file could not be properly processed.
+
+    """
+    trimesh = load_with_trimesh(path_to_obj, file_type="obj", plot=plot)
+    trisurf = trimesh_to_unstruct(trimesh)
+    return trisurf

subsurface/modules/reader/mesh/omf_mesh_reader.py

@@ -1,43 +1,43 @@
-import io
-
-import numpy as np
-
-import subsurface
-from ....optional_requirements import require_omf, require_pyvista
-from ....core.structs.base_structures import UnstructuredData
-
-
-def omf_stream_to_unstructs(stream: io.BytesIO) -> list[UnstructuredData]:
-    pyvista = require_pyvista()
-    omfvista = require_omf()
-    omf = omfvista.load_project(stream)
-
-    all_vertex = []
-    all_cells = []
-    cell_attr = []
-    _last_cell: int = 0
-
-    for i in range(omf.n_blocks):
-        block: pyvista.PolyData = omf[i]
-        cell_type = block.get_cell(0).type
-
-        if cell_type == pyvista.CellType.TRIANGLE:
-            pyvista_unstructured_grid: pyvista.UnstructuredGrid = block.cast_to_unstructured_grid()
-            all_vertex.append(pyvista_unstructured_grid.points)
-            cells: np.ndarray = pyvista_unstructured_grid.cells.reshape(-1, 4)[:, 1:]
-            if len(all_cells) > 0:
-                cells = cells + _last_cell
-
-            all_cells.append(cells)
-            cell_attr.append(np.ones(len(all_cells[-1])) * i)
-            _last_cell = cells.max() + 1
-
-    # * Create the unstructured data
-    import pandas as pd
-
-    unstructured_data = subsurface.UnstructuredData.from_array(
-        vertex=np.vstack(all_vertex),
-        cells=np.vstack(all_cells),
-        cells_attr=pd.DataFrame(np.hstack(cell_attr), columns=["Block id"]),
-    )
-    return [unstructured_data]
+import io
+
+import numpy as np
+
+import subsurface
+from ....optional_requirements import require_omf, require_pyvista
+from ....core.structs.base_structures import UnstructuredData
+
+
+def omf_stream_to_unstructs(stream: io.BytesIO) -> list[UnstructuredData]:
+    pyvista = require_pyvista()
+    omfvista = require_omf()
+    omf = omfvista.load_project(stream)
+
+    all_vertex = []
+    all_cells = []
+    cell_attr = []
+    _last_cell: int = 0
+
+    for i in range(omf.n_blocks):
+        block: pyvista.PolyData = omf[i]
+        cell_type = block.get_cell(0).type
+
+        if cell_type == pyvista.CellType.TRIANGLE:
+            pyvista_unstructured_grid: pyvista.UnstructuredGrid = block.cast_to_unstructured_grid()
+            all_vertex.append(pyvista_unstructured_grid.points)
+            cells: np.ndarray = pyvista_unstructured_grid.cells.reshape(-1, 4)[:, 1:]
+            if len(all_cells) > 0:
+                cells = cells + _last_cell
+
+            all_cells.append(cells)
+            cell_attr.append(np.ones(len(all_cells[-1])) * i)
+            _last_cell = cells.max() + 1
+
+    # * Create the unstructured data
+    import pandas as pd
+
+    unstructured_data = subsurface.UnstructuredData.from_array(
+        vertex=np.vstack(all_vertex),
+        cells=np.vstack(all_cells),
+        cells_attr=pd.DataFrame(np.hstack(cell_attr), columns=["Block id"]),
+    )
+    return [unstructured_data]