splinekit 0.2.8__tar.gz → 0.2.10__tar.gz

{splinekit-0.2.8 → splinekit-0.2.10}/.gitignore

@@ -94,6 +94,9 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
+# Jupyterlite
+_output/
+
 # IPython
 profile_default/
 ipython_config.py

{splinekit-0.2.8 → splinekit-0.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splinekit
-Version: 0.2.8
+Version: 0.2.10
 Summary: A set of functions and classes to handle periodic 1D polynomial splines
 Author-Email: Philippe Thévenaz <philippe.thevenaz@icloud.com>
 Maintainer-Email: Philippe Thévenaz <philippe.thevenaz@icloud.com>
@@ -51,7 +51,7 @@ Description-Content-Type: text/markdown
 
 <!-- splinekit/README.md -->
 
-# Version 0.2.8
+# Version 0.2.10
 
 # splinekit: Spline Operations
 `splinekit` is a Python-based open-source software library aimed at the manipulation of one-dimensional periodic splines.
@@ -136,3 +136,6 @@ Upgraded to jupyterlite 0.7
 
 ### 0.2.8
 Some demos added.
+
+### 0.2.9 — 0.2.10
+All demos added. Operators. Faster execution.

{splinekit-0.2.8 → splinekit-0.2.10}/README.md

@@ -1,6 +1,6 @@
 <!-- splinekit/README.md -->
 
-# Version 0.2.8
+# Version 0.2.10
 
 # splinekit: Spline Operations
 `splinekit` is a Python-based open-source software library aimed at the manipulation of one-dimensional periodic splines.
@@ -85,3 +85,6 @@ Upgraded to jupyterlite 0.7
 
 ### 0.2.8
 Some demos added.
+
+### 0.2.9 — 0.2.10
+All demos added. Operators. Faster execution.

{splinekit-0.2.8 → splinekit-0.2.10/dev/Accelerated}/pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "scikit_build_core.build" # Activate for C dynamic library
 # Project
 [project]
 name = "splinekit"
-version = "0.2.8"
+version = "0.2.10"
 dependencies = [
     "numpy >=1.26",
     "scipy >=1.15",

splinekit-0.2.10/dev/Jupyter/periodic-spline/addition/spline_add_prjct.ipynb

@@ -0,0 +1,173 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "006cebf8-f66b-48aa-9f8b-0840d37ca07d",
+   "metadata": {},
+   "source": [
+    "# Addition of Splines of Identical Period\n",
+    "We display the augend in the <span style=\"color:#1f77b4\">**azure**</span> color; it is the realization of a random periodic polynomial spline of a specified degree $n_{1}$ and delay $\\delta x_{1}.$ For some other (independent) degree $n_{2}$ and delay $\\delta x_{2},$ we display the addend in the <span style=\"color:#17becf\">**aqua**</span> color; it is another realization of a random periodic polynomial spline. We then plot as a thick curve in the <span style=\"color:#8c564b\">**sepia**</span> color the spline of specified degree $n$ and delay $\\delta x$ that best approximates the addition of the addend to the augend. The augend, the addend, and the approximation of their sum have the same period, but may not share the location of their knots."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b3185aea-65df-4ca8-8011-efe4d523876c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Load the required libraries\n",
+    "import ipywidgets as widgets\n",
+    "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import splinekit as sk # This library\n",
+    "\n",
+    "# Setup\n",
+    "max_period = 15 # Maximal period\n",
+    "max_degree = 9 # Maximal spline degree\n",
+    "max_delay = 3.0 # Maximal absolute delay\n",
+    "\n",
+    "# Initialize the generator of random numbers\n",
+    "rng = np.random.default_rng()\n",
+    "\n",
+    "# Initial random periodic splines\n",
+    "f1 = sk.PeriodicSpline1D.from_spline_coeff(rng.standard_normal(6), degree = 2)\n",
+    "f2 = sk.PeriodicSpline1D.from_spline_coeff(rng.standard_normal(6), degree = 3)\n",
+    "\n",
+    "# Plot\n",
+    "def update_plot (\n",
+    "    period = 6,\n",
+    "    degree_1 = 2,\n",
+    "    delay_1 = 0.0,\n",
+    "    degree_2 = 3,\n",
+    "    delay_2 = 0.0,\n",
+    "    degree = 1,\n",
+    "    delay = 0.0\n",
+    "):\n",
+    "    global f1\n",
+    "    global f2\n",
+    "\n",
+    "    # Update of the splines\n",
+    "    if f1.period != period:\n",
+    "        f1 = sk.PeriodicSpline1D.from_spline_coeff(\n",
+    "            rng.standard_normal(period),\n",
+    "            degree = f1.degree\n",
+    "        )\n",
+    "    f1.degree = degree_1\n",
+    "    f1.delay = delay_1\n",
+    "    if f2.period != period:\n",
+    "        f2 = sk.PeriodicSpline1D.from_spline_coeff(\n",
+    "            rng.standard_normal(period),\n",
+    "            degree = f2.degree\n",
+    "        )\n",
+    "    f2.degree = degree_2\n",
+    "    f2.delay = delay_2\n",
+    "\n",
+    "    # Addition\n",
+    "    f = sk.PeriodicSpline1D.add_projected(f1, f2, degree = degree, delay = delay)\n",
+    "\n",
+    "    # Dynamic range\n",
+    "    image = {f1.image(), f2.image(), f.image()}\n",
+    "    plotrange = sk.interval.Interval.enclosure(image)\n",
+    "    plotrange = sk.interval.Closed((\n",
+    "        plotrange.midpoint - 0.55 * plotrange.diameter,\n",
+    "        plotrange.midpoint + 0.55 * plotrange.diameter\n",
+    "    ))\n",
+    "\n",
+    "    # Plots\n",
+    "    subplot = plt.subplots()\n",
+    "    # Augend\n",
+    "    f1.plot(subplot, plotrange = plotrange, plotpoints = 200 + 1)\n",
+    "    # Addend\n",
+    "    f2.plot(\n",
+    "        subplot,\n",
+    "        plotrange = plotrange,\n",
+    "        plotpoints = 200 + 1,\n",
+    "        curve_fmt = \"-C9\",\n",
+    "        curve_markerfmt = \"oC9\",\n",
+    "    )\n",
+    "    # Sum\n",
+    "    f.plot(\n",
+    "        subplot,\n",
+    "        plotrange = plotrange,\n",
+    "        plotpoints = 200 + 1,\n",
+    "        curve_fmt = \"-C5\",\n",
+    "        curve_markerfmt = \"oC5\",\n",
+    "        curve_lw = 2.0\n",
+    "    )\n",
+    "\n",
+    "    # Final display\n",
+    "    plt.show()\n",
+    "\n",
+    "widgets.interactive(\n",
+    "    update_plot,\n",
+    "    period = (1, max_period),\n",
+    "    degree_1 = (0, max_degree),\n",
+    "    delay_1 = (-max_delay, max_delay),\n",
+    "    degree_2 = (0, max_degree),\n",
+    "    delay_2 = (-max_delay, max_delay),\n",
+    "    degree = (0, max_degree),\n",
+    "    delay = (-max_delay, max_delay)\n",
+    ")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b5490a8b-70d3-4b94-a4ad-ea140f8cd9de",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.6"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

splinekit-0.2.10/dev/Jupyter/periodic-spline/addition/spline_addition.ipynb

@@ -0,0 +1,165 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "006cebf8-f66b-48aa-9f8b-0840d37ca07d",
+   "metadata": {},
+   "source": [
+    "# Addition of Two Compatible Splines\n",
+    "We display the augend in the <span style=\"color:#1f77b4\">**azure**</span> color; it is the realization of a random periodic polynomial spline of a specified period, degree, and delay. For the same period, degree, and delay, we display the addend in the <span style=\"color:#17becf\">**aqua**</span> color; it is another realization of a random periodic polynomial spline. We then plot as a thick curve in the <span style=\"color:#8c564b\">**sepia**</span> color the sum resulting from the addition of the addend to the augend."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b3185aea-65df-4ca8-8011-efe4d523876c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Load the required libraries\n",
+    "import ipywidgets as widgets\n",
+    "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import splinekit as sk # This library\n",
+    "\n",
+    "# Setup\n",
+    "max_period = 15 # Maximal period\n",
+    "max_degree = 9 # Maximal spline degree\n",
+    "max_delay = 3.0 # Maximal absolute delay\n",
+    "\n",
+    "# Initialize the generator of random numbers\n",
+    "rng = np.random.default_rng()\n",
+    "\n",
+    "# Initial random periodic cubic splines\n",
+    "f1 = sk.PeriodicSpline1D.from_spline_coeff(rng.standard_normal(6), degree = 3)\n",
+    "f2 = sk.PeriodicSpline1D.from_spline_coeff(rng.standard_normal(6), degree = 3)\n",
+    "\n",
+    "# Plot\n",
+    "def update_plot (\n",
+    "    period = 6,\n",
+    "    degree = 3,\n",
+    "    delay = 0.0\n",
+    "):\n",
+    "    global f1\n",
+    "    global f2\n",
+    "\n",
+    "    # Update of the splines\n",
+    "    if f1.period != period:\n",
+    "        f1 = sk.PeriodicSpline1D.from_spline_coeff(\n",
+    "            rng.standard_normal(period),\n",
+    "            degree = f1.degree\n",
+    "        )\n",
+    "    f1.degree = degree\n",
+    "    f1.delay = delay\n",
+    "    if f2.period != period:\n",
+    "        f2 = sk.PeriodicSpline1D.from_spline_coeff(\n",
+    "            rng.standard_normal(period),\n",
+    "            degree = f2.degree\n",
+    "        )\n",
+    "    f2.degree = degree\n",
+    "    f2.delay = delay\n",
+    "\n",
+    "    # Addition\n",
+    "    f = sk.PeriodicSpline1D.add(f1, f2)\n",
+    "\n",
+    "    # Dynamic range\n",
+    "    image = {f1.image(), f2.image(), f.image()}\n",
+    "    plotrange = sk.interval.Interval.enclosure(image)\n",
+    "    plotrange = sk.interval.Closed((\n",
+    "        plotrange.midpoint - 0.55 * plotrange.diameter,\n",
+    "        plotrange.midpoint + 0.55 * plotrange.diameter\n",
+    "    ))\n",
+    "\n",
+    "    # Plots\n",
+    "    subplot = plt.subplots()\n",
+    "    # Augend\n",
+    "    f1.plot(subplot, plotrange = plotrange, plotpoints = 200 + 1)\n",
+    "    # Addend\n",
+    "    f2.plot(\n",
+    "        subplot,\n",
+    "        plotrange = plotrange,\n",
+    "        plotpoints = 200 + 1,\n",
+    "        curve_fmt = \"-C9\",\n",
+    "        curve_markerfmt = \"oC9\",\n",
+    "    )\n",
+    "    # Sum\n",
+    "    f.plot(\n",
+    "        subplot,\n",
+    "        plotrange = plotrange,\n",
+    "        plotpoints = 200 + 1,\n",
+    "        curve_fmt = \"-C5\",\n",
+    "        curve_markerfmt = \"oC5\",\n",
+    "        curve_lw = 2.0\n",
+    "    )\n",
+    "\n",
+    "    # Final display\n",
+    "    plt.show()\n",
+    "\n",
+    "widgets.interactive(\n",
+    "    update_plot,\n",
+    "    period = (1, max_period),\n",
+    "    degree = (0, max_degree),\n",
+    "    delay = (-max_delay, max_delay)\n",
+    ")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b5490a8b-70d3-4b94-a4ad-ea140f8cd9de",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.6"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

splinekit-0.2.10/dev/Jupyter/periodic-spline/fourier/spline_from_fourier.ipynb

@@ -0,0 +1,188 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "006cebf8-f66b-48aa-9f8b-0840d37ca07d",
+   "metadata": {},
+   "source": [
+    "# Periodic Splines from Fourier Coefficients\n",
+    "We display in thick gray the realization of a random periodic polynomial spline of a specified period $K,$ degree $n,$ and delay $\\delta x;$ the red stemlines indicate the extent of one period. This periodic spline possesses an infinite-length series of Fourier coefficients that can be summarized without loss by the combination of, on one hand, a finite-dimensional vector $\\hat{\\mathbf{f}}$ of the first $\\left\\lfloor K/2\\right\\rfloor$ complex-valued Fourier coefficients of nonnegative indices and, on the other hand, of the three ancillary parameters $\\{K,n,\\delta x\\}.$\n",
+    "\n",
+    "We manipulate $\\hat{\\mathbf{f}}$ by setting a few of its components to zero. This corresponds to the application of a band-pass filter to the spline. The manipulated finite-dimensional vector of spline coefficients is then used to virtually reconstruct an infinite series of spline coefficients, and from them a spline, which we plot in blue.\n",
+    "\n",
+    "It is sometimes desirable to handle in independent fashion the average value of the reconstructed spline. Here, the field ``keep_dc`` takes precedence over the specification of the bandpass range."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b3185aea-65df-4ca8-8011-efe4d523876c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Load the required libraries\n",
+    "import ipywidgets as widgets\n",
+    "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import splinekit as sk # This library\n",
+    "\n",
+    "# Setup\n",
+    "max_period = 20 # Maximal period\n",
+    "max_degree = 9 # Maximal spline degree\n",
+    "max_delay = 3.0 # Maximal absolute delay\n",
+    "\n",
+    "# Initialize the generator of random numbers\n",
+    "rng = np.random.default_rng()\n",
+    "\n",
+    "# Initial random periodic cubic spline\n",
+    "s0 = sk.PeriodicSpline1D.from_spline_coeff(rng.standard_normal(9), degree = 3)\n",
+    "\n",
+    "# Plot\n",
+    "def update_plot (\n",
+    "    period = 9,\n",
+    "    degree = 3,\n",
+    "    delay = 0.0,\n",
+    "    bandpass = (9 // 6, 18 // 6),\n",
+    "    keep_dc = False\n",
+    "):\n",
+    "    global s0\n",
+    "\n",
+    "    # Update of the spline\n",
+    "    if s0.period != period:\n",
+    "        s0 = sk.PeriodicSpline1D.from_spline_coeff(\n",
+    "            rng.standard_normal(period),\n",
+    "            degree = s0.degree\n",
+    "        )\n",
+    "    s0.degree = degree\n",
+    "    s0.delay = delay\n",
+    "\n",
+    "    # Fourier series\n",
+    "    f0 = s0.fourier_series()\n",
+    "    erase = f0.copy()\n",
+    "    erase[bandpass_widget.value[0] : bandpass_widget.value[1] + 1] = 0\n",
+    "    erase[0] = 0 if keep_dc else f0[0]\n",
+    "    s = sk.PeriodicSpline1D.from_fourier_series(\n",
+    "        f0 - erase,\n",
+    "        period = period,\n",
+    "        degree = degree,\n",
+    "        delay = delay\n",
+    "    )\n",
+    "\n",
+    "    # Dynamic range\n",
+    "    image = {s0.image(), s.image()}\n",
+    "    plotrange = sk.interval.Interval.enclosure(image)\n",
+    "    if isinstance(plotrange, sk.interval.Singleton):\n",
+    "        plotrange = sk.interval.Closed((\n",
+    "            plotrange.midpoint - 0.5,\n",
+    "            plotrange.midpoint + 0.5\n",
+    "        ))\n",
+    "    else:\n",
+    "        plotrange = sk.interval.Closed((\n",
+    "            plotrange.midpoint - 0.55 * plotrange.diameter,\n",
+    "            plotrange.midpoint + 0.55 * plotrange.diameter\n",
+    "        ))\n",
+    "\n",
+    "    # Plot of the splines\n",
+    "    subplot = plt.subplots()\n",
+    "    s0.plot(\n",
+    "        subplot,\n",
+    "        plotpoints = 200 + 1,\n",
+    "        plotrange = plotrange,\n",
+    "        curve_fmt = \"#E0E0E0\",\n",
+    "        curve_lw = 7.0,\n",
+    "        curve_markerfmt = \"oC7\",\n",
+    "        curvestem_linefmt = \"-C7\",\n",
+    "        knot_marker = \" \"\n",
+    "    )\n",
+    "    s.plot(subplot, plotpoints = 200 + 1, plotrange = plotrange)\n",
+    "    # Final display\n",
+    "    plt.show()\n",
+    "\n",
+    "# Interactions\n",
+    "period_widget = widgets.IntSlider(\n",
+    "    value = s0.period,\n",
+    "    min = 1,\n",
+    "    max = max_period,\n",
+    "    description = \"period\"\n",
+    ")\n",
+    "bandpass_widget = widgets.IntRangeSlider(\n",
+    "    value = (s0.period // 6, (2 * s0.period) // 6),\n",
+    "    min = 0,\n",
+    "    max = s0.period // 2,\n",
+    "    description = \"bandpass\"\n",
+    ")\n",
+    "def period_change (\n",
+    "    change\n",
+    "):\n",
+    "    bandpass_widget.max = change.new // 2\n",
+    "period_widget.observe(period_change, \"value\")\n",
+    "widgets.interactive(\n",
+    "    update_plot,\n",
+    "    period = period_widget,\n",
+    "    degree = (0, max_degree),\n",
+    "    delay = (-max_delay, max_delay),\n",
+    "    bandpass = bandpass_widget,\n",
+    "    keep_dc = False\n",
+    ")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b5490a8b-70d3-4b94-a4ad-ea140f8cd9de",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.6"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}