From c82c2b7be47de2fcff9906c07c76e6936cbda1bc Mon Sep 17 00:00:00 2001
From: maharshigor <gor.maharshi@gmail.com>
Date: Wed, 18 Dec 2024 16:11:17 +0530
Subject: [PATCH] RF: Lib introduced to consolidate the pygfx imports

---
 fury/__init__.pyi           |  99 ++++++-------
 fury/io.py                  | 268 ++++++++++++++++--------------------
 fury/io/__init__.py         |   3 -
 fury/io/__init__.pyi        |   3 -
 fury/io/_texture.py         |  24 ----
 fury/lib.py                 |  14 ++
 fury/window/screen.py       |   4 +-
 fury/window/show_manager.py |   2 +-
 8 files changed, 184 insertions(+), 233 deletions(-)
 delete mode 100644 fury/io/__init__.py
 delete mode 100644 fury/io/__init__.pyi
 delete mode 100644 fury/io/_texture.py
 create mode 100644 fury/lib.py

diff --git a/fury/__init__.pyi b/fury/__init__.pyi
index 73a25337d..cccc4e6d6 100644
--- a/fury/__init__.pyi
+++ b/fury/__init__.pyi
@@ -4,58 +4,59 @@
 # # to help type-checking tools like mypy and improve the development experience
 # # with better autocompletion and documentation in code editors.
 
-# __all__ = [
-#     "actor",
-#     "actors",
-#     "animation",
-#     "colormap",
-#     "convert",
-#     "data",
-#     "deprecator",
-#     "decorators",
-#     "gltf",
-#     "interactor",
-#     "io",
-#     "layout",
-#     "lib",
-#     "material",
-#     "molecular",
-#     "optpkg",
-#     "pick",
-#     "pkg_info",
-#     "primitive",
-#     "shaders",
-#     "stream",
-#     "testing",
-#     "transform",
-#     "ui",
-#     "utils",
-#     "window",
-# ]
+__all__ = [
+    #     "actor",
+    #     "actors",
+    #     "animation",
+    #     "colormap",
+    #     "convert",
+    #     "data",
+    #     "deprecator",
+    #     "decorators",
+    #     "gltf",
+    #     "interactor",
+    #     "io",
+    #     "layout",
+    "lib",
+    #     "material",
+    #     "molecular",
+    #     "optpkg",
+    #     "pick",
+    #     "pkg_info",
+    #     "primitive",
+    #     "shaders",
+    #     "stream",
+    #     "testing",
+    #     "transform",
+    #     "ui",
+    #     "utils",
+    #     "window",
+]
 
 # #  the explicit definition of `__all__` will enable type inference for engines.
 
-# from . import (
-#     actors,
-#     animation,
-#     colormap,
-#     convert,
-#     data,
-#     decorators,
-#     deprecator,
-#     gltf,
-#     interactor,
-#     io,
-#     layout,
-#     optpkg,
-#     pkg_info,
-#     primitive,
-#     shaders,
-#     stream,
-#     testing,
-#     ui,
-#     window,
-# )
+from . import (
+    #     actors,
+    #     animation,
+    #     colormap,
+    #     convert,
+    #     data,
+    #     decorators,
+    #     deprecator,
+    #     gltf,
+    #     interactor,
+    #     io,
+    #     layout,
+    #     optpkg,
+    #     pkg_info,
+    #     primitive,
+    #     shaders,
+    #     stream,
+    #     testing,
+    #     ui,
+    #     window,
+    lib,
+)
 
 # # from .actor import (
 # #     Container as Container,
diff --git a/fury/io.py b/fury/io.py
index 485ce5819..2e6567bef 100644
--- a/fury/io.py
+++ b/fury/io.py
@@ -1,40 +1,77 @@
-# import os
+import os
+
 # from tempfile import TemporaryDirectory as InTemporaryDirectory
-# from urllib.request import urlretrieve
-# import warnings
+from urllib.request import urlretrieve
 
-# from PIL import Image
-# import numpy as np
+# import warnings
+from PIL import Image
+import numpy as np
 
 # from fury.decorators import warn_on_args_to_kwargs
