Preview for PR #17 9b108fd

Author: timtreis

pr-17/_sources/notebooks/tutorials/multichannel_images.ipynb

@@ -35,10 +35,10 @@
    "id": "b08a5ca5",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:23.442294Z",
-     "iopub.status.busy": "2026-08-26T22:42:23.442179Z",
-     "iopub.status.idle": "2026-08-26T22:42:30.929826Z",
-     "shell.execute_reply": "2026-08-26T22:42:30.929152Z"
+     "iopub.execute_input": "2026-08-26T22:59:30.591925Z",
+     "iopub.status.busy": "2026-08-26T22:59:30.591814Z",
+     "iopub.status.idle": "2026-08-26T22:59:38.822058Z",
+     "shell.execute_reply": "2026-08-26T22:59:38.821422Z"
     }
    },
    "outputs": [
@@ -105,10 +105,10 @@
    "id": "d89c8521",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:30.931802Z",
-     "iopub.status.busy": "2026-08-26T22:42:30.931644Z",
-     "iopub.status.idle": "2026-08-26T22:42:30.935159Z",
-     "shell.execute_reply": "2026-08-26T22:42:30.934657Z"
+     "iopub.execute_input": "2026-08-26T22:59:38.824289Z",
+     "iopub.status.busy": "2026-08-26T22:59:38.824129Z",
+     "iopub.status.idle": "2026-08-26T22:59:38.827757Z",
+     "shell.execute_reply": "2026-08-26T22:59:38.827096Z"
     }
    },
    "outputs": [
@@ -149,10 +149,10 @@
    "id": "570aa7b2",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:30.936836Z",
-     "iopub.status.busy": "2026-08-26T22:42:30.936720Z",
-     "iopub.status.idle": "2026-08-26T22:42:31.511750Z",
-     "shell.execute_reply": "2026-08-26T22:42:31.510934Z"
+     "iopub.execute_input": "2026-08-26T22:59:38.829412Z",
+     "iopub.status.busy": "2026-08-26T22:59:38.829297Z",
+     "iopub.status.idle": "2026-08-26T22:59:39.470071Z",
+     "shell.execute_reply": "2026-08-26T22:59:39.469248Z"
     }
    },
    "outputs": [
@@ -188,10 +188,10 @@
    "id": "0d925a12",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:31.514910Z",
-     "iopub.status.busy": "2026-08-26T22:42:31.514762Z",
-     "iopub.status.idle": "2026-08-26T22:42:31.810377Z",
-     "shell.execute_reply": "2026-08-26T22:42:31.809800Z"
+     "iopub.execute_input": "2026-08-26T22:59:39.473369Z",
+     "iopub.status.busy": "2026-08-26T22:59:39.473184Z",
+     "iopub.status.idle": "2026-08-26T22:59:39.772138Z",
+     "shell.execute_reply": "2026-08-26T22:59:39.771353Z"
     }
    },
    "outputs": [
@@ -229,10 +229,10 @@
    "id": "d7b0b288",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:31.813951Z",
-     "iopub.status.busy": "2026-08-26T22:42:31.813825Z",
-     "iopub.status.idle": "2026-08-26T22:42:32.119865Z",
-     "shell.execute_reply": "2026-08-26T22:42:32.119298Z"
+     "iopub.execute_input": "2026-08-26T22:59:39.775925Z",
+     "iopub.status.busy": "2026-08-26T22:59:39.775775Z",
+     "iopub.status.idle": "2026-08-26T22:59:40.087608Z",
+     "shell.execute_reply": "2026-08-26T22:59:40.086943Z"
     }
    },
    "outputs": [
@@ -273,10 +273,10 @@
    "id": "98f3c957",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:32.123466Z",
-     "iopub.status.busy": "2026-08-26T22:42:32.123328Z",
-     "iopub.status.idle": "2026-08-26T22:42:32.387047Z",
-     "shell.execute_reply": "2026-08-26T22:42:32.386323Z"
+     "iopub.execute_input": "2026-08-26T22:59:40.091855Z",
+     "iopub.status.busy": "2026-08-26T22:59:40.091717Z",
+     "iopub.status.idle": "2026-08-26T22:59:40.357031Z",
+     "shell.execute_reply": "2026-08-26T22:59:40.356297Z"
     }
    },
    "outputs": [
@@ -327,10 +327,10 @@
    "id": "58e201a1",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:32.391095Z",
-     "iopub.status.busy": "2026-08-26T22:42:32.390945Z",
-     "iopub.status.idle": "2026-08-26T22:42:32.727090Z",
-     "shell.execute_reply": "2026-08-26T22:42:32.726408Z"
+     "iopub.execute_input": "2026-08-26T22:59:40.360466Z",
+     "iopub.status.busy": "2026-08-26T22:59:40.360316Z",
+     "iopub.status.idle": "2026-08-26T22:59:40.696168Z",
+     "shell.execute_reply": "2026-08-26T22:59:40.695539Z"
     }
    },
    "outputs": [
@@ -377,10 +377,10 @@
    "id": "ace47730",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:32.731385Z",
-     "iopub.status.busy": "2026-08-26T22:42:32.731231Z",
-     "iopub.status.idle": "2026-08-26T22:42:33.168146Z",
-     "shell.execute_reply": "2026-08-26T22:42:33.167540Z"
+     "iopub.execute_input": "2026-08-26T22:59:40.700279Z",
+     "iopub.status.busy": "2026-08-26T22:59:40.700134Z",
+     "iopub.status.idle": "2026-08-26T22:59:41.160089Z",
+     "shell.execute_reply": "2026-08-26T22:59:41.159257Z"
     }
    },
    "outputs": [
@@ -418,8 +418,9 @@
     "Prefer `palette` here: sequential colormaps like `Blues`/`Reds`/`Greens` run from *white* to colour,\n",
     "so blending several of them washes the composite out, whereas `palette` colours are additive on black.\n",
     "\n",
-    "The legend is a plain Matplotlib legend: place it with `legend_loc` and restyle it through the\n",
-    "returned axes — on a black composite, white frameless labels read best.\n"
+    "The legend is a plain Matplotlib legend: place it with `legend_params` (`loc`, `fontsize`,\n",
+    "`fontweight`, `fontoutline`) and restyle anything else through the returned axes — on a black\n",
+    "composite, white frameless labels read best.\n"
    ]
   },
   {
@@ -428,10 +429,10 @@
    "id": "b29cbc58",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:33.170686Z",
-     "iopub.status.busy": "2026-08-26T22:42:33.170547Z",
-     "iopub.status.idle": "2026-08-26T22:42:33.496358Z",
-     "shell.execute_reply": "2026-08-26T22:42:33.495440Z"
+     "iopub.execute_input": "2026-08-26T22:59:41.162339Z",
+     "iopub.status.busy": "2026-08-26T22:59:41.162204Z",
+     "iopub.status.idle": "2026-08-26T22:59:41.489770Z",
+     "shell.execute_reply": "2026-08-26T22:59:41.488997Z"
     }
    },
    "outputs": [
@@ -453,7 +454,7 @@
     "    palette=[\"blue\", \"red\", \"green\"],\n",
     "    norm=[PercentileNormalize(1, 99)] * 3,\n",
     "    channels_as_legend=True,\n",
-    ").pl.show(legend_loc=\"lower left\", return_ax=True)\n",
+    ").pl.show(legend_params={\"loc\": \"lower left\"}, return_ax=True)\n",
     "\n",
     "legend = ax.get_legend()\n",
     "legend.get_frame().set_visible(False)\n",
@@ -491,10 +492,10 @@
    "id": "d00dc035",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2026-08-26T22:42:33.499488Z",
-     "iopub.status.busy": "2026-08-26T22:42:33.499335Z",
-     "iopub.status.idle": "2026-08-26T22:42:33.535469Z",
-     "shell.execute_reply": "2026-08-26T22:42:33.534743Z"
+     "iopub.execute_input": "2026-08-26T22:59:41.493548Z",
+     "iopub.status.busy": "2026-08-26T22:59:41.493400Z",
+     "iopub.status.idle": "2026-08-26T22:59:41.531616Z",
+     "shell.execute_reply": "2026-08-26T22:59:41.530923Z"
     }
    },
    "outputs": [

pr-17/notebooks/tutorials/multichannel_images.html

@@ -638,8 +638,9 @@ <h2>8. Labelling the composite — <code class="docutils literal notranslate"><s
 a single shared <code class="docutils literal notranslate"><span class="pre">cmap</span></code> there is nothing to map, and the flag is ignored with a warning.</p>
 <p>Prefer <code class="docutils literal notranslate"><span class="pre">palette</span></code> here: sequential colormaps like <code class="docutils literal notranslate"><span class="pre">Blues</span></code>/<code class="docutils literal notranslate"><span class="pre">Reds</span></code>/<code class="docutils literal notranslate"><span class="pre">Greens</span></code> run from <em>white</em> to colour,
 so blending several of them washes the composite out, whereas <code class="docutils literal notranslate"><span class="pre">palette</span></code> colours are additive on black.</p>
-<p>The legend is a plain Matplotlib legend: place it with <code class="docutils literal notranslate"><span class="pre">legend_loc</span></code> and restyle it through the
-returned axes — on a black composite, white frameless labels read best.</p>
+<p>The legend is a plain Matplotlib legend: place it with <code class="docutils literal notranslate"><span class="pre">legend_params</span></code> (<code class="docutils literal notranslate"><span class="pre">loc</span></code>, <code class="docutils literal notranslate"><span class="pre">fontsize</span></code>,
+<code class="docutils literal notranslate"><span class="pre">fontweight</span></code>, <code class="docutils literal notranslate"><span class="pre">fontoutline</span></code>) and restyle anything else through the returned axes — on a black
+composite, white frameless labels read best.</p>
 <div class="cell docutils container">
 <div class="cell_input docutils container">
 <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">sdata</span><span class="o">.</span><span class="n">pl</span><span class="o">.</span><span class="n">render_images</span><span class="p">(</span>
@@ -648,7 +649,7 @@ <h2>8. Labelling the composite — <code class="docutils literal notranslate"><s
     <span class="n">palette</span><span class="o">=</span><span class="p">[</span><span class="s2">"blue"</span><span class="p">,</span> <span class="s2">"red"</span><span class="p">,</span> <span class="s2">"green"</span><span class="p">],</span>
     <span class="n">norm</span><span class="o">=</span><span class="p">[</span><span class="n">PercentileNormalize</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">99</span><span class="p">)]</span> <span class="o">*</span> <span class="mi">3</span><span class="p">,</span>
     <span class="n">channels_as_legend</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
-<span class="p">)</span><span class="o">.</span><span class="n">pl</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">legend_loc</span><span class="o">=</span><span class="s2">"lower left"</span><span class="p">,</span> <span class="n">return_ax</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<span class="p">)</span><span class="o">.</span><span class="n">pl</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">legend_params</span><span class="o">=</span><span class="p">{</span><span class="s2">"loc"</span><span class="p">:</span> <span class="s2">"lower left"</span><span class="p">},</span> <span class="n">return_ax</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
 <span class="n">legend</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">get_legend</span><span class="p">()</span>
 <span class="n">legend</span><span class="o">.</span><span class="n">get_frame</span><span class="p">()</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>