plotlp 0.1.9__tar.gz → 0.1.11__tar.gz

{plotlp-0.1.9 → plotlp-0.1.11}/PKG-INFO

@@ -1,12 +1,15 @@
 Metadata-Version: 2.3
 Name: plotlp
-Version: 0.1.9
+Version: 0.1.11
 Summary: A library wrapper around matplotlib for custom plots.
 Requires-Dist: corelp
 Requires-Dist: cycler
+Requires-Dist: imageio
+Requires-Dist: imageio-ffmpeg
 Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: pillow
+Requires-Dist: tifffile
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 

{plotlp-0.1.9 → plotlp-0.1.11}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "plotlp"
-version = "0.1.9"
+version = "0.1.11"
 description = "A library wrapper around matplotlib for custom plots."
 readme = "README.md"
 requires-python = ">=3.12"
-dependencies = [ "corelp", "cycler", "matplotlib", "numpy", "pillow",]
+dependencies = [ "corelp", "cycler", "imageio", "imageio-ffmpeg", "matplotlib", "numpy", "pillow", "tifffile",]
 
 [build-system]
 requires = [ "uv_build",]

{plotlp-0.1.9 → plotlp-0.1.11}/src/plotlp/__init__.py

@@ -19,6 +19,7 @@ sources = {
 'color': 'plotlp.modules.color_LP.color',
 'figure': 'plotlp.modules.figure_LP.figure',
 'imgfigure': 'plotlp.modules.imgfigure_LP.imgfigure',
+'make_animation': 'plotlp.modules.make_animation_LP.make_animation',
 'plt': 'plotlp.modules.plt_LP.plt',
 'style': 'plotlp.modules.style_LP.style',
 'subplots': 'plotlp.modules.subplots_LP.subplots'

plotlp-0.1.11/src/plotlp/modules/make_animation_LP/make_animation.py

@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-02-08
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+# Module        : make_animation
+
+"""
+This module allows to create animations from plots
+"""
+
+
+
+# %% Libraries
+from corelp import Path
+from matplotlib import pyplot as plt
+import imageio
+import io
+import numpy as np
+import tifffile as tiff
+
+
+
+# %% Function
+def make_animation(export_path:str, name=None, fps:float=24., loop:bool=True, pingpong:bool=False, extension:str='.gif', iterator=range, *, extension2animate='.png', array2animate=None, tif2animate=None, key2animate=None, function2animate=None, parameter2animate=None, value2animate=None, dpi:int=300, **kwargs) :
+    '''
+    This module allows to create animations from plots, chose from animating images from a folder or through live generation with a function
+    
+    Parameters
+    ----------
+    export_path : str or pathlib.Path
+        Path where to save animation.
+    name : str
+        name of animation file.
+    fps : float
+        Animation Frames Per Second.
+    loop : bool
+        True to loop animation.
+    pingpong : bool
+        True to make animation back and forth.
+    extension2animate : str
+        Extension of animated function in folder.
+    array2animate : function
+        Array to animate.
+    tif2animate : function
+        Array to tif2animate.
+    key2animate : function
+        Keys of tif to animate.
+    function2animate : function
+        Function to animate.
+    parameter2animate : str
+        Name of parameter to animate.
+    **kwargs : dict
+        Other fixed parameter for function, the animated parameter will be ignored.
+
+    Examples
+    --------
+    >>> from plotlp import make_animation
+    ...
+    >>> make_animation(saving_path, "myanimation", function2animate=myplottingfunction, parameter2animate=""myparameter", value2animate=np.linspace(mini,maxi,1000), **kwargs) # from function
+    >>> make_animation(saving_path, "myanimation", extension2animate='.tif') # from folder
+    '''
+
+    # Path
+    export_path = Path(export_path)
+    if name is not None : export_path = export_path / name
+    export_path = export_path.with_suffix(extension)
+    fps = float(fps)
+
+    # Animation modalities
+    if function2animate is not None :
+        function_animation(export_path, fps, loop, pingpong, function2animate, parameter2animate, value2animate, dpi, iterator, **kwargs)
+    elif array2animate is not None :
+        array_animation(export_path, fps, loop, pingpong, array2animate, iterator)
+    elif tif2animate is not None :
+        tif_animation(export_path, fps, loop, pingpong, tif2animate, key2animate, iterator)
+    else :
+        folder_animation(export_path, fps, loop, pingpong, extension2animate, iterator)
+
+
+
+def folder_animation(export_path, fps, loop, pingpong, extension2animate, iterator) :
+    folder_path = export_path.with_suffix('')
+
+    # List and naturally sort all PNG files
+    image_files = [img for img in folder_path.iterdir() if img.suffix == extension2animate]
+    if not image_files:
+        raise ValueError("No PNG images found in the folder.")
+    image_files.sort()
+    if pingpong:
+        image_files = image_files + image_files[-2:0:-1]
+
+    # Stream images one at a time and save to GIF
+    with get_writer(export_path, fps, loop) as writer :
+        for file in iterator(image_files):
+            frame = imageio.imread(file)
+            writer.append_data(frame)
+
+
+
+def array_animation(export_path, fps, loop, pingpong, array2animate, iterator) :
+    array2animate = np.asarray(array2animate)
+    if pingpong:
+        array2animate = np.concatenate(
+            (array2animate, array2animate[-2:0:-1]),
+            axis=0
+        )
+    
+    # Write frames directly
+    with get_writer(export_path, fps, loop) as writer:
+        for frame in iterator(array2animate):
+            frame = np.clip(frame / frame.max() * 255, 0, 255).astype(np.uint8)
+            writer.append_data(frame)
+
+
+
+def tif_animation(export_path, fps, loop, pingpong, tif2animate, key2animate, iterator) :
+    tif2animate = (export_path.parent / tif2animate).with_suffix('.tif')
+    if key2animate is None :
+        with tiff.TiffFile(tif2animate) as tif:
+            num_pages = len(tif.pages)
+        key2animate = np.arange(num_pages)
+    if pingpong:
+        key2animate = np.concatenate(
+            (key2animate, key2animate[-2:0:-1]),
+            axis=0
+        )
+    
+    # Write frames directly
+    with get_writer(export_path, fps, loop) as writer:
+        for i in iterator(key2animate):
+            frame = tiff.imread(tif2animate, key=i)
+            frame = np.clip(frame / frame.max() * 255, 0, 255).astype(np.uint8)
+            writer.append_data(frame)
+
+
+
+def function_animation(export_path, fps, loop, pingpong, function2animate, parameter2animate, value2animate, dpi, iterator, **kwargs) :
+
+    # List of parameter
+    if parameter2animate is None:
+        raise ValueError("parameter2animate must be provided when function2animate is used")
+    if pingpong:
+        value2animate = np.hstack((value2animate, value2animate[-2:0:-1]))
+
+    # Stream images one at a time and save to GIF
+    with get_writer(export_path, fps, loop) as writer :
+        for value in iterator(value2animate):
+            kwargs[parameter2animate] = value
+            fig = function2animate(**kwargs)
+            fig.set_dpi(dpi)
+            buf = io.BytesIO()
+            fig.savefig(buf, format="png", dpi=dpi)
+            buf.seek(0)
+            frame = imageio.imread(buf)
+            writer.append_data(frame)
+            plt.close(fig)
+
+
+
+def get_writer(export_path, fps, loop) :
+    match export_path.suffix :
+        case '.mp4' :
+           return imageio.get_writer(export_path, fps=fps, codec='libx264', quality=8, format='ffmpeg')
+        case '.gif' :
+            return imageio.get_writer(export_path, mode='I', fps=fps, loop=0 if loop else 1)
+        case _ :
+            raise SyntaxError(f'Animation extension not recognized: -->{export_path.suffix}<--')
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

plotlp-0.1.11/src/plotlp/modules/make_animation_LP/test_make_animation.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-02-08
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : template_[library]
+# Module        : make_animation
+
+"""
+This file allows to test make_animation
+
+make_animation : This module allows to create animations from plots
+"""
+
+
+
+# %% Libraries
+from corelp import print, debug
+import pytest
+from template_[lowerlib] import make_animation
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test make_animation function
+    '''
+    print('Hello world!')
+
+
+
+# %% Instance fixture
+@pytest.fixture()
+def instance() :
+    '''
+    Create a new instance at each test function
+    '''
+    return make_animation()
+
+def test_instance(instance) :
+    '''
+    Test on fixture
+    '''
+    pass
+
+
+# %% Returns test
+@pytest.mark.parametrize("args, kwargs, expected, message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_returns(args, kwargs, expected, message) :
+    '''
+    Test make_animation return values
+    '''
+    assert make_animation(*args, **kwargs) == expected, message
+
+
+
+# %% Error test
+@pytest.mark.parametrize("args, kwargs, error, error_message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_errors(args, kwargs, error, error_message) :
+    '''
+    Test make_animation error values
+    '''
+    with pytest.raises(error, match=error_message) :
+        make_animation(*args, **kwargs)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

plotlp-0.1.11/src/plotlp/modules/subplots_LP/_functions/__template__.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+
+
+
+# %% Libraries
+
+
+
+
+# %% Function
+def temp(**kwargs) :
+    '''
+    TODO
+    '''
+
+    print('Hello world!')