-# from fury.lib import (
-#     BMPReader,
-#     BMPWriter,
-#     ImageData,
-#     ImageFlip,
-#     JPEGReader,
-#     JPEGWriter,
-#     MNIObjectReader,
-#     MNIObjectWriter,
-#     OBJReader,
-#     PLYReader,
-#     PLYWriter,
-#     PNGReader,
-#     PNGWriter,
-#     PolyDataReader,
-#     PolyDataWriter,
-#     STLReader,
-#     STLWriter,
-#     TIFFReader,
-#     TIFFWriter,
-#     Texture,
-#     XMLPolyDataReader,
-#     XMLPolyDataWriter,
-#     numpy_support,
-# )
+from fury.lib import (
+    #     BMPReader,
+    #     BMPWriter,
+    #     ImageData,
+    #     ImageFlip,
+    #     JPEGReader,
+    #     JPEGWriter,
+    #     MNIObjectReader,
+    #     MNIObjectWriter,
+    #     OBJReader,
+    #     PLYReader,
+    #     PLYWriter,
+    #     PNGReader,
+    #     PNGWriter,
+    #     PolyDataReader,
+    #     PolyDataWriter,
+    #     STLReader,
+    #     STLWriter,
+    #     TIFFReader,
+    #     TIFFWriter,
+    #     Texture,
+    #     XMLPolyDataReader,
+    #     XMLPolyDataWriter,
+    #     numpy_support,
+    Texture,
+)
+
 # from fury.utils import set_input
 
 
+def load_cube_map_texture(fnames, *, size=None, generate_mipmaps=True):
+    """Load Texture
+
+    Parameters
+    ----------
+    fnames : list
+        filenames to generate cube map.
+    size : tuple, optional
+        The display extent (width, height, depth), by default None
+    generate_mipmaps : bool, optional
+        automatically generates mipmaps when transferring data to the GPU, by default
+        True
+
+    Returns
+    -------
+    Texture
+        PyGfx Texture object.
+    """
+    images = []
+
+    for fname in fnames:
+        images.append(load_image(fname))
+
+    if size is None:
+        min_side = min(*images[0].shape[:2])
+        for image in images:
+            min_side = min(*image.shape[:2])
+        size = (min_side, min_side, 6)
+
+    data = np.stack(images, axis=0)
+
+    return Texture(data, dim=2, size=size, generate_mipmaps=generate_mipmaps)
+
+
 # @warn_on_args_to_kwargs()
 # def load_cubemap_texture(fnames, *, interpolate_on=True, mipmap_on=True):
 #     """Load a cube map texture from a list of 6 images.
@@ -76,127 +113,56 @@
 #     return texture
 
 
