navigate.model.devices.camera.hamamatsu.HamamatsuBase
- class navigate.model.devices.camera.hamamatsu.HamamatsuBase(microscope_name: str, device_connection: Any, configuration: dict[str, Any], *args: Optional[Any], **kwargs: Optional[Any])
Bases:
CameraBase,SequenceDeviceHamamatsuOrca camera class.
This is the default parent class for Hamamatsu Cameras. This includes the ORCA Flash 4.0, Fusion, Lightning, and Fire.
- __init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], *args: Optional[Any], **kwargs: Optional[Any]) → None
Initialize HamamatsuOrca class.
- Parameters:
microscope_name (str) – Name of microscope in configuration
device_connection (Any) – Hardware device to connect to
configuration (Dict[str, Any]) – Global configuration of the microscope
Methods
__init__(microscope_name, device_connection, ...)Initialize HamamatsuOrca class.
Convert normal mode exposure time to light-sheet mode exposure time.
Get the duration of time needed to read out an image.
Close HamamatsuOrca Camera
Close image series.
connect(camera_id)Connect to HamamatsuOrca camera.
Discover precision, restoring an idle MONO8 probe before returning.
Read the SDK's meaningful output depth, leaving missing values unknown.
Return the cached normalized format without issuing SDK calls.
Get HamamatsuOrca line interval.
Get frame from HamamatsuOrca camera.
Get offset and variance maps from file.
Get camera cooling temperature.
initialize_image_series([data_buffer, ...])Initialize HamamatsuOrca image series.
Print Camera Settings.
set_ROI([roi_width, roi_height, center_x, ...])Change the size of the active region on the camera.
set_ROI_and_binning([roi_width, roi_height, ...])Change the size of the active region on the camera and set the binning mode.
set_binning(binning_string)Set HamamatsuOrca binning mode.
set_bit_depth(bit_depth)Apply an idle-only depth change with exact readback and rollback.
set_cooling(cooling)Set camera cooling mode and temperature.
set_exposure_time(exposure_time)Set HamamatsuOrca exposure time.
set_line_interval(line_interval_time)Set HamamatsuOrca line interval.
set_readout_direction(mode)Set HamamatsuOrca readout direction.
set_sensor_mode(mode)Set HamamatsuOrca sensor mode.
set_trigger_mode([trigger_source])Set Hamamatsu trigger source and trigger mode.
Attributes
- abstract calculate_light_sheet_exposure_time(full_chip_exposure_time: float, shutter_width: int) → tuple[float, float, float]
Convert normal mode exposure time to light-sheet mode exposure time. Calculate the parameters for an acquisition
- Parameters:
full_chip_exposure_time (float) – Normal mode exposure time in seconds.
shutter_width (int) – Width of light-sheet rolling shutter.
- Returns:
exposure_time (float) – Light-sheet mode exposure time (s).
camera_line_interval (float) – HamamatsuOrca line interval duration (s).
full_chip_exposure time (float) – Full chip exposure time (s).
- calculate_readout_time() → float
Get the duration of time needed to read out an image.
- Returns:
readout_time – Duration of time needed to read out an image.
- Return type:
float
- close_camera() → None
Close HamamatsuOrca Camera
- close_image_series() → None
Close image series.
Stops the acquisition and sets is_acquiring flag to False.
- classmethod connect(camera_id: str) → navigate.model.devices.APIs.hamamatsu.HamamatsuAPI.DCAM
Connect to HamamatsuOrca camera.
- Parameters:
camera_id (int) – Camera ID.
- Returns:
camera_controller – Camera controller object.
- Return type:
object
- generate_new_frame() → None
- get_advanced_setting_capabilities() → dict[str, navigate.model.devices.camera.format.CameraSettingCapability]
Discover precision, restoring an idle MONO8 probe before returning.
DCAM can hide MONO16 precision choices while MONO8 is selected. Only that state requires a temporary pixel-type change, with exact rollback. Acquiring, failed-restoration and coupled Lightning cameras never probe.
- get_bit_depth() → Optional[int]
Read the SDK’s meaningful output depth, leaving missing values unknown.
- get_image_format() → CameraImageFormat
Return the cached normalized format without issuing SDK calls.
- get_line_interval() → float
Get HamamatsuOrca line interval.
- Returns:
line_interval_time – Line interval duration.
- Return type:
float
- get_new_frame() → list[int]
Get frame from HamamatsuOrca camera.
- Returns:
frame_ids – Frame ids from HamamatsuOrca camera.
- Return type:
list[int]
- get_offset_variance_maps() → Any
Get offset and variance maps from file.
- Returns:
offset (np.ndarray) – Offset map.
variance (np.ndarray) – Variance map.
- Raises:
FileNotFoundError – If offset or variance map is not found.
- get_temperature() → float
Get camera cooling temperature.
- Returns:
temperature – Camera cooling temperature in Celsius.
- Return type:
float
- initialize_image_series(data_buffer: Optional[list] = None, number_of_frames: int = 100) → None
Initialize HamamatsuOrca image series.
- Parameters:
data_buffer – List of SharedNDArrays of shape=(self.img_height, self.img_width) and dtype=”uint16” Default is None.
number_of_frames (int) – Number of frames. Default is 100.
- report_settings() → None
Print Camera Settings.
Prints the current camera settings to the console and the log file.
- set_ROI(roi_width: int = 2048, roi_height: int = 2048, center_x: int = 1024, center_y: int = 1024) → bool
Change the size of the active region on the camera.
- Parameters:
roi_width (int) – Width of active camera region.
roi_height (int) – Height of active camera region.
center_x (int) – X position of the center of view
center_y (int) – Y position of the center of view
- Returns:
result – True if successful, False otherwise.
- Return type:
bool
- set_ROI_and_binning(roi_width: int = 2048, roi_height: int = 2048, center_x: int = 1024, center_y: int = 1024, binning: str = '1x1') → bool
Change the size of the active region on the camera and set the binning mode.
- Parameters:
roi_width (int) – Width of active camera region.
roi_height (int) – Height of active camera region.
center_x (int) – X position of the center of view
center_y (int) – Y position of the center of view
binning (str) – Desired binning properties (e.g., ‘1x1’, ‘2x2’, ‘4x4’, ‘8x8’, ‘16x16’, ‘1x2’, ‘2x4’)
- Returns:
result – True if successful, False otherwise.
- Return type:
bool
- set_binning(binning_string: str) → bool
Set HamamatsuOrca binning mode.
- Parameters:
binning_string (str) – Desired binning properties (e.g., ‘1x1’, ‘2x2’, ‘4x4’, ‘8x8’, ‘16x16’, ‘1x2’, ‘2x4’)
- Returns:
result – True if successful, False otherwise.
- Return type:
bool
- set_bit_depth(bit_depth: int) → int
Apply an idle-only depth change with exact readback and rollback.
- Parameters:
bit_depth (int) – An SDK-advertised precision supported by the normalized image format.
- Returns:
Confirmed operating precision.
- Return type:
int
- set_cooling(cooling: str) → None
Set camera cooling mode and temperature.
- Parameters:
cooling (str) – ‘On’ or ‘Off’
- set_exposure_time(exposure_time: float) → bool
Set HamamatsuOrca exposure time.
Note
Units of the Hamamatsu API are in seconds.
- Parameters:
exposure_time (float) – Exposure time in seconds.
- Returns:
result – True if successful, False otherwise.
- Return type:
bool
- set_line_interval(line_interval_time: float) → bool
Set HamamatsuOrca line interval.
- Parameters:
line_interval_time (float) – Line interval duration.
- Returns:
result – True if successful, False otherwise.
- Return type:
bool
- set_readout_direction(mode: str) → None
Set HamamatsuOrca readout direction.
- Parameters:
mode (str) – ‘Top-to-Bottom’, ‘Bottom-to-Top’, ‘bytrigger’, or ‘diverge’.
- set_sensor_mode(mode: str) → None
Set HamamatsuOrca sensor mode.
- Parameters:
mode (str) – ‘Normal’ or ‘Light-Sheet’
- set_trigger_mode(trigger_source: str = 'External') → None
Set Hamamatsu trigger source and trigger mode.
- Parameters:
trigger_source (str) – Trigger source: “External” or “Internal”. Default is “External”.
- camera_controller
Hardware device to connect to
- Type:
object
- camera_parameters
Camera parameters
- Type:
dict
- configuration
Configuration settings
- Type:
dict
- configuration_schema = {'defect_correct_mode': SettingSpec(value_type=<class 'float'>, default=1.0, label='Defect Correct Mode', help_text="Enable the camera's pixel-defect correction. Use 1.0 for Off or 2.0 for On.", choices=(1.0, 2.0), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None)}
- device_connection
Device connection
- Type:
object
- is_acquiring
Whether the camera is currently acquiring
- Type:
bool
- microscope_name
Name of the microscope
- Type:
str
- min_image_height
Minimum image height
- Type:
int
- min_image_width
Minimum image width
- Type:
int
- minimum_exposure_time
minimum exposure time
- Type:
float
- property offset: Any
Return offset map. If not present, load from file.
- Returns:
offset – Offset map.
- Return type:
np.ndarray
- property serial_number: str
Get Camera Serial Number
- Returns:
serial_number – Serial number for the camera.
- Return type:
str
- step_image_height
Minimum step size for image height.
- Type:
int
- step_image_width
Minimum step size for image width.
- Type:
int
- property variance: Any
Return variance map. If not present, load from file.
- Returns:
variance – Variance map.
- Return type:
np.ndarray
- x_pixels
Number of pixels in the x direction
- Type:
int
- y_pixels
Number of pixels in the y direction
- Type:
int