Merge pull request #207 from scipp/tofectomy

Tofectomy

Author: jokasimr

…stia/create-estia-tof-lookup-table.ipynb …eate-estia-wavelength-lookup-table.ipynbdocs/user-guide/estia/create-estia-tof-lookup-table.ipynb renamed to docs/user-guide/estia/create-estia-wavelength-lookup-table.ipynb docs/user-guide/estia/create-estia-tof-lookup-table.ipynb renamed to docs/user-guide/estia/create-estia-wavelength-lookup-table.ipynb

@@ -5,9 +5,9 @@
    "id": "0",
    "metadata": {},
    "source": [
-    "# Create a TOF lookup table for ESTIA\n",
+    "# Create a wavelength lookup table for ESTIA\n",
     "\n",
-    "This notebook recreates the TOF lookup table that is used to compute time-of-flight from time-of-arrival for the ESTIA instrument.\n",
+    "This notebook recreates the wavelength lookup table that is used to compute wavelength from time-of-arrival for the ESTIA instrument.\n",
     "\n",
     "To reproduce the lookup table you will need to provide some instrument parameters like pulse stride and chopper position."
    ]
@@ -19,28 +19,18 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#%pip install tof"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#%matplotlib ipympl\n",
+    "%matplotlib ipympl\n",
     "import scipp as sc\n",
     "import scipp.constants\n",
-    "from ess.reduce import time_of_flight\n",
+    "from ess.reduce import unwrap\n",
     "from ess.reduce.nexus.types import AnyRun\n",
     "from scippneutron.chopper import DiskChopper"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "3",
+   "id": "2",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -81,64 +71,64 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "4",
+   "id": "3",
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf = time_of_flight.TofLookupTableWorkflow()\n",
+    "wf = unwrap.LookupTableWorkflow()\n",
     "\n",
-    "wf[time_of_flight.LtotalRange] = sc.scalar(35., unit=\"m\"), sc.scalar(45.0, unit=\"m\")\n",
-    "wf[time_of_flight.NumberOfSimulatedNeutrons] = 5000_000\n",
-    "wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')\n",
-    "wf[time_of_flight.DiskChoppers[AnyRun]] = disk_choppers\n",
-    "wf[time_of_flight.DistanceResolution] = sc.scalar(0.05, unit=\"m\")\n",
-    "wf[time_of_flight.TimeResolution] = sc.scalar(250.0, unit='us')\n",
-    "wf[time_of_flight.PulsePeriod] = 1.0 / sc.scalar(14.0, unit=\"Hz\")\n",
-    "wf[time_of_flight.PulseStride] = pulse_stride\n",
-    "wf[time_of_flight.PulseStrideOffset] = 0"
+    "wf[unwrap.LtotalRange] = sc.scalar(35., unit=\"m\"), sc.scalar(45.0, unit=\"m\")\n",
+    "wf[unwrap.NumberOfSimulatedNeutrons] = 10_000_000\n",
+    "wf[unwrap.SourcePosition] = sc.vector([0, 0, 0], unit='m')\n",
+    "wf[unwrap.DiskChoppers[AnyRun]] = disk_choppers\n",
+    "wf[unwrap.DistanceResolution] = sc.scalar(0.05, unit=\"m\")\n",
+    "wf[unwrap.TimeResolution] = 1.0 / sc.scalar(14.0, unit=\"Hz\") / 200\n",
+    "wf[unwrap.PulsePeriod] = 1.0 / sc.scalar(14.0, unit=\"Hz\")\n",
+    "wf[unwrap.PulseStride] = pulse_stride\n",
+    "wf[unwrap.PulseStrideOffset] = 0"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "5",
+   "id": "4",
    "metadata": {},
    "outputs": [],
    "source": [
     "%%time\n",
-    "table = wf.compute(time_of_flight.TimeOfFlightLookupTable)\n",
+    "table = wf.compute(unwrap.LookupTable)\n",
     "table"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "6",
+   "id": "5",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# This is what the relationship between time-of-arrival and time-of-flight looks like at 40m (at the detector).\n",
+    "# This is what the relationship between time-of-arrival and wavelength looks like at 40m (at the detector).\n",
     "table.array['distance', 100].plot()"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "7",
+   "id": "6",
    "metadata": {},
    "outputs": [],
    "source": [
-    "table.plot()"
+    "(sc.stddevs(table.array)/sc.values(table.array)).plot()"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "8",
+   "id": "7",
    "metadata": {},
    "outputs": [],
    "source": [
-    "table.save_hdf5(f'estia-tof-lookup-table-pulse-stride-{pulse_stride}.h5')"
+    "table.save_hdf5(f'estia-lookup-table-pulse-stride-{pulse_stride}.h5')"
    ]
   }
  ],
@@ -158,7 +148,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.10"
+   "version": "3.11.13"
   }
  },
  "nbformat": 4,