-# @warn_on_args_to_kwargs()
-# def load_image(filename, *, as_vtktype=False, use_pillow=True):
-#     """Load an image.
-
-#     Parameters
-#     ----------
-#     filename: str
-#         should be png, bmp, jpeg or jpg files
-#     as_vtktype: bool, optional
-#         if True, return vtk output otherwise an ndarray. Default False.
-#     use_pillow: bool, optional
-#         Use pillow python library to load the files. Default True
-
-#     Returns
-#     -------
-#     image: ndarray or vtk output
-#         desired image array
-
-#     """
-#     is_url = (filename.lower().startswith("http://")) or (
-#         filename.lower().startswith("https://")
-#     )
-
-#     if is_url:
-#         image_name = os.path.basename(filename)
-
-#         if len(image_name.split(".")) < 2:
-#             raise IOError(f"{filename} is not a valid image URL")
-
-#         urlretrieve(filename, image_name)
-#         filename = image_name
-
-#     if use_pillow:
-#         with Image.open(filename) as pil_image:
-#             if pil_image.mode in ["P"]:
-#                 pil_image = pil_image.convert("RGB")
-
-#             if pil_image.mode in ["RGBA", "RGB", "L"]:
-#                 image = np.asarray(pil_image)
-#             elif pil_image.mode.startswith("I;16"):
-#                 raw = pil_image.tobytes("raw", pil_image.mode)
-#                 dtype = ">u2" if pil_image.mode.endswith("B") else "<u2"
-#                 image = np.frombuffer(raw, dtype=dtype)
-#                 image.reshape(pil_image.size[::-1]).astype("=u2")
-#             else:
-#                 try:
-#                     image = pil_image.convert("RGBA")
-#                 except ValueError as err:
-#                     raise RuntimeError(
-#                         "Unknown image mode {}".format(pil_image.mode)
-#                     ) from err
-#                 image = np.asarray(pil_image)
-
-#         if as_vtktype:
-#             if image.ndim not in [2, 3]:
-#                 raise IOError("only 2D (L, RGB, RGBA) or 3D image available")
-
-#             vtk_image = ImageData()
-#             depth = 1 if image.ndim == 2 else image.shape[2]
-
-#             # width, height
-#             vtk_image.SetDimensions(image.shape[1], image.shape[0], depth)
-#             vtk_image.SetExtent(
-#                 0,
-#                 image.shape[1] - 1,
-#                 0,
-#                 image.shape[0] - 1,
-#                 0,
-#                 0,
-#             )
-#             vtk_image.SetSpacing(1.0, 1.0, 1.0)
-#             vtk_image.SetOrigin(0.0, 0.0, 0.0)
-
-#             image = np.flipud(image)
-#             image = image.reshape(image.shape[1] * image.shape[0], depth)
-#             image = np.ascontiguousarray(image, dtype=image.dtype)
-#             vtk_array_type = numpy_support.get_vtk_array_type(image.dtype)
-#             uchar_array = numpy_support.numpy_to_vtk(
-#                 image, deep=True, array_type=vtk_array_type
-#             )
-#             vtk_image.GetPointData().SetScalars(uchar_array)
-#             image = vtk_image
-
-#         if is_url:
-#             os.remove(filename)
-#         return image
-
-#     d_reader = {
-#         ".png": PNGReader,
-#         ".bmp": BMPReader,
-#         ".jpeg": JPEGReader,
-#         ".jpg": JPEGReader,
-#         ".tiff": TIFFReader,
-#         ".tif": TIFFReader,
-#     }
-
-#     extension = os.path.splitext(os.path.basename(filename).lower())[1]
-
-#     if extension.lower() not in d_reader.keys():
-#         raise IOError(
-#             "Impossible to read the file {0}: Unknown extension {1}".format(
-#                 filename, extension
-#             )
-#         )
-
-#     reader = d_reader.get(extension)()
-#     reader.SetFileName(filename)
-#     reader.Update()
-#     reader.GetOutput().GetPointData().GetArray(0).SetName("original")
-
-#     if not as_vtktype:
-#         w, h, _ = reader.GetOutput().GetDimensions()
-#         vtk_array = reader.GetOutput().GetPointData().GetScalars()
-
-#         components = vtk_array.GetNumberOfComponents()
-#         image = numpy_support.vtk_to_numpy(vtk_array).reshape(h, w, components)
-#         image = np.flipud(image)
-
-#     if is_url:
-#         os.remove(filename)
-#     return reader.GetOutput() if as_vtktype else image
+def load_image(filename):
+    """Load an image.
+
+    Parameters
+    ----------
+    filename: str
+        should be png, bmp, jpeg or jpg files
+
+    Returns
+    -------
+    image: ndarray
+        desired image array
+
+    """
+    is_url = (filename.lower().startswith("http://")) or (
+        filename.lower().startswith("https://")
+    )
+
+    if is_url:
+        image_name = os.path.basename(filename)
+
+        if len(image_name.split(".")) < 2:
+            raise IOError(f"{filename} is not a valid image URL")
+
+        urlretrieve(filename, image_name)
+        filename = image_name
+
+    with Image.open(filename) as pil_image:
+        if pil_image.mode in ["P"]:
+            pil_image = pil_image.convert("RGB")
+
+        if pil_image.mode in ["RGBA", "RGB", "L"]:
+            image = np.asarray(pil_image)
+        elif pil_image.mode.startswith("I;16"):
+            raw = pil_image.tobytes("raw", pil_image.mode)
+            dtype = ">u2" if pil_image.mode.endswith("B") else "<u2"
+            image = np.frombuffer(raw, dtype=dtype)
+            image.reshape(pil_image.size[::-1]).astype("=u2")
+        else:
+            try:
+                image = pil_image.convert("RGBA")
+            except ValueError as err:
+                raise RuntimeError(
+                    "Unknown image mode {}".format(pil_image.mode)
+                ) from err
+            image = np.asarray(pil_image)
+
+    if is_url:
+        os.remove(filename)
+    return image
 
 
 # def load_text(file):
