[feat] driver hamamatsurx: add support for photon-counting acquisition

Author: pieleric

install/linux/usr/share/odemis/sim/sparc2-ek-streakcam-sim.odm.yaml

@@ -2,15 +2,6 @@
 "SPARCv2 EK + Streakcam": {
     class: Microscope,
     role: sparc2,
-    children: ["SEM E-beam", "SEM Detector", "Calibration Light",
-               "Optical Path Properties", "Spectrometer Vis-NIR",
-               "Camera", "CL Detector", "Spectrograph",
-               "Spec Filter Wheel", "Spec CCD Flipper", "Spectrograph focus",
-               "Mirror Actuators", "Mirror Actuators in XY referential",
-               "Slit", "CL Selector", "CL Filter Wheel",
-               "Lens1 Mover", "Lens2 Switch",
-               "Streak Readout CCD", "Streak Delay Generator", "Streak Unit",
-               "Streak Lens"],
 }
 
 # Light (lamp with known spectrum)
@@ -150,9 +141,11 @@
 
 # simple simulated streak camera
 "Streak Camera": {
-    class: simstreakcam.StreakCamera,
+    class: hamamatsurx.StreakCamera,
     role: streak-cam,
     init: {
+        host: "fake-synchroscan",  # starts a local HPDTA simulator
+        port: 11001,
     },
     children: {
         readoutcam: "Streak Readout CCD",
@@ -164,38 +157,26 @@
     },
 }
 
-# for testing with real HW
-#"Streak Camera": {
-#    class: hamamatsurx.StreakCamera,
-#    role: streak-cam,
-#    init: {
-#        host: "172.16.4.2",  # Braunschweig System
-#        port: 1001
-#    },
-#    children: {
-#        readoutcam: "Streak Readout CCD",
-#        delaybox: "Streak Delay Generator",
-#        streakunit: "Streak Unit"
-#    },
-#    dependencies: {
-#        spectrograph: "Spectrograph"
-#    },
-#}
-
 "Streak Readout CCD": {
     role: streak-ccd,
     init: {
-        image: "sparc-ar-mirror-align.h5",  # only for simulator!  TODO replace with streak image
-#       device: 0,
         transp: [-1, 2], # if mirrored on X axis
+        can_photon_counting: true,
     },
-#    dependencies: {spectrograph: "Spectrograph"},
-    # TODO does not work for now as modelgen says no component named spectrograph found
 }
 
 "Streak Unit": {
     role: streak-unit,
     init: {
+        # Needed when using the synchroscan version
+        # Arbitrary value -> range
+        "time_ranges": {
+            1: 78.e-12,
+            2: 235.e-12,
+            3: 720.e-12,
+            4: 1600.e-12,
+            5: 3600.e-12,
+        },
     },
     affects: ["Streak Readout CCD"],
 }
@@ -205,31 +186,11 @@
     init: {
     },
     metadata: {
-        TIME_RANGE_TO_DELAY: {
-          # timeRange (s) -> triggerDelay (s)
-            1.0e-09: 7.99e-9,  # 1ns
-            2.e-09: 9.63e-9,  # 2ns
-            5.e-09: 3.32e-8,  # 5ns
-            1.e-08: 4.59e-8,  # 10ns
-            2.e-08: 6.64e-8,  # 20ns
-            5.e-08: 1.02e-7,  # 50ns
-            1.e-07: 1.69e-7,  # 100ns
-            2.e-07: 3.02e-7,  # 200ns
-            5.e-07: 7.31e-7,  # 500ns
-            1.e-06: 1.39e-6,  # 1us
-            2.e-06: 2.69e-6,  # 2us
-            5.e-06: 7.02e-6,  # 5us
-            1.e-05: 1.38e-5,  # 10us
-            2.e-05: 2.67e-5,  # 20us
-            5.e-05: 8.16e-5,  # 50us
-            1.e-04: 1.61e-4,  # 100us
-            2.e-04: 3.20e-4,  # 200us
-            5.e-04: 7.98e-4,  # 500us
-            1.e-03: 1.62e-3,  # 1ms
-            2.e-03: 3.18e-3,  # 2ms
-            5.e-03: 7.88e-3,  # 5ms
-            1.e-02: 1.54e-2,  # 10ms
-        },
+        # Not used with synchroscan, as the delay is dependent on the signal too.
+#        TIME_RANGE_TO_DELAY: {
+#          # timeRange (s) -> triggerDelay (s)
+#            1.0e-09: 7.99e-9,  # 1ns
+#        },
     },
     affects: ["Streak Unit", "Streak Readout CCD"],
 }

install/linux/usr/share/odemis/sim/sparc2-streakcam-sim.odm.yaml

@@ -239,11 +239,13 @@
     affects: ["SEM E-beam", "Streak Readout CCD", "SEM Detector", "CL Detector", "EBIC"],
 }
 
-# simple simulated streak camera
+# Streak camera simulator using the HPDTASim (RemoteEx protocol)
 "Streak Camera": {
-    class: simstreakcam.StreakCamera,
+    class: hamamatsurx.StreakCamera,
     role: streak-cam,
     init: {
+        host: "fake-singlesweep",  # starts a local HPDTA simulator
+        port: 11001,
     },
     children: {
         readoutcam: "Streak Readout CCD",
@@ -255,30 +257,11 @@
     },
 }
 
-# for testing with real HW
-#"Streak Camera": {
-#    class: hamamatsurx.StreakCamera,
-#    role: streak-cam,
-#    init: {
-#        host: "172.16.4.2",  # Braunschweig System
-#        port: 1001
-#    },
-#    children: {
-#        readoutcam: "Streak Readout CCD",
-#        delaybox: "Streak Delay Generator",
-#        streakunit: "Streak Unit"
-#    },
-#    dependencies: {
-#        spectrograph: "Spectrograph"
-#    },
-#}
-
 "Streak Readout CCD": {
     role: streak-ccd,
     init: {
-        image: "sparc-ar-mirror-align.h5",  # only for simulator!  TODO replace with streak image
-#       device: 0,
         transp: [-1, 2], # if mirrored on X axis
+        can_photon_counting: true,
     },
     metadata: {
         CALIB: {"intensity_limit": 50000},  # counts/s, high max to not trigger easily the safety check
@@ -288,7 +271,15 @@
 "Streak Unit": {
     role: streak-unit,
     init: {
-#        settings_ini: "C:\ProgramData\Hamamatsu\HPDTA\SingleSweep.ini" # path of the .ini file for HPDTA to run
+    # Needed when using the synchroscan version
+#        # Arbitrary value -> range
+#        "time_ranges": {
+#            1: 78.e-12,
+#            2: 235.e-12,
+#            3: 720.e-12,
+#            4: 1600.e-12,
+#            5: 3600.e-12,
+#        },
     },
     affects: ["Streak Readout CCD"],
 }