datastock 0.0.45__tar.gz → 0.0.47__tar.gz

{datastock-0.0.45/datastock.egg-info → datastock-0.0.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datastock
-Version: 0.0.45
+Version: 0.0.47
 Summary: A python library for generic class and data handling
 Home-page: https://github.com/ToFuProject/datastock
 Author: Didier VEZINET

{datastock-0.0.45 → datastock-0.0.47}/datastock/_class1.py

@@ -21,6 +21,7 @@ from . import _class1_domain
 from . import _class1_binning
 from . import _class1_interpolate
 from . import _class1_uniformize
+from . import _class1_color_touch as _color_touch
 from . import _export_dataframe
 from . import _find_plateau
 
@@ -923,6 +924,32 @@ class DataStock1(DataStock0):
             inplace=inplace,
         )
 
+    # ---------------------
+    # color touch array
+    # ---------------------
+
+    def get_color_touch(
+        self,
+        data=None,
+        dcolor=None,
+        # options
+        color_default=None,
+        vmin=None,
+        vmax=None,
+        log=None,
+    ):
+
+        return _color_touch.main(
+            coll=self,
+            data=data,
+            dcolor=dcolor,
+            # options
+            color_default=color_default,
+            vmin=vmin,
+            vmax=vmax,
+            log=log,
+        )
+
     # ---------------------
     # Methods computing correlations
     # ---------------------

datastock-0.0.47/datastock/_class1_color_touch.py