diff --git a/fury/io/__init__.py b/fury/io/__init__.py
deleted file mode 100644
index adfb48395..000000000
--- a/fury/io/__init__.py
+++ /dev/null
@@ -1,3 +0,0 @@
-# import lazy_loader as lazy
-
-# __getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)
diff --git a/fury/io/__init__.pyi b/fury/io/__init__.pyi
deleted file mode 100644
index fb277dc54..000000000
--- a/fury/io/__init__.pyi
+++ /dev/null
@@ -1,3 +0,0 @@
-# __all__ = [""]
-
-# from ._texture import load_cube_map_texture
diff --git a/fury/io/_texture.py b/fury/io/_texture.py
deleted file mode 100644
index 97f5e84bf..000000000
--- a/fury/io/_texture.py
+++ /dev/null
@@ -1,24 +0,0 @@
-# from numpy import stack as np_stack
-# from pygfx import Texture
-
-# from fury.decorators import warn_on_args_to_kwargs
-
-# # from fury.io import load_image
-
-
-# @warn_on_args_to_kwargs()
-# def load_cube_map_texture(fnames, *, size=None, generate_mipmaps=True):
-#     images = []
-
-#     for fname in fnames:
-#         # images.append(load_image(fname))
-
-#     if size is None:
-#         min_side = min(*images[0].shape[:2])
-#         for image in images:
-#             min_side = min(*image.shape[:2])
-#         size = (min_side, min_side, 6)
-
-#     data = np_stack(images, axis=0)
-
-#     return Texture(data, dim=2, size=size, generate_mipmaps=generate_mipmaps)
diff --git a/fury/lib.py b/fury/lib.py
new file mode 100644
index 000000000..2ccf35d11
--- /dev/null
+++ b/fury/lib.py
@@ -0,0 +1,14 @@
+import pygfx as gfx
+
+Texture = gfx.Texture
+AmbientLight = gfx.AmbientLight
+Background = gfx.Background
+BackgroundSkyboxMaterial = gfx.BackgroundSkyboxMaterial
+Camera = gfx.Camera
+Controller = gfx.Controller
+DirectionalLight = gfx.DirectionalLight
+OrbitController = gfx.OrbitController
+PerspectiveCamera = gfx.PerspectiveCamera
+GfxScene = gfx.Scene
+Viewport = gfx.Viewport
+WgpuRenderer = gfx.WgpuRenderer
diff --git a/fury/window/screen.py b/fury/window/screen.py
index e7a79c15b..77fb19aa8 100644
--- a/fury/window/screen.py
+++ b/fury/window/screen.py
@@ -1,15 +1,15 @@
 from dataclasses import dataclass
 
-from pygfx import (
+from fury.lib import (
     AmbientLight,
     Background,
     BackgroundSkyboxMaterial,
     Camera,
     Controller,
     DirectionalLight,
+    GfxScene,
     OrbitController,
     PerspectiveCamera,
-    Scene as GfxScene,
     Viewport,
 )
 
diff --git a/fury/window/show_manager.py b/fury/window/show_manager.py
index 35505bdff..2d3fe3491 100644
--- a/fury/window/show_manager.py
+++ b/fury/window/show_manager.py
@@ -2,11 +2,11 @@
 
 from PIL.Image import fromarray as image_from_array
 from numpy import asarray as np_asarray
-from pygfx import WgpuRenderer
 from wgpu.gui.auto import WgpuCanvas, run
 from wgpu.gui.jupyter import WgpuCanvas as JupyterWgpuCanvas
 from wgpu.gui.offscreen import WgpuCanvas as OffscreenWgpuCanvas
 
+from fury.lib import WgpuRenderer
 from fury.window import (
     Scene,
     calculate_screen_sizes,