plopp 25.9.0__tar.gz → 25.10.0__tar.gz

{plopp-25.9.0 → plopp-25.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plopp
-Version: 25.9.0
+Version: 25.10.0
 Summary: Visualization library for Scipp
 Author: Scipp contributors
 License-Expression: BSD-3-Clause

{plopp-25.9.0 → plopp-25.10.0}/docs/customization/animations.ipynb

@@ -41,7 +41,7 @@
    "outputs": [],
    "source": [
     "da = three_bands()\n",
-    "da.plot(norm=\"log\")"
+    "da.plot(logc=True)"
    ]
   },
   {
@@ -73,7 +73,7 @@
     "# Here, 'y' is the dimension you want to slice\n",
     "slice_node = pp.Node(lambda da, ind: da[\"y\", ind], da=data_node, ind=index_node)\n",
     "\n",
-    "f = pp.linefigure(slice_node, vmin=-1, vmax=200)\n",
+    "f = pp.linefigure(slice_node, ymin=-1, ymax=200)\n",
     "\n",
     "\n",
     "def update(frame):\n",
@@ -164,7 +164,7 @@
     "da = three_bands(npeaks=20, per_peak=500, spread=30.0)\n",
     "data_node = pp.Node(da)\n",
     "\n",
-    "f = pp.imagefigure(data_node, cbar=True, vmin=30, vmax=400, norm=\"log\")\n",
+    "f = pp.imagefigure(data_node, cbar=True, cmin=30, cmax=400, logc=True)\n",
     "\n",
     "\n",
     "def update(frame):\n",
@@ -233,7 +233,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

{plopp-25.9.0 → plopp-25.10.0}/docs/customization/tweaking-figures.ipynb

@@ -77,8 +77,7 @@
    },
    "outputs": [],
    "source": [
-    "p = pp.plot(da)\n",
-    "p"
+    "pp.plot(da)"
    ]
   },
   {
@@ -92,7 +91,7 @@
     "tags": []
    },
    "source": [
-    "To change the label of the vertical axis, use the `.canvas.ylabel` property on the plot object:"
+    "To change the label of the horizontal or vertical axes, use the `xlabel/ylabel` arguments:"
    ]
   },
   {
@@ -108,8 +107,7 @@
    },
    "outputs": [],
    "source": [
-    "p.canvas.ylabel = 'Phase of sound wave'\n",
-    "p"
+    "pp.plot(da, xlabel=\"Time (milliseconds)\", ylabel=\"Phase of sound wave\")"
    ]
   },
   {
@@ -145,6 +143,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "9",
    "metadata": {
@@ -155,12 +154,10 @@
     "tags": []
    },
    "source": [
-    "### Setting the axis range\n",
-    "\n",
-    "#### Vertical axis\n",
+    "### Setting the axes ranges\n",
     "\n",
-    "Changing the range of the vertical axis is done using the `vmin` and `vmax` arguments\n",
-    "(note that if only one of the two is given, then the other will be automatically determined from the data plotted)."
+    "Changing the range of the horizontal or vertical axes is done using the `xmin/xmax` and `ymax/ymax` arguments, respectively.\n",
+    "If only the `min` or `max` is given, then the other will be automatically determined from the data plotted."
    ]
   },
   {
@@ -170,7 +167,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pp.plot(da, vmin=sc.scalar(-0.5, unit='m/s'), vmax=sc.scalar(1.5, unit='m/s'))"
+    "pp.plot(\n",
+    "    da,\n",
+    "    xmin=sc.scalar(10, unit='m'),\n",
+    "    ymin=sc.scalar(-0.5, unit='m/s'),\n",
+    "    ymax=sc.scalar(1.5, unit='m/s'),\n",
+    ")"
    ]
   },
   {
@@ -185,11 +187,7 @@
    },
    "source": [
     "Note that if the unit in the supplied limits is not identical to the data units, an on-the-fly conversion is attempted.\n",
-    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit.\n",
-    "\n",
-    "#### Horizontal axis\n",
-    "\n",
-    "The easiest way to set the range of the horizontal axis is to slice the data before plotting:"
+    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit:"
    ]
   },
   {
@@ -205,34 +203,13 @@
    },
    "outputs": [],
    "source": [
-    "pp.plot(da[10:40])"
+    "pp.plot(da, xmin=10, xmax=45)"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "13",
-   "metadata": {},
-   "source": [
-    "Note that this will add some padding around the plotted data points.\n",
-    "\n",
-    "If you wish to have precise control over the limits, you can use the lower-level `canvas.xrange` property:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "14",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p = da.plot()\n",
-    "p.canvas.xrange = [10, 40]\n",
-    "p"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "15",
    "metadata": {
     "editable": true,
     "slideshow": {
@@ -241,34 +218,21 @@
     "tags": []
    },
    "source": [
-    "Note that `camvas.yrange` is also available, and is equivalent to using the `vmin` and `vmax` arguments.\n",
-    "\n",
     "## Further modifications\n",
     "\n",
     "Instead of providing keyword arguments for tweaking every aspect of the figures,\n",
     "we provide accessors to the underlying Matplotlib `Figure` and `Axes` objects,\n",
-    "that can then directly be used to make the required modifications."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "16",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": []
-   },
-   "source": [
+    "that can then directly be used to make the required modifications.\n",
+    "\n",
     "### Tick locations and labels\n",
+    "\n",
     "To change the location of the ticks, as well as their labels, we directly access the Matplotlib axes via the `.ax` property of the figure:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "17",
+   "id": "14",
    "metadata": {
     "editable": true,
     "slideshow": {
@@ -286,7 +250,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "18",
+   "id": "15",
    "metadata": {},
    "source": [
     "### Axes placement\n",
@@ -298,7 +262,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "19",
+   "id": "16",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -319,7 +283,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "20",
+   "id": "17",
    "metadata": {},
    "source": [
     "It is also possible to control the placement of the colorbar for image plots using the `cax` argument:"
@@ -328,7 +292,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "21",
+   "id": "18",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -357,7 +321,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

{plopp-25.9.0 → plopp-25.10.0}/docs/gallery/interactive-masking.ipynb

@@ -181,7 +181,7 @@
     "\n",
     "masking_node = pp.Node(apply_masks, data_node)\n",
     "\n",
-    "fig = pp.imagefigure(masking_node, norm='log')\n",
+    "fig = pp.imagefigure(masking_node, logc=True)\n",
     "\n",
     "r = RectangleTool(\n",
     "    figure=fig, input_node=data_node, func=define_mask, destination=masking_node\n",

{plopp-25.9.0 → plopp-25.10.0}/docs/gallery/masking-a-range.ipynb

@@ -123,7 +123,7 @@
     "sum_node = pp.Node(sc.sum, mask_node, dim=ydim)\n",
     "\n",
     "# Make figures\n",
-    "image = pp.imagefigure(mask_node, norm='log')\n",
+    "image = pp.imagefigure(mask_node, logc=True)\n",
     "lines = pp.linefigure(sum_node, grid=True, ls='solid', marker='')\n",
     "ipw.VBox([slider, image, lines])"
    ]

{plopp-25.9.0 → plopp-25.10.0}/docs/gallery/peeling-layers.ipynb

@@ -103,7 +103,7 @@
     "b = da[(da.data > sc.scalar(0.002)) & (da.data < sc.scalar(0.005))]\n",
     "\n",
     "# Display both on the same scatter plot\n",
-    "p = pp.scatter3d({'a': a, 'b': b}, pos='position', norm='log', cbar=True)\n",
+    "p = pp.scatter3d({'a': a, 'b': b}, pos='position', logc=True, cbar=True)\n",
     "\n",
     "# Extract the point clouds from the final plot and set a lower opacity on the second point cloud\n",
     "clouds = list(p.artists.values())\n",

{plopp-25.9.0 → plopp-25.10.0}/docs/gallery/rectangle-selection.ipynb

@@ -154,7 +154,7 @@
     "\n",
     "data_node = pp.Node(da)\n",
     "\n",
-    "f2d = pp.imagefigure(data_node, norm='log')\n",
+    "f2d = pp.imagefigure(data_node, logc=True)\n",
     "f1d = pp.linefigure()\n",
     "\n",
     "r = RectangleTool(figure=f2d, input_node=data_node, func=vertical_sum, destination=f1d)\n",

{plopp-25.9.0 → plopp-25.10.0}/docs/gallery/streaming-plot.ipynb

@@ -101,7 +101,7 @@
     "stream_node = pp.Node(data, iteration=play_node)\n",
     "\n",
     "# Plot on a figure\n",
-    "fig = pp.imagefigure(stream_node, norm=\"log\", cbar=True)"
+    "fig = pp.imagefigure(stream_node, logc=True, cbar=True)"
    ]
   },
   {

{plopp-25.9.0 → plopp-25.10.0}/docs/getting-started/overview.ipynb

@@ -251,8 +251,7 @@
    "source": [
     "## Logarithmic scale\n",
     "\n",
-    "Data can be plotted on a logarithmic scale on one or both axes.\n",
-    "For the independent axis (the coordinate axis, i.e., the horizontal axis) this can be set using the `scale` option:"
+    "Data can be plotted on a logarithmic scale on one or both axes using the `logx` and `logy` arguments:"
    ]
   },
   {
@@ -261,7 +260,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da1.plot(scale={'x': 'log'})"
+    "da1.plot(logx=True)"
    ]
   },
   {
@@ -270,21 +269,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(scale={'x': 'log', 'time': 'log'})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Note the the keys in the `scale` dict are dimension labels and *not* \"x\" and \"y\" as Matplotlib would refer to its axes."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "For the dependent axis (the data axis, i.e., vertical axis) use the `norm` option:"
+    "(100 * (da1 - da1.min())).plot(logy=True)"
    ]
   },
   {
@@ -293,7 +278,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "(100 * (da1 - da1.min())).plot(norm='log')"
+    "da.plot(logx=True, logy=True)"
    ]
   }
  ],
@@ -312,7 +297,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

{plopp-25.9.0 → plopp-25.10.0}/docs/plotting/image-plot.ipynb

@@ -91,7 +91,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(norm='log')"
+    "da.plot(logc=True)"
    ]
   },
   {
@@ -109,7 +109,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(scale={'x': 'log'})"
+    "da.plot(logx=True)"
    ]
   },
   {
@@ -117,9 +117,7 @@
    "id": "12",
    "metadata": {},
    "source": [
-    "## Setting the axes limits\n",
-    "\n",
-    "Setting the axes limits is done by simply slicing the data before plotting it:"
+    "## Setting the axes limits"
    ]
   },
   {
@@ -129,7 +127,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pp.plot(da['x', :40]['y', 10:30])"
+    "pp.plot(da, xmax=sc.scalar(25, unit='m'))"
    ]
   },
   {
@@ -137,7 +135,8 @@
    "id": "14",
    "metadata": {},
    "source": [
-    "## Setting the colorscale limits"
+    "Note that if the unit in the supplied limits is not identical to the data units, an on-the-fly conversion is attempted.\n",
+    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit."
    ]
   },
   {
@@ -147,7 +146,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(vmin=sc.scalar(0, unit='m/s'), vmax=sc.scalar(0.5, unit='m/s'))"
+    "pp.plot(da, xmax=25, ymin=10, ymax=30)"
    ]
   },
   {
@@ -155,8 +154,9 @@
    "id": "16",
    "metadata": {},
    "source": [
-    "Note that if the unit in the supplied limits is not identical to the data units, an on-the-fly conversion is attempted.\n",
-    "It is also possible to omit the units altogether, in which case it is assumed the unit is the same as the data unit."
+    "## Setting the colorscale limits\n",
+    "\n",
+    "Similarly to the axes limits, the colorscale limits are controlled via the `cmin/cmax` arguments:"
    ]
   },
   {
@@ -166,7 +166,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "da.plot(vmin=0, vmax=0.5)"
+    "da.plot(cmin=sc.scalar(0, unit='m/s'), cmax=0.5)"
    ]
   },
   {
@@ -174,7 +174,9 @@
    "id": "18",
    "metadata": {},
    "source": [
-    "## Masks on images"
+    "## Masks on images\n",
+    "\n",
+    "The masked data are by default represented using a grayscale colormap:"
    ]
   },
   {
@@ -194,6 +196,42 @@
    "cell_type": "markdown",
    "id": "20",
    "metadata": {},
+   "source": [
+    "The colormap for the masks can be changed using the `mask_cmap` argument:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "21",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "da.plot(mask_cmap='hot')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "22",
+   "metadata": {},
+   "source": [
+    "Masks can also be a solid color:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "23",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "da.plot(mask_color='magenta')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "24",
+   "metadata": {},
    "source": [
     "## Using a non-dimension coordinate\n",
     "\n",
@@ -204,7 +242,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "21",
+   "id": "25",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -216,7 +254,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "22",
+   "id": "26",
    "metadata": {},
    "source": [
     "Note that if no coordinate of name `'x'` exists, a dummy one will be generated using `scipp.arange`."
@@ -238,7 +276,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,