Merge pull request #230 from scipp/unfold-pulse-dimension

Time-of-flight: remove pulse dimension in lookup table

Author: nvaytet

docs/user-guide/tof/dream.ipynb

@@ -402,17 +402,35 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = workflow.compute(time_of_flight.TimeOfFlightLookupTable).squeeze()\n",
+    "table = workflow.compute(time_of_flight.TimeOfFlightLookupTable)\n",
     "\n",
     "# Overlay mean on the figure above\n",
     "table[\"distance\", 13].plot(ax=fig2.ax, color=\"C1\", ls=\"-\", marker=None)"
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "27",
    "metadata": {},
+   "source": [
+    "The full table covers a range of distances, and looks like"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "28",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "table.plot()"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "29",
+   "metadata": {},
    "source": [
     "### Computing a time-of-flight coordinate\n",
     "\n",
@@ -422,7 +440,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "28",
+   "id": "30",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -432,7 +450,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "29",
+   "id": "31",
    "metadata": {},
    "source": [
     "Histogramming the data for a plot should show a profile with 6 bumps that correspond to the frames:"
@@ -441,7 +459,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "30",
+   "id": "32",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -450,7 +468,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "31",
+   "id": "33",
    "metadata": {},
    "source": [
     "### Converting to wavelength\n",
@@ -461,7 +479,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "32",
+   "id": "34",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -481,7 +499,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "33",
+   "id": "35",
    "metadata": {},
    "source": [
     "### Comparing to the ground truth\n",
@@ -493,7 +511,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "34",
+   "id": "36",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -510,7 +528,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "35",
+   "id": "37",
    "metadata": {},
    "source": [
     "## Multiple detector pixels\n",
@@ -526,7 +544,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "36",
+   "id": "38",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -544,7 +562,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "37",
+   "id": "39",
    "metadata": {},
    "source": [
     "Our raw data has now a `detector_number` dimension of length 2.\n",
@@ -555,7 +573,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "38",
+   "id": "40",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -570,7 +588,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "39",
+   "id": "41",
    "metadata": {},
    "source": [
     "Computing time-of-flight is done in the same way as above.\n",
@@ -580,7 +598,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "40",
+   "id": "42",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -614,7 +632,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "41",
+   "id": "43",
    "metadata": {},
    "source": [
     "## Handling time overlap between subframes\n",
@@ -634,7 +652,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "42",
+   "id": "44",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -665,7 +683,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "43",
+   "id": "45",
    "metadata": {},
    "source": [
     "We can now see that there is no longer a gap between the two frames at the center of each pulse (green region).\n",
@@ -677,7 +695,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "44",
+   "id": "46",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -696,7 +714,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "45",
+   "id": "47",
    "metadata": {},
    "source": [
     "The data in the lookup table contains both the mean time-of-flight for each distance and time-of-arrival bin,\n",
@@ -713,17 +731,17 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "46",
+   "id": "48",
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = workflow.compute(time_of_flight.TimeOfFlightLookupTable).squeeze()\n",
+    "table = workflow.compute(time_of_flight.TimeOfFlightLookupTable)\n",
     "table.plot() / (sc.stddevs(table) / sc.values(table)).plot(norm=\"log\")"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "47",
+   "id": "49",
    "metadata": {},
    "source": [
     "The workflow has a parameter which is used to mask out regions where the standard deviation is above a certain threshold.\n",
@@ -737,18 +755,18 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "48",
+   "id": "50",
    "metadata": {},
    "outputs": [],
    "source": [
     "workflow[time_of_flight.LookupTableRelativeErrorThreshold] = 0.01\n",
     "\n",
-    "workflow.compute(time_of_flight.TimeOfFlightLookupTable).squeeze().plot()"
+    "workflow.compute(time_of_flight.TimeOfFlightLookupTable).plot()"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "49",
+   "id": "51",
    "metadata": {},
    "source": [
     "We can now see that the central region is masked out.\n",
@@ -763,7 +781,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "50",
+   "id": "52",
    "metadata": {},
    "outputs": [],
    "source": [

docs/user-guide/tof/frame-unwrapping.ipynb

@@ -420,7 +420,7 @@
    "source": [
     "table = workflow.compute(time_of_flight.TimeOfFlightLookupTable)\n",
     "\n",
-    "table[\"pulse\", 0].plot(title=\"Pulse-0\") + table[\"pulse\", 1].plot(title=\"Pulse-1\")"
+    "table.plot()"
    ]
   },
   {