Alternative to time-origin tof computation

.buildconfig/ci-linux.yml

@@ -39,7 +39,7 @@ dependencies:
   - sphinx-copybutton==0.5.2
   - sphinx-design==0.6.1
   - sphinxcontrib-bibtex==2.6.3
-  - tof==24.10.0
+  - tof==24.12.0
 
   # docs and tests
   - sciline==24.10.0

docs/user-guide/wfm/dream-wfm.ipynb

@@ -261,7 +261,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "raw_data = ess_beamline.get_monitor(\"detector\")\n",
+    "raw_data = ess_beamline.get_monitor(\"detector\")[0]\n",
     "\n",
     "# Visualize\n",
     "raw_data.hist(event_time_offset=300).sum(\"pulse\").plot()"
@@ -385,14 +385,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "workflow = sl.Pipeline(\n",
-    "    unwrap.unwrap_providers()\n",
-    "    + unwrap.time_of_flight_providers()\n",
-    "    + unwrap.time_of_flight_origin_from_choppers_providers(wfm=True)\n",
-    ")\n",
+    "workflow = sl.Pipeline(unwrap.providers(), params=unwrap.params())\n",
     "\n",
     "workflow[unwrap.PulsePeriod] = sc.reciprocal(ess_beamline.source.frequency)\n",
-    "workflow[unwrap.PulseStride | None] = None\n",
     "workflow[unwrap.SourceTimeRange] = pulse_tmin, pulse_tmax\n",
     "workflow[unwrap.SourceWavelengthRange] = pulse_wmin, pulse_wmax\n",
     "workflow[unwrap.Choppers] = choppers\n",
@@ -420,7 +415,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "bounds = workflow.compute(unwrap.CleanFrameAtDetector).subbounds()\n",
+    "bounds = workflow.compute(unwrap.FrameAtDetector).subbounds()\n",
     "bounds"
    ]
   },
