Cameras
The software supports camera-based acquisition. It can run both normal and rolling shutter modes of contemporary scientific CMOS cameras.
Set the camera trigger delay in . The camera configuration examples below describe camera hardware and acquisition settings; they do not set waveform timing.
Driver Installation
Daheng
MER2-1220-32U3C
More information on the Daheng MER2-1220-32U3C camera can be found on the Daheng product page.
Warning
This camera class has not been internally tested by our team. Users are advised to exercise caution when using it.
Note
This camera requires Daheng Imaging’s proprietary Python SDK and must be installed manually. Download the SDK from Daheng Imaging. Locate ‘gxipy’ under: Development/Samples/Python/gxipy and then install it using pip. Also, this camera class uses the Line0 trigger input by default for external triggering.
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: daheng.Daheng
serial_number: "123456"
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
Hamamatsu
Note
navigate has been tested with the following Hamamatsu driver/firmware versions:
DCAM API: 20.7.641, 21.7.4321, 22.9.6509, 22.11.4321, 23.12.6736
Camera Firmware: 2.21B, 2.53.A, 3.20.A, 4.30.B,
Active Silicon CoaXpress: 1.10, 1.13, 1.21.
ORCA-Quest 2 (USB)
Use the HamamatsuOrcaQuest2 camera type. Normal mode and forward/backward
Light-Sheet mode are supported. In Camera Settings, select
Light-Sheet, then Top-to-Bottom or
Bottom-to-Top. Light-sheet mode uses 1x1 binning. Alternating readout
directions are not exposed by this camera class.
The rolling slit advances two sensor rows per line interval. Odd slit widths round up to a row pair, and sweep durations adjust to the camera’s line-interval limits and increments. USB transfer can take longer than the sensor sweep; SyntheticDAQ waits for the reported minimum frame period with a small margin. This permits camera-only testing with software triggers, but does not establish synchronization with illumination hardware.
Linux DCAM 4.0.7087 was observed to return no frames for initial software triggers
after restarting capture. For a single-camera USB setup, set
reinitialize_on_restart: true under the camera configuration, alongside
defect_correct_mode. This opt-in workaround closes and reinitializes DCAM,
restores the application’s camera settings, and checks their readbacks before
restarting. It adds several seconds to acquisition startup and refuses to reset
DCAM while another camera is open. It is disabled by default for other setups.
Camera-only examples are provided in
configuration_orca_quest2_usb3.yaml
and
experiment_orca_quest2_lightsheet.yml.
Back up your configuration before using these files, replace the example camera
serial, and retain simulated auxiliary devices until you have validated the
actual hardware. Start normally with navigate; -sh would also
simulate the camera.
See the manufacturer’s ORCA-Quest 2 manual, section 11-2, for light-sheet timing and USB throughput limits.
ORCA-Flash4.0 V3
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: HamamatsuOrca
serial_number: 111
camera_connection:
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
ORCA-Fusion
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: HamamatsuOrcaFusion
serial_number: 111
camera_connection:
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
ORCA-Lightning
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: HamamatsuOrcaLightning
serial_number: 111
camera_connection:
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
ORCA-Fire
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: HamamatsuOrcaFire
serial_number: 111
camera_connection:
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
Photometrics
Note
navigate has been tested with the following Photometrics driver versions: - PVCAM: 3.9.13
Iris 15
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: Photometrics
serial_number: 111
camera_connection: PMPCIECam00
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
Ximea
MU196MR-ON
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: ximea.MU196XR
serial_number: 111
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False
gain: 1
pixel_size_in_microns: 1.4
readout_port: 0
readout_speed: 1.0
settle_down: 0.0
speed_table_index: 0
supported_readout_directions: ['Top-to-Bottom']
supported_sensor_modes: ['Normal']
supported_trigger_sources: ['External']
trigger_active: 1.0
trigger_mode: 1.0
trigger_polarity: 2.0
trigger_source: 2.0
x_pixels: 5112
x_pixels_min: 192
x_pixels_step: 24
y_pixels: 3840
y_pixels_min: 2
y_pixels_step: 2
Synthetic Camera
The synthetic camera simulates noise images from an sCMOS camera. If no camera is present, the synthetic camera class must be used.
Configuration File
microscopes:
microscope_name:
camera:
hardware:
type: synthetic
serial_number: 111
camera_connection:
defect_correct_mode: 2.0
settle_down: 0.1 #ms
flip_x: False
flip_y: False