Update documentation

TomographicImaging · Mar 5, 2024 · 41ba11a · 41ba11a
1 parent ea13e5f
commit 41ba11a
Show file tree

Hide file tree

Showing 9 changed files with 123 additions and 123 deletions.
diff --git a/nightly/.doctrees/demos/00_CIL_geometry.doctree b/nightly/.doctrees/demos/00_CIL_geometry.doctree
diff --git a/nightly/.doctrees/environment.pickle b/nightly/.doctrees/environment.pickle
diff --git a/nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb b/nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb
@@ -5,10 +5,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:19.291729Z",
-     "iopub.status.busy": "2024-03-04T17:26:19.291550Z",
-     "iopub.status.idle": "2024-03-04T17:26:19.294869Z",
-     "shell.execute_reply": "2024-03-04T17:26:19.294309Z"
+     "iopub.execute_input": "2024-03-05T09:56:40.305238Z",
+     "iopub.status.busy": "2024-03-05T09:56:40.305055Z",
+     "iopub.status.idle": "2024-03-05T09:56:40.308374Z",
+     "shell.execute_reply": "2024-03-05T09:56:40.307862Z"
     }
    },
    "outputs": [],
@@ -142,10 +142,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:19.297095Z",
-     "iopub.status.busy": "2024-03-04T17:26:19.296694Z",
-     "iopub.status.idle": "2024-03-04T17:26:23.321003Z",
-     "shell.execute_reply": "2024-03-04T17:26:23.320373Z"
+     "iopub.execute_input": "2024-03-05T09:56:40.310743Z",
+     "iopub.status.busy": "2024-03-05T09:56:40.310299Z",
+     "iopub.status.idle": "2024-03-05T09:56:41.133470Z",
+     "shell.execute_reply": "2024-03-05T09:56:41.132873Z"
     }
    },
    "outputs": [
@@ -209,10 +209,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:23.350648Z",
-     "iopub.status.busy": "2024-03-04T17:26:23.350384Z",
-     "iopub.status.idle": "2024-03-04T17:26:23.620174Z",
-     "shell.execute_reply": "2024-03-04T17:26:23.619580Z"
+     "iopub.execute_input": "2024-03-05T09:56:41.163896Z",
+     "iopub.status.busy": "2024-03-05T09:56:41.163333Z",
+     "iopub.status.idle": "2024-03-05T09:56:41.409041Z",
+     "shell.execute_reply": "2024-03-05T09:56:41.408415Z"
     }
    },
    "outputs": [
@@ -229,7 +229,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b04431f0>"
+       "<cil.utilities.display.show_geometry at 0x7fe0c421b400>"
       ]
      },
      "execution_count": 3,
@@ -271,10 +271,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:23.622454Z",
-     "iopub.status.busy": "2024-03-04T17:26:23.622107Z",
-     "iopub.status.idle": "2024-03-04T17:26:23.863390Z",
-     "shell.execute_reply": "2024-03-04T17:26:23.862730Z"
+     "iopub.execute_input": "2024-03-05T09:56:41.411461Z",
+     "iopub.status.busy": "2024-03-05T09:56:41.411095Z",
+     "iopub.status.idle": "2024-03-05T09:56:41.618981Z",
+     "shell.execute_reply": "2024-03-05T09:56:41.618422Z"
     }
    },
    "outputs": [
@@ -291,7 +291,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b0a272b0>"
+       "<cil.utilities.display.show_geometry at 0x7fe0ea874280>"
       ]
      },
      "execution_count": 4,
@@ -333,10 +333,10 @@
    "execution_count": 5,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:23.865619Z",
-     "iopub.status.busy": "2024-03-04T17:26:23.865430Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.092854Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.092206Z"
+     "iopub.execute_input": "2024-03-05T09:56:41.621196Z",
+     "iopub.status.busy": "2024-03-05T09:56:41.621018Z",
+     "iopub.status.idle": "2024-03-05T09:56:41.883047Z",
+     "shell.execute_reply": "2024-03-05T09:56:41.882511Z"
     }
    },
    "outputs": [
@@ -353,7 +353,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67a8d8eb30>"
+       "<cil.utilities.display.show_geometry at 0x7fe0bc609a80>"
       ]
      },
      "execution_count": 5,
@@ -394,10 +394,10 @@
    "execution_count": 6,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.095362Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.094995Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.298502Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.297886Z"
+     "iopub.execute_input": "2024-03-05T09:56:41.885411Z",
+     "iopub.status.busy": "2024-03-05T09:56:41.885065Z",
+     "iopub.status.idle": "2024-03-05T09:56:42.097685Z",
+     "shell.execute_reply": "2024-03-05T09:56:42.097071Z"
     }
    },
    "outputs": [
@@ -414,7 +414,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b090e3e0>"
+       "<cil.utilities.display.show_geometry at 0x7fe0c44b11b0>"
       ]
      },
      "execution_count": 6,
@@ -447,10 +447,10 @@
    "execution_count": 7,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.300818Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.300453Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.501866Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.501212Z"