@@ -597,7 +592,7 @@
    "outputs": [],
    "source": [
     "raw_data = sc.concat(\n",
-    "        [ess_beamline.get_monitor(key) for key in monitors.keys()],\n",
+    "        [ess_beamline.get_monitor(key)[0] for key in monitors.keys()],\n",
     "        dim='detector_number',\n",
     "    )\n",
     "\n",
@@ -743,44 +738,8 @@
    "id": "48",
    "metadata": {},
    "source": [
-    "We now update our workflow with the new choppers and raw data,\n",
-    "compute the frame bounds and overlay them on the figure."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "49",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "workflow[unwrap.Choppers] = choppers\n",
-    "workflow[unwrap.Ltotal] = Ltotal\n",
-    "workflow[unwrap.RawData] = ess_beamline.get_monitor(\"detector\")\n",
-    "\n",
-    "\n",
-    "bounds = workflow.compute(unwrap.CleanFrameAtDetector).subbounds()\n",
-    "\n",
-    "for b in sc.collapse(bounds[\"time\"], keep=\"bound\").values():\n",
-    "    cascade_ax.axvspan(\n",
-    "        b[0].to(unit=\"ms\").value,\n",
-    "        b[1].to(unit=\"ms\").value,\n",
-    "        color=\"gray\",\n",
-    "        alpha=0.2,\n",
-    "        zorder=-5,\n",
-    "    )\n",
-    "\n",
-    "cascade_fig"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "50",
-   "metadata": {},
-   "source": [
-    "We see that instead of having overlapping bounds, the region in the middle has been excluded.\n",
-    "\n",
-    "This means that the neutrons in the overlapping region will be discarded in the time-of-flight calculation\n",
+    "To avoid the overlap in time, the region in the middle will be excluded,\n",
+    "discarding the neutrons from the time-of-flight calculation\n",
     "(in practice, they are given a NaN value as a time-of-flight).\n",
     "\n",
     "This is visible when comparing to the true neutron wavelengths,\n",
@@ -790,10 +749,14 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "51",
+   "id": "49",
    "metadata": {},
    "outputs": [],
    "source": [
+    "workflow[unwrap.Choppers] = choppers\n",
+    "workflow[unwrap.Ltotal] = Ltotal\n",
+    "workflow[unwrap.RawData] = ess_beamline.get_monitor(\"detector\")[0]\n",
+    "\n",
     "# Compute time-of-flight\n",
     "tofs = workflow.compute(unwrap.TofData)\n",
     "# Compute wavelength\n",

docs/user-guide/wfm/wfm-time-of-flight.ipynb

@@ -282,7 +282,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "raw_data = ess_beamline.get_monitor(\"detector\")\n",
+    "raw_data = ess_beamline.get_monitor(\"detector\")[0]\n",
     "\n",
     "# Visualize\n",
     "raw_data.hist(event_time_offset=300).sum(\"pulse\").plot()"
@@ -368,10 +368,10 @@
    "outputs": [],
    "source": [
     "# Chop the frames\n",
-    "frames = frames.chop(choppers.values())\n",
+    "chopped = frames.chop(choppers.values())\n",
     "\n",
     "# Propagate the neutrons to the detector\n",
-    "at_sample = frames.propagate_to(Ltotal)\n",
+    "at_sample = chopped.propagate_to(Ltotal)\n",
     "\n",
     "# Visualize the results\n",
     "cascade_fig, cascade_ax = at_sample.draw()"
@@ -406,14 +406,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "workflow = sl.Pipeline(\n",
-    "    unwrap.unwrap_providers()\n",
-    "    + unwrap.time_of_flight_providers()\n",
-    "    + unwrap.time_of_flight_origin_from_choppers_providers(wfm=True)\n",
-    ")\n",
+    "workflow = sl.Pipeline(unwrap.providers(), params=unwrap.params())\n",
     "\n",
     "workflow[unwrap.PulsePeriod] = sc.reciprocal(ess_beamline.source.frequency)\n",
-    "workflow[unwrap.PulseStride | None] = None\n",
     "workflow[unwrap.SourceTimeRange] = time_min, time_max\n",
     "workflow[unwrap.SourceWavelengthRange] = wavs_min, wavs_max\n",
     "workflow[unwrap.Choppers] = choppers\n",

requirements/base.txt

@@ -5,11 +5,11 @@
 #
 #    pip-compile-multi
 #
-contourpy==1.3.0
+contourpy==1.3.1
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-fonttools==4.54.1
+fonttools==4.55.0
     # via matplotlib
 h5py==3.12.1
     # via

requirements/basetest.txt

@@ -15,21 +15,26 @@ charset-normalizer==3.4.0
     # via requests
 comm==0.2.2
     # via ipywidgets
-contourpy==1.3.0
+contourpy==1.3.1
     # via matplotlib
 cyclebane==24.10.0
     # via sciline
 cycler==0.12.1
     # via matplotlib
 decorator==5.1.1
     # via ipython
+exceptiongroup==1.2.2
+    # via
+    #   hypothesis
+    #   ipython
+    #   pytest
 execnet==2.1.1
     # via pytest-xdist
 executing==2.1.0
     # via stack-data
-fonttools==4.54.1
+fonttools==4.55.0
     # via matplotlib
-hypothesis==6.118.8
+hypothesis==6.119.4
     # via -r basetest.in
 idna==3.10
     # via requests
@@ -122,6 +127,8 @@ sortedcontainers==2.4.0
     # via hypothesis
 stack-data==0.6.3
     # via ipython
+tomli==2.1.0
+    # via pytest
 traitlets==5.14.3
     # via
     #   comm

requirements/ci.txt

@@ -44,9 +44,15 @@ requests==2.32.3
     # via -r ci.in
 smmap==5.0.1
     # via gitdb
+tomli==2.1.0
+    # via
+    #   pyproject-api
+    #   tox
 tox==4.23.2
     # via -r ci.in
+typing-extensions==4.12.2
+    # via tox
 urllib3==2.2.3
     # via requests
-virtualenv==20.27.1
+virtualenv==20.28.0
     # via tox

requirements/dev.txt

@@ -34,23 +34,23 @@ click==8.1.7
     #   pip-tools
 copier==9.4.1
     # via -r dev.in
-dunamai==1.22.0
+dunamai==1.23.0
     # via copier
 fqdn==1.5.1
     # via jsonschema
 funcy==2.0
     # via copier
 h11==0.14.0
     # via httpcore
-httpcore==1.0.6
+httpcore==1.0.7
     # via httpx
 httpx==0.27.2
     # via jupyterlab
 isoduration==20.11.0
     # via jsonschema
 jinja2-ansible-filters==1.3.2
     # via copier
-json5==0.9.28
+json5==0.10.0
     # via jupyterlab-server
 jsonpointer==3.0.0
     # via jsonschema
@@ -71,7 +71,7 @@ jupyter-server==2.14.2
     #   notebook-shim
 jupyter-server-terminals==0.5.3
     # via jupyter-server
-jupyterlab==4.3.0
+jupyterlab==4.3.1
     # via -r dev.in
 jupyterlab-server==2.27.3
     # via jupyterlab
@@ -91,9 +91,9 @@ prometheus-client==0.21.0
     # via jupyter-server
 pycparser==2.22
     # via cffi
-pydantic==2.9.2
+pydantic==2.10.2
     # via copier
-pydantic-core==2.23.4
+pydantic-core==2.27.1
     # via pydantic
 python-json-logger==2.0.7
     # via jupyter-events
@@ -131,7 +131,7 @@ webcolors==24.11.1
     # via jsonschema
 websocket-client==1.8.0
     # via jupyter-server
-wheel==0.45.0
+wheel==0.45.1
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file: