arrlp 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

arrlp/modules/compress_LP/compress.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-11-30
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : arrLP
+# Module        : compress
+
+"""
+Compresses an array between values by normalizing, with possibility to saturate extrema.
+"""
+
+
+
+# %% Libraries
+import numpy as np
+
+
+
+# %% Function
+def compress(array, /, max=1, min=0, *, dtype=None, white=None, black=None, white_percent=None, black_percent=None, saturate=None) :
+    '''
+    Compresses an array between values by normalizing, with possibility to saturate extrema.
+    
+    Parameters
+    ----------
+    array : np.ndarray
+        Array to normalize.
+    max : int or float or None
+        white value in output. None for no changing of white
+    min : int or float or None
+        black value in output. None for no changing of black
+    dtype : np.dtype or str or None
+        dtype of output, None for same as input
+    white : int or float or None
+        white value in input. None for maximum
+    black : int or float or None
+        black value in input. None for minimum
+    white_percent : int or None
+        white percentage distribution in input if white is None.
+    black_percent : int or None
+        black percentage distribution in input if black is None.
+    saturate : Any or bool or None
+        If True, will saturate values above white and black. If Any, will replace by this value. If None no saturation.
+
+    Returns
+    -------
+    array : np.ndarray
+        Normalized and saturated copy of array.
+
+    Examples
+    --------
+    >>> from arrlp import compress
+    >>> array = np.arange(100, dtype=np.float32)
+    ...
+    >>> compress(array, 10, 5) # compresses array between 10 and 5
+    >>> compress(array, white=50, black=40) # compresses array linearly so that 50 value is at 1 and 40 is at 0
+    >>> compress(array, white=50, black=40, saturate=np.nan) # compresses array linearly so that 50 value is at 1 and 40 is at 0, replace outside values by np.nan
+    >>> compress(array, white_percent=10, black=1) # compresses array linearly so that 10% of array will be white, and 1% black (without saturation)
+    >>> compress(array, white_percent=10, black=1, saturate=True) # compresses array linearly so that 10% of array will be white, and 1% black (with saturation)
+    '''
+
+    # init
+    array = np.asarray(array)
+    if dtype is None :
+        dtype = array.dtype
+
+    # Get white/black
+    if white is None :
+        white = np.nanmax(array) if white_percent is None else np.nanpercentile(array, 100-white_percent)
+    if black is None :
+        black = np.nanmin(array) if black_percent is None else np.nanpercentile(array, black_percent)
+    if white >= black :
+        raise ValueError('white >= black is not possible while compressing')
+
+    # Normalization
+    if max is not None and min is not None and min >= max :
+        raise ValueError('min >= max is not possible while compressing')
+    if max is not None :
+        array = normalization(array, value=max, norm=white, fix=black)
+        white = max
+    if min is not None :
+        array = normalization(array, value=min, norm=black, fix=white)
+        black = min
+    if max is None and min is None :
+        array = np.copy(array)
+
+    # Saturation
+    if saturate is not None :
+        if saturate is True :
+            sat_min, sat_max = min, max
+        else :
+            sat_min, sat_max = saturate, saturate
+        array[array>max] = sat_max
+        array[array<min] = sat_min
+    
+    return array.astype(dtype)
+
+
+
+def normalization(array, /, value:float=None, norm:float=None, fix:float=None):
+    '''Basic normalization process of array copy while keeping a fixed point'''
+
+    if fix is None : fix = 0
+    if norm is None : norm = max(np.nanmax(array),-np.nanmin(array))
+    if value is None : value = 1*np.sign(norm)
+    return (array-fix)/(norm-fix)*(value-fix) + fix
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

arrlp/modules/{matplotlib_LP/test_matplotlib.py → compress_LP/test_compress.py}

@@ -1,15 +1,15 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-# Date          : 2025-08-30
+# Date          : 2025-11-30
 # Author        : Lancelot PINCET
 # GitHub        : https://github.com/LancelotPincet
 # Library       : arrLP
-# Module        : matplotlib
+# Module        : compress
 
 """
-This file allows to test matplotlib
+This file allows to test compress
 
-matplotlib : 
+compress : Compresses an array between values by normalizing, with possibility to saturate extrema.
 """
 
 
@@ -17,7 +17,7 @@ matplotlib :
 # %% Libraries
 from corelp import print, debug
 import pytest
-from arrlp import matplotlib
+from arrlp import compress
 debug_folder = debug(__file__)
 
 
@@ -25,7 +25,7 @@ debug_folder = debug(__file__)
 # %% Function test
 def test_function() :
     '''
-    Test matplotlib function
+    Test compress function
     '''
     print('Hello world!')
 
@@ -37,7 +37,7 @@ def instance() :
     '''
     Create a new instance at each test function
     '''