+     "iopub.execute_input": "2024-03-05T09:56:42.099987Z",
+     "iopub.status.busy": "2024-03-05T09:56:42.099802Z",
+     "iopub.status.idle": "2024-03-05T09:56:42.307152Z",
+     "shell.execute_reply": "2024-03-05T09:56:42.306520Z"
     }
    },
    "outputs": [
@@ -467,7 +467,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b0720b80>"
+       "<cil.utilities.display.show_geometry at 0x7fe0bcd4d660>"
       ]
      },
      "execution_count": 7,
@@ -499,10 +499,10 @@
    "execution_count": 8,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.504070Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.503877Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.741118Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.740467Z"
+     "iopub.execute_input": "2024-03-05T09:56:42.309670Z",
+     "iopub.status.busy": "2024-03-05T09:56:42.309307Z",
+     "iopub.status.idle": "2024-03-05T09:56:42.539590Z",
+     "shell.execute_reply": "2024-03-05T09:56:42.538997Z"
     }
    },
    "outputs": [
@@ -519,7 +519,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b061a6b0>"
+       "<cil.utilities.display.show_geometry at 0x7fe0bcc3ba00>"
       ]
      },
      "execution_count": 8,
@@ -549,10 +549,10 @@
    "execution_count": 9,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.743494Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.743141Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.977050Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.976437Z"
+     "iopub.execute_input": "2024-03-05T09:56:42.542052Z",
+     "iopub.status.busy": "2024-03-05T09:56:42.541693Z",
+     "iopub.status.idle": "2024-03-05T09:56:42.787804Z",
+     "shell.execute_reply": "2024-03-05T09:56:42.787179Z"
     }
    },
    "outputs": [
@@ -569,7 +569,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b0359ae0>"
+       "<cil.utilities.display.show_geometry at 0x7fe0bcb1edd0>"
       ]
      },
      "execution_count": 9,
@@ -638,10 +638,10 @@
    "execution_count": 10,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.979597Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.979230Z",
-     "iopub.status.idle": "2024-03-04T17:26:24.984600Z",
-     "shell.execute_reply": "2024-03-04T17:26:24.984086Z"
+     "iopub.execute_input": "2024-03-05T09:56:42.790180Z",
+     "iopub.status.busy": "2024-03-05T09:56:42.789987Z",
+     "iopub.status.idle": "2024-03-05T09:56:42.795176Z",
+     "shell.execute_reply": "2024-03-05T09:56:42.794622Z"
     }
    },
    "outputs": [
@@ -711,10 +711,10 @@
    "execution_count": 11,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:24.986483Z",
-     "iopub.status.busy": "2024-03-04T17:26:24.986312Z",
-     "iopub.status.idle": "2024-03-04T17:26:25.721014Z",
-     "shell.execute_reply": "2024-03-04T17:26:25.720370Z"
+     "iopub.execute_input": "2024-03-05T09:56:42.797436Z",
+     "iopub.status.busy": "2024-03-05T09:56:42.797087Z",
+     "iopub.status.idle": "2024-03-05T09:56:43.531680Z",
+     "shell.execute_reply": "2024-03-05T09:56:43.531076Z"
     }
    },
    "outputs": [
@@ -772,7 +772,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f67b017e650>"
+       "<cil.utilities.display.show_geometry at 0x7fe0bca27dc0>"
       ]
      },
      "execution_count": 11,
@@ -815,10 +815,10 @@
    "execution_count": 12,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-03-04T17:26:25.723359Z",
-     "iopub.status.busy": "2024-03-04T17:26:25.723014Z",
-     "iopub.status.idle": "2024-03-04T17:26:25.726015Z",
-     "shell.execute_reply": "2024-03-04T17:26:25.725548Z"
+     "iopub.execute_input": "2024-03-05T09:56:43.534075Z",
+     "iopub.status.busy": "2024-03-05T09:56:43.533751Z",
+     "iopub.status.idle": "2024-03-05T09:56:43.536739Z",
+     "shell.execute_reply": "2024-03-05T09:56:43.536247Z"
     }
    },
    "outputs": [],

diff --git a/nightly/.doctrees/processors.doctree b/nightly/.doctrees/processors.doctree
diff --git a/nightly/_modules/cil/processors/Slicer/index.html b/nightly/_modules/cil/processors/Slicer/index.html
@@ -512,7 +512,7 @@ <h1>Source code for cil.processors.Slicer</h1><div class="highlight"><pre>
 <span class="sd">    ----------</span>
 
 <span class="sd">    roi : dict</span>
-<span class="sd">        The region-of-interest to bin {&#39;axis_name1&#39;:(start,stop,step), &#39;axis_name2&#39;:(start,stop,step)}</span>
+<span class="sd">        The region-of-interest to slice {&#39;axis_name1&#39;:(start,stop,step), &#39;axis_name2&#39;:(start,stop,step)}</span>
 <span class="sd">        The `key` being the axis name to apply the processor to, the `value` holding a tuple containing the ROI description</span>
 
 <span class="sd">        Start: Starting index of input data. Must be an integer, or `None` defaults to index 0.</span>