@@ -0,0 +1,269 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Fri Feb 28 08:53:00 2025
+
+@author: dvezinet
+"""
+
+
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib.colors as mcolors
+import datastock as ds
+
+
+# ###############################################################
+# ###############################################################
+#                  Main
+# ###############################################################
+
+
+def main(
+    coll=None,
+    data=None,
+    dcolor=None,
+    # options
+    color_default=None,
+    vmin=None,
+    vmax=None,
+    log=None,
+):
+
+    # ------------------
+    # check inputs
+    # ------------------
+
+    data, dcolor, color_default, vmin, vmax, log = _check(
+        coll=coll,
+        data=data,
+        dcolor=dcolor,
+        color_default=color_default,
+        vmin=vmin,
+        vmax=vmax,
+        log=log,
+    )
+
+    # ------------------
+    # initialize
+    # ------------------
+
+    shape = data.shape + (4,)
+    color = np.zeros(shape, dtype=float)
+
+    # ------------------
+    # compute - alpha
+    # ------------------
+
+    if log is True:
+        vmin = np.log10(vmin)
+        vmax = np.log10(vmax)
+
+        alpha = (np.log10(data) - vmin) / (vmax - vmin)
+
+    else:
+        alpha = (data - vmin) / (vmax - vmin)
+
+    # ------------------
+    # compute - colors
+    # ------------------
+
+    for k0, v0 in dcolor.items():
+
+        sli = (v0['ind'], slice(0, 3))
+        color[sli] = v0['color']
+
+        sli = tuple([slice(None) for ii in range(data.ndim)] + [-1])
+        color[sli] = alpha
+
+    # ------------------
+    # output
+    # ------------------
+
+    lcol = set([v0['color'] for v0 in dcolor.values()])
+    dcolor = {
+        'color': color,
+        'meaning': {
+            kc: [k0 for k0, v0 in dcolor.items() if v0['color'] == kc]
+            for kc in lcol
+        },
+    }
+
+    return dcolor
+
+
+# ###############################################################
+# ###############################################################
+#                  check
+# ###############################################################
+
+
+def _check(
+    coll=None,
+    data=None,
+    dcolor=None,
+    # options
+    color_default=None,
+    vmin=None,
+    vmax=None,
+    log=None,
+):
+
+    # ------------------
+    # data
+    # ------------------
+
+    lc = [
+        isinstance(data, np.ndarray),
+        isinstance(data, str) and data in coll.ddata.keys(),
+    ]
+    if lc[0]:
+        pass
+    elif lc[1]:
+        data = coll.ddata[data]['data']
+    else:
+        msg = (
+            "Arg data must be a np.ndarray or a key to an existing data!\n"
+            f"Provided: {data}\n"
+        )
+        raise Exception(msg)
+
+
+    # ------------------
+    # dcolor
+    # ------------------
+
+    # --------------------
+    # dcolor format check
+
+    c0 = (
+        isinstance(dcolor, dict)
+        and all([
+            isinstance(k0, str)
+            and isinstance(v0, dict)
+            and sorted(v0.keys()) == ['color', 'ind']
+            for k0, v0 in dcolor.items()
+        ])
+    )
+    if not c0:
+        msg = (
+            "Arg dcolor must be a dict of sub-dicts of shape:\n"
+            "\t- 'key0': {'ind': ..., 'color': ...}\n"
+            "\t-  ...\n"
+            "\t- 'keyN': {'ind': ..., 'color': ...}\n"
+            f"Provided:\n{dcolor}\n"
+        )
+        raise Exception(msg)
+
+    # --------------------
+    # ind and color checks
+
+    dfail = {}
+    shape = data.shape
+    for k0, v0 in dcolor.items():
+
+        c0 = (
+            isinstance(v0['ind'], np.ndarray)
+            and v0['ind'].shape == data.shape
+            and v0['ind'].dtype == bool
+        )
+        if not c0:
+            msg = f"'ind' must be a {shape} bool array, not {v0['ind']}"
+            dfail[k0] = (msg,)
+
+        if not mcolors.is_color_like(v0['color']):
+            msg = f"'color' must be color-like, not {v0['color']}"
+            if k0 in dfail:
+                dfail[k0] = dfail[k0] + (msg,)
+            else:
+                dfail[k0] = (msg,)
+
+    # raise exception
+    if len(dfail) > 0:
+        lmax = np.max([len(f"\t- {k0}: ") for k0 in dfail.keys()])
+        lstr = [
+            f"\t- {k0}:\n".ljust(lmax) + '\n'.join([
+                "".ljust(lmax+4) + f"\t- {v1}".rjust(lmax)
+                for ii, v1 in enumerate(v0)
+            ])
+            for k0, v0 in dfail.items()
+        ]
+        msg = (
+            "Arg dcolor, the following keys have incorrect keys / values:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
+
+    # ----------------------
+    # format colors to rgb
+
+    dcol = {}
+    for k0, v0 in dcolor.items():
+        if np.any(v0['ind']):
+            dcol[k0] = {
+                'ind': v0['ind'],
+                'color': mcolors.to_rgb(v0['color']),
+            }
+
+    # ------------------
+    # color_default
+    # ------------------
+
+    if color_default is None:
+        color_default = 'k'
+    if not mcolors.is_color_like(color_default):
+        msg = (
+            "Arg color_default must be color-like!\n"
+            f"Provided: {color_default}\n"
+        )
+        raise Exception(msg)
+
+    color_default = mcolors.to_rgb(color_default)
+
+    # ------------------
+    # vmin, vmax
+    # ------------------
+
+    vmin0 = np.nanmin(data)
+    vmax0 = np.nanmax(data)
+
+    # vmin
+    if vmin is None:
+        vmin = vmin0
+    c0 = (np.isscalar(vmin) and np.isfinite(vmin) and vmin < vmax0)
+    if not c0:
+        msg = (
+            f"Arg vmin must be a finite scalar below max ({vmax0})\n"
+            f"Provided: {vmin}\n"
+        )
+        raise Exception(msg)
+
+    # vmax
+    if vmax is None:
+        vmax = vmax0
+    c0 = (np.isscalar(vmax) and np.isfinite(vmax) and vmax > vmin0)
+    if not c0:
+        msg = (
+            f"Arg vmax must be a finite scalar above min ({vmin0})\n"
+            f"Provided: {vmax}\n"
+        )
+        raise Exception(msg)
+
+    # ordering
+    if vmin >= vmax:
+        msg = (
+            "Arg vmin must be below vmax!\n"
+            f"Provided:\n\t- vmin = {vmin}\n\t- vmax = {vmax}\n"
+        )
+        raise Exception(msg)
+
+    # ------------------
+    # log
+    # ------------------
+
+    log = ds._generic_check._check_var(
+        log, 'log',
+        types=bool,
+        default=False,
+    )
+
+    return data, dcol, color_default, vmin, vmax, log

{datastock-0.0.45 → datastock-0.0.47}/datastock/_class1_compute.py

@@ -1233,4 +1233,4 @@ def _extract_select(
             # lkey=[idq2dR],
             # return_all=True,
         # )
-    # return out
+    # return out

{datastock-0.0.45 → datastock-0.0.47}/datastock/_class1_interpolate.py

@@ -1574,7 +1574,8 @@ def _xunique(dout=None, domain=None):
     }
 
     # Number of Nones expected
-    nNone = 1 + len(domain)
+    ndom = 0 if domain is None else len(domain)
+    nNone = 1 + ndom
 
     # check
     dwrong = {k0: v0 for k0, v0 in dind.items() if len(v0) != nNone}
@@ -1583,7 +1584,7 @@ def _xunique(dout=None, domain=None):
             f"\t- {k0}: {dout[k0]['ref']} => {v0}" for k0, v0 in dwrong.items()
         ]
         msg = (
-            "Interpolate unique pt => ref should have nNone = 1 + {len(domain)}:\n"
+            "Interpolate unique pt => ref should have nNone = 1 + {ndom}:\n"
             + "\n".join(lstr)
         )
         raise Exception(msg)
@@ -1626,7 +1627,12 @@ def _store(
         ldata = list(set(itt.chain.from_iterable([
             v0['ref'] for v0 in dout.values()
         ])))
-        coll2 = coll.extract(keys=ldata, vectors=True)
+
+        coll2 = coll.extract(
+            keys=ldata,
+            inc_vectors=True,
+            return_keys=False,
+        )
 
     # -------------
     # store_keys
@@ -1644,7 +1650,13 @@ def _store(
         excluded=lout,
     )
 
-    assert len(store_keys) == len(dout)
+    if len(store_keys) != len(dout):
+        msg = (
+            "Nb of store_keys != nb of keys in dout!\n"
+            f"\t- store_keys:\n{store_keys}\n "
+            f"\t- dout.keys():\n{sorted(dout.keys())}\n "
+        )
+        raise Exception(msg)
 
     # ---------
     # add data
@@ -1658,4 +1670,4 @@ def _store(
             units=v0['units'],
         )
 
-    return coll2
+    return coll2

{datastock-0.0.45 → datastock-0.0.47}/datastock/_class2_interactivity.py

@@ -459,12 +459,18 @@ def _get_ix_for_refx_only_1or2d(
 
 
 def get_fupdate(handle=None, dtype=None, norm=None, bstr=None):
+
+    # Note: set_xdata() and set_ydata() do not accept scalar values
+    #       Deprecation warning since matplotlib 3.7
+    # see https://github.com/matplotlib/matplotlib/pull/22329
+    # see https://github.com/matplotlib/matplotlib/issues/28927
+
     if dtype == 'xdata':
         def func(val, handle=handle):
-            handle.set_xdata(val)
+            handle.set_xdata(np.atleast_1d(val))
     elif dtype == 'ydata':
         def func(val, handle=handle):
-            handle.set_ydata(val)
+            handle.set_ydata(np.atleast_1d(val))
     elif dtype in ['data']:   # Also works for imshow
         def func(val, handle=handle):
             handle.set_data(val)
@@ -588,4 +594,4 @@ def _update_mobile(k0=None, dmobile=None, dref=None, ddata=None):
                     # ddata[dmobile[k0]['data'][ii]]['data'][
                         # dmobile[k0]['func_slice'][ii](iref[ii])
                     # ]
-                # )
+                # )

{datastock-0.0.45 → datastock-0.0.47}/datastock/_generic_check.py

@@ -550,6 +550,126 @@ def _obj_key(d0=None, short=None, key=None, ndigits=None):
     )
 
 
+# #############################################################################
+# #############################################################################
+#                   Utilities for plotting
+# #############################################################################
+
+
+def _check_all_broadcastable(
+    return_full_arrays=None,
+    **kwdargs,
+):
+
+    # -------------------
+    # return_full_arrays
+    # -------------------
+
+    return_full_arrays = _check_var(
+        return_full_arrays, 'return_full_arrays',
+        types=bool,
+        default=False,
+    )
+
+    # -------------------
+    # Preliminary check
+    # -------------------
+
+    dout = {}
+    dfail = {}
+    for k0, v0 in kwdargs.items():
+        try:
+            dout[k0] = np.atleast_1d(v0)
+        except Exception:
+            dfail[k0] = f"Not convertible to np.ndarray! - {v0}"
+
+    # Raise Exception
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following kwdargs are non-conform:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # check ndim
+    # -------------------
+
+    dndim = {k0: v0.ndim for k0, v0 in dout.items() if v0.shape != (1,)}
+    lndim = list(set(dndim.values()))
+
+    if len(lndim) == 0:
+        # all scalar
+        if return_full_arrays:
+            return dout, (1,)
+        else:
+            return {k0: v0[0] for k0, v0 in dout.items()}, None
+
+    elif len(lndim) == 1:
+        ndim = lndim[0]
+
+    else:
+        lstr = [f"-t {k0}: {v0}" for k0, v0 in dndim.items()]
+        msg = (
+            "Some keyword args have non-compatible dimensions:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # check shapes
+    # -------------------
+
+    dfail = {}
+    shapef = np.ones((ndim,), dtype=int)
+    for k0, v0 in dout.items():
+
+        if v0.shape == (1,):
+            continue
+
+        for ii in range(ndim):
+            if v0.shape[ii] == 1:
+                pass
+            elif shapef[ii] == 1:
+                shapef[ii] = v0.shape[ii]
+            elif v0.shape[ii] == shapef[ii]:
+                pass
+            else:
+                dfail[k0] = f"Non-compatible shape = {v0.shape} (ii = {ii})"
+                continue
+
+    shapef = tuple(shapef)
+
+    # raise Exception if needed
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following keywords args have non-compatible shape:\n"
+            + "\n".join(lstr)
+            + f"\nReference shape: {shapef}\n"
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # reshape output
+    # -------------------
+
+    if return_full_arrays is True:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = np.full(shapef, v0[0])
+            elif v0.shape != shapef:
+                dout[k0] = np.broadcast_to(v0, shapef)
+
+    else:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = v0[0]
+
+    return dout, shapef
+
+
 # #############################################################################
 # #############################################################################
 #                   Utilities for plotting
@@ -929,4 +1049,4 @@ def _check_cmap_vminvmax(data=None, cmap=None, vmin=None, vmax=None):
         else:
             vmax = nanmax
 
-    return cmap, vmin, vmax
+    return cmap, vmin, vmax

{datastock-0.0.45 → datastock-0.0.47}/datastock/tests/test_01_DataStock.py

@@ -14,6 +14,7 @@ import numpy as np
 import matplotlib.pyplot as plt
 
 # datastock-specific
+from .._generic_check import _check_all_broadcastable
 from .._class import DataStock
 from .._saveload import load
 
@@ -228,6 +229,46 @@ class Test01_Instanciate():
     def test03_add_obj(self):
         _add_obj(st=self.st, nc=self.nc)
 
+    # ------------------------
+    #   Tools
+    # ------------------------
+
+    def test04_check_all_broadcastable(self):
+        # all scalar
+        dout, shape = _check_all_broadcastable(a=1, b=2)
+
+        # scalar + arrays
+        dout, shape = _check_all_broadcastable(a=1, b=(1, 2, 3))
+
+        # all arrays
+        dout, shape = _check_all_broadcastable(
+            a=(1, 2, 3),
+            b=(1, 2, 3),
+        )
+
+        # all arrays - 2d
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+        )
+
+        # check flag
+        err = False
+        try:
+            dout, shape = _check_all_broadcastable(a=(1, 2), b=(1, 2, 3))
+        except Exception:
+            err = True
+        assert err is True
+
+        # all arrays - mix
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+            c=3,
+            return_full_arrays=True,
+        )
+        assert all([v0.shape == (3, 2) for v0 in dout.values()])
+
 
 #######################################################
 #
@@ -306,11 +347,26 @@ class Test02_Manipulate():
         self.st.show_data()
         self.st.show_obj()
 
+    # ------------------------
+    #   dcolor
+    # ------------------------
+
+    def test06_get_dcolor_touch(self):
+        xx = np.arange(50)
+        aa = np.exp(-(xx[:, None]-25)**2/10**2 - (xx[None, :]-25)**2/10**2)
+        ind = (aa>0.3) & (np.arange(50)[None, :] > 25)
+        dcolor = self.st.get_color_touch(
+            aa,
+            dcolor={'foo': {'ind': ind, 'color': 'r'}}
+        )
+        assert dcolor['color'].shape == aa.shape + (4,)
+        assert dcolor['meaning'][(1.0, 0.0, 0.0)] == ['foo']
+
     # ------------------------
     #   Interpolate
     # ------------------------
 
-    def test06_get_ref_vector(self):
+    def test07_get_ref_vector(self):
         (
             hasref, hasvector,
             ref, key_vector,
@@ -325,13 +381,13 @@ class Test02_Manipulate():
         assert values.size == dind['ind'].size == 4
         assert dind['indr'].shape == (2, 4)
 
-    def test07_get_ref_vector_common(self):
+    def test08_get_ref_vector_common(self):
         hasref, ref, key, val, dout = self.st.get_ref_vector_common(
             keys=['t0', 'prof0', 'prof1', 't3'],
             dim='time',
         )
 
-    def test08_domain_ref(self):
+    def test09_domain_ref(self):
 
         domain = {
             'nx': [1.5, 2],
@@ -347,7 +403,7 @@ class Test02_Manipulate():
         lk = list(domain.keys())
         assert all([isinstance(dout[k0]['ind'], np.ndarray) for k0 in lk])
 
-    def test09_binning(self):
+    def test10_binning(self):
 
         bins = np.linspace(1, 5, 8)
         lk = [
@@ -399,7 +455,7 @@ class Test02_Manipulate():
                 )
                 raise Exception(msg)
 
-    def test10_interpolate(self):
+    def test11_interpolate(self):
 
         lk = ['y', 'y', 'prof0', 'prof0', 'prof0', '3d']
         lref = [None, 'nx', 't0', ['nt0', 'nx'], ['t0', 'x'], ['t0', 'x']]
@@ -443,7 +499,7 @@ class Test02_Manipulate():
                 msg = str(dout[kk]['data'].shape, shape, kk, rr)
                 raise Exception(msg)
 
-    def test11_interpolate_common_refs(self):
+    def test12_interpolate_common_refs(self):
         lk = ['3d', '3d', '3d']
         lref = ['t0', ['nt0', 'nx'], ['nx']]
         lrefc = ['nc', 'nc', 'nt0']
@@ -519,17 +575,17 @@ class Test02_Manipulate():
     #   Plotting
     # ------------------------
 
-    def test12_plot_as_array_1d(self):
+    def test13_plot_as_array_1d(self):
         dax = self.st.plot_as_array(key='t0')
         plt.close('all')
         del dax
 
-    def test13_plot_as_array_2d(self):
+    def test14_plot_as_array_2d(self):
         dax = self.st.plot_as_array(key='prof0')
         plt.close('all')
         del dax
 
-    def test14_plot_as_array_2d_log(self):
+    def test15_plot_as_array_2d_log(self):
         dax = self.st.plot_as_array(
             key='pec', keyX='ne', keyY='Te',
             dscale={'data': 'log'},
@@ -537,17 +593,17 @@ class Test02_Manipulate():
         plt.close('all')
         del dax
 
-    def test15_plot_as_array_3d(self):
+    def test16_plot_as_array_3d(self):
         dax = self.st.plot_as_array(key='3d', dvminmax={'keyX': {'min': 0}})
         plt.close('all')
         del dax
 
-    def test16_plot_as_array_3d_ZNonMonot(self):
+    def test17_plot_as_array_3d_ZNonMonot(self):
         dax = self.st.plot_as_array(key='3d', keyZ='y')
         plt.close('all')
         del dax
 
-    def test17_plot_as_array_4d(self):
+    def test18_plot_as_array_4d(self):
         dax = self.st.plot_as_array(key='4d', dscale={'keyU': 'linear'})
         plt.close('all')
         del dax
@@ -557,7 +613,7 @@ class Test02_Manipulate():
     #     plt.close('all')
     #     del dax
 
-    def test19_plot_as_profile1d(self):
+    def test20_plot_as_profile1d(self):
         dax = self.st.plot_as_profile1d(
             key='prof0',
             key_time='t0',
@@ -591,7 +647,7 @@ class Test02_Manipulate():
     #   File handling
     # ------------------------
 
-    def test21_copy_equal(self):
+    def test22_copy_equal(self):
         st2 = self.st.copy()
         assert st2 is not self.st
 
@@ -599,15 +655,15 @@ class Test02_Manipulate():
         if msg is not True:
             raise Exception(msg)
 
-    def test22_get_nbytes(self):
+    def test23_get_nbytes(self):
         nb, dnb = self.st.get_nbytes()
 
-    def test23_save_pfe(self, verb=False):
+    def test24_save_pfe(self, verb=False):
         pfe = os.path.join(_PATH_OUTPUT, 'testsave.npz')
         self.st.save(pfe=pfe, return_pfe=False)
         os.remove(pfe)
 
-    def test24_saveload(self, verb=False):
+    def test25_saveload(self, verb=False):
         pfe = self.st.save(path=_PATH_OUTPUT, verb=verb, return_pfe=True)
         st2 = load(pfe, verb=verb)
         # Just to check the loaded version works fine
@@ -616,7 +672,7 @@ class Test02_Manipulate():
             raise Exception(msg)
         os.remove(pfe)
 
-    def test25_saveload_coll(self, verb=False):
+    def test26_saveload_coll(self, verb=False):
         pfe = self.st.save(path=_PATH_OUTPUT, verb=verb, return_pfe=True)
         st = DataStock()
         st2 = load(pfe, coll=st, verb=verb)
@@ -624,4 +680,4 @@ class Test02_Manipulate():
         msg = st2.__eq__(self.st, returnas=str)
         if msg is not True:
             raise Exception(msg)
-        os.remove(pfe)
+        os.remove(pfe)

{datastock-0.0.45 → datastock-0.0.47}/datastock/version.py

@@ -1,2 +1,2 @@
 # Do not edit, pipeline versioning governed by git tags!
-__version__ = '0.0.45'
+__version__ = '0.0.47'

{datastock-0.0.45 → datastock-0.0.47/datastock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datastock
-Version: 0.0.45
+Version: 0.0.47
 Summary: A python library for generic class and data handling
 Home-page: https://github.com/ToFuProject/datastock
 Author: Didier VEZINET

{datastock-0.0.45 → datastock-0.0.47}/datastock.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ datastock/_class0.py
 datastock/_class1.py
 datastock/_class1_binning.py
 datastock/_class1_check.py
+datastock/_class1_color_touch.py
 datastock/_class1_compute.py
 datastock/_class1_domain.py
 datastock/_class1_interpolate.py