-    return matplotlib()
+    return compress()
 
 def test_instance(instance) :
     '''
@@ -53,9 +53,9 @@ def test_instance(instance) :
 ])
 def test_returns(args, kwargs, expected, message) :
     '''
-    Test matplotlib return values
+    Test compress return values
     '''
-    assert matplotlib(*args, **kwargs) == expected, message
+    assert compress(*args, **kwargs) == expected, message
 
 
 
@@ -66,10 +66,10 @@ def test_returns(args, kwargs, expected, message) :
 ])
 def test_errors(args, kwargs, error, error_message) :
     '''
-    Test matplotlib error values
+    Test compress error values
     '''
     with pytest.raises(error, match=error_message) :
-        matplotlib(*args, **kwargs)
+        compress(*args, **kwargs)
 
 
 

arrlp/modules/convolve_LP/convolve.py

@@ -49,7 +49,7 @@ def convolve(arr, k=None, /, out=None, **kwargs) :
     >>> from arrlp import correlate
     ...
     >>> convolve(img, sigma=5) # Gaussian convolve
-    >>> convolve(img, windowma=10) # Mask convolve
+    >>> convolve(img, window=10) # Mask convolve
     >>> convolve(img, wl=640, NA=1.5) # Airy convolve
     '''
 

arrlp/modules.json

@@ -1,4 +1,10 @@
 {
+    "compress": {
+        "date": "2025-11-30",
+        "description": "Compresses an array between values by normalizing, with possibility to saturate extrema.",
+        "module": "modules/compress_LP/compress",
+        "object": "compress"
+    },
     "convolve": {
         "date": "2025-08-30",
         "description": "This function convolves two numpy arrays (1D, 2D, 3D).",
@@ -23,12 +29,6 @@
         "module": "modules/kernel_LP/kernel",
         "object": "kernel"
     },
-    "matplotlib": {
-        "date": "2025-08-30",
-        "description": "",
-        "module": "modules/matplotlib_LP/matplotlib",
-        "object": "matplotlib"
-    },
     "relabel": {
         "date": "2025-08-31",
         "description": "This function redefines a label array to fill potential holes inside.",

{arrlp-0.1.3.dist-info → arrlp-0.1.4.dist-info}/METADATA

@@ -1,16 +1,18 @@
 Metadata-Version: 2.3
 Name: arrlp
-Version: 0.1.3
+Version: 0.1.4
 Summary: A library providing custom functions for arrays.
-Author: LancelotPincet
-Author-email: LancelotPincet <40608570+LancelotPincet@users.noreply.github.com>
 Requires-Dist: astropy
 Requires-Dist: corelp
+Requires-Dist: ipykernel
+Requires-Dist: numba
 Requires-Dist: numpy
 Requires-Dist: pytest
 Requires-Dist: scipy
 Requires-Dist: sphinx
+Requires-Dist: sphinx-design
 Requires-Dist: sphinx-rtd-theme
+Requires-Dist: spyder-kernels
 Requires-Dist: toml
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
@@ -35,8 +37,13 @@ For more information, do not hesitate to consult the [Documentation](https://arr
 
 ## MIT License
 
+<details>
+<summary>details</summary>
+
 Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
 
 The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
 
-The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+
+</details>

{arrlp-0.1.3.dist-info → arrlp-0.1.4.dist-info}/RECORD

@@ -1,7 +1,10 @@
 arrlp/__init__.py,sha256=EOH7t03_YW3YBcmw4MetXAWQzP8TJcJm-tYxhGIg7Sk,436
 arrlp/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arrlp/modules/compress_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arrlp/modules/compress_LP/compress.py,sha256=NGTqGjz-ZTtYy2M9XW-kimwGAeML4E1r58Urz06jgis,4011
+arrlp/modules/compress_LP/test_compress.py,sha256=V6YwrWhNN8-89XsHwL4IPCDq4JsR3BZe7z5JzEjmnSY,1529
 arrlp/modules/convolve_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arrlp/modules/convolve_LP/convolve.py,sha256=B4_Z1SlCnW1ZEVtEhoyEpGjGSOKguWINN4ZwRsZs86k,1487
+arrlp/modules/convolve_LP/convolve.py,sha256=p8G8emqSipj7wD_rc9aV6lAJ5JW9kVehCxa5y0cYW4M,1485
 arrlp/modules/convolve_LP/test_convolve.py,sha256=hws1boa0xXvFLIOSKdwvgAXMU9vDcSnkZm44xS5nCP0,1198
 arrlp/modules/coordinates_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arrlp/modules/coordinates_LP/coordinates.py,sha256=SFxtD2iBYQjX1Eg1KBymB5Dcn2d6g7_3_XFkXcRmY04,3519
@@ -12,16 +15,13 @@ arrlp/modules/correlate_LP/test_correlate.py,sha256=KrVm2ncdxXs_yH0CFpP4t9Vlwwc6
 arrlp/modules/kernel_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arrlp/modules/kernel_LP/kernel.py,sha256=qhO6dOHu2WrfzTJznlsndupxh2Y52rO_KZ3DrsW-YbE,4887
 arrlp/modules/kernel_LP/test_kernel.py,sha256=n8Jt9aebOcwPPNUFYCKLpxwivgduCgSy67uRGDCsgu8,1058
-arrlp/modules/matplotlib_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arrlp/modules/matplotlib_LP/matplotlib.py,sha256=8ZssvGW8vjsfy39cWIt2bl0le7b08JeytdJrUl29YMQ,1956
-arrlp/modules/matplotlib_LP/test_matplotlib.py,sha256=-aSV5h4NuhyvV-Oj9pHJvuDIdaEBwQqyXOOeLExlVq4,1461
 arrlp/modules/relabel_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arrlp/modules/relabel_LP/relabel.py,sha256=w3iNR4iyQQfaqjDIH6URX62lUllyQBxOYzLCDkDxJsg,1405
 arrlp/modules/relabel_LP/test_relabel.py,sha256=pue00n5MVP4sog8bZFqgtu7GYf_2JtevrwHzJIIZFqk,667
-arrlp/modules.json,sha256=1IwYEGXL7ei671nVNpyr4IiryEaLYt11LJiP23UY1bU,1313
+arrlp/modules.json,sha256=ZKh2T--LLx4IuihvINbUezLGDtOG6cf64nFX6dSkIaw,1393
 arrlp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arrlp/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arrlp/scripts.json,sha256=RBNvo1WzZ4oRRq0W9-hknpT7T8If536DEMBg9hyq_4o,2
-arrlp-0.1.3.dist-info/WHEEL,sha256=NHRAbdxxzyL9K3IO2LjmlNqKSyPZnKv2BD16YYVKo18,79
-arrlp-0.1.3.dist-info/METADATA,sha256=17SLdoTsVXqPSIP5-r6c98BEW9wM_PLvI8DsC7qfJRE,1854
-arrlp-0.1.3.dist-info/RECORD,,
+arrlp-0.1.4.dist-info/WHEEL,sha256=Pi5uDq5Fdo_Rr-HD5h9BiPn9Et29Y9Sh8NhcJNnFU1c,79
+arrlp-0.1.4.dist-info/METADATA,sha256=AfRWXV_HMVvGVHiC65gcWGDS0b6mNWuRM5ifnBvRSos,1907
+arrlp-0.1.4.dist-info/RECORD,,

{arrlp-0.1.3.dist-info → arrlp-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.8.14
+Generator: uv 0.8.17
 Root-Is-Purelib: true
 Tag: py3-none-any

arrlp/modules/matplotlib_LP/matplotlib.py

@@ -1,137 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-08-30
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : arrLP
-# Module        : matplotlib
-
-"""
-
-"""
-
-
-
-# %% Libraries
-from arrlp import *
-
-
-
-# %% Function
-def matplotlib(**kwargs) :
-    '''
-    
-    
-    Parameters
-    ----------
-    a : int or float
-        TODO.
-
-    Returns
-    -------
-    b : int or float
-        TODO.
-
-    Raises
-    ------
-    TypeError
-        TODO.
-
-    Examples
-    --------
-    >>> from arrlp import matplotlib
-    ...
-    >>> matplotlib() # TODO
-    '''
-
-    return None
-
-
-
-# %% Libraries
-from corelp import prop
-from arrlp import *
-from dataclasses import dataclass, field
-
-
-
-# %% Class
-@dataclass(slots=True, kw_only=True)
-class matplotlib() :
-    '''
-    
-    
-    Parameters
-    ----------
-    a : int or float
-        TODO.
-
-    Attributes
-    ----------
-    _attr : int or float
-        TODO.
-
-    Examples
-    --------
-    >>> from arrlp import matplotlib
-    ...
-    >>> instance = matplotlib(TODO)
-    '''
-
-    # Attributes
-    # myattr : str = ""
-    # mylist : list[str] = field(default_factory=list)
-    # _mycal : str = field(init=False, repr=False) 
-    name : str = None
-
-
-
-    # Init
-    def __post_init__(self) :
-        pass
-
-
-
-    # Properties
-    @prop(cache=True)
-    def myprop(self) :
-        return ""
-    @myprop.setter()
-    def mypropr(self, value) :
-        self._myprop = value
-
-
-
-    # Methods
-    def method(self) :
-        '''
-        TODO
-    
-        Parameters
-        ----------
-        a : int or float
-            TODO.
-
-        Returns
-        -------
-        b : int or float
-            TODO.
-
-        Raises
-        ------
-        TypeError
-            TODO.
-
-        Examples
-        --------
-        >>> self.method() # TODO
-        '''
-
-        return None
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
-    test(__file__)