Merge pull request #59 from scipp/toa

Rename `tof` coordinate to `toa`
scipp · Oct 10, 2024 · fd6d152 · fd6d152
2 parents 6922879 + c3d0f00
commit fd6d152
Show file tree

Hide file tree

Showing 14 changed files with 801 additions and 138 deletions.
diff --git a/docs/components.ipynb b/docs/components.ipynb
@@ -108,7 +108,7 @@
    "id": "34267819-4f83-48c6-b51b-9f13742ac3da",
    "metadata": {},
    "source": [
-    "The data itself is available via the `.tofs`, `.wavelengths`, `.birth_times`, and `.speeds` properties,\n",
+    "The data itself is available via the `.toas`, `.wavelengths`, `.birth_times`, and `.speeds` properties,\n",
     "depending on which one you wish to inspect.\n",
     "\n",
     "Note that we here need to have the additional `.visible` property in the chain,\n",
@@ -123,7 +123,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.visible.data"
+    "res.detectors['detector'].toas.visible.data"
    ]
   },
   {
@@ -202,7 +202,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.choppers['Chopper1'].tofs.plot()"
+    "res.choppers['Chopper1'].toas.plot()"
    ]
   },
   {
@@ -223,7 +223,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.plot()"
+    "res.detectors['detector'].toas.plot()"
    ]
   },
   {

diff --git a/docs/multiple-pulses.ipynb b/docs/multiple-pulses.ipynb
@@ -196,7 +196,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.plot()"
+    "res.detectors['detector'].toas.plot()"
    ]
   },
   {
@@ -253,7 +253,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.plot()"
+    "res.detectors['detector'].toas.plot()"
    ]
   },
   {
@@ -273,7 +273,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.visible.data"
+    "res.detectors['detector'].toas.visible.data"
    ]
   },
   {
@@ -291,7 +291,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.visible[0].data"
+    "res.detectors['detector'].toas.visible[0].data"
    ]
   },
   {
@@ -301,15 +301,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['detector'].tofs.visible[0].plot()"
+    "res.detectors['detector'].toas.visible[0].plot()"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "e3388ce1-f766-4162-b254-22c3f564f3d1",
    "metadata": {},
    "source": [
-    "and the same is available one level above on the `tofs` property,\n",
+    "and the same is available one level above on the `toas` property,\n",
     "in which case both visible and blocked neutrons for the given pulse are returned:"
    ]
   },
@@ -320,7 +320,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.choppers['WFM1'].tofs[0].plot()"
+    "res.choppers['WFM1'].toas[0].plot()"
    ]
   }
  ],

diff --git a/docs/short-example.ipynb b/docs/short-example.ipynb
@@ -245,7 +245,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.detectors['monitor'].tofs.plot()"
+    "res.detectors['monitor'].toas.plot()"
    ]
   },
   {
@@ -255,7 +255,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.choppers[\"Frame-overlap 2\"].tofs.plot()"
+    "res.choppers[\"Frame-overlap 2\"].toas.plot()"
    ]
   },
   {
@@ -284,7 +284,7 @@
    "id": "9b01bb60-da73-442c-a734-36d455375b8d",
    "metadata": {},
    "source": [
-    "The `.tofs`, `.wavelengths`, `.birth_times`, and `.speeds` properties of the beamline components return a proxy object,\n",
+    "The `.toas`, `.wavelengths`, `.birth_times`, and `.speeds` properties of the beamline components return a proxy object,\n",
     "which gives access to the data they hold.\n",
     "\n",
     "Accessing their `.data` returns a data group with both visible and blocked neutrons:"
@@ -297,7 +297,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.choppers['WFM1'].tofs.data"
+    "res.choppers['WFM1'].toas.data"
    ]
   },
   {
@@ -315,7 +315,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "res.choppers['WFM1'].tofs.visible.data"
+    "res.choppers['WFM1'].toas.visible.data"
    ]
   },
   {