Hamamatsu Model

Model class for controlling Hamamatsu cameras via de DCAM-API. At the time of writing this class, little documentation on the DCAM-API was available. Hamamatsu has a different time schedule regarding support of their own API. However, Zhuang’s lab Github repository had a python driver for the Orca camera and with a bit of tinkering things worked out.

DCAM-API relies mostly on setting parameters into the camera. The correct data type of each parameter is not well documented; however it is possible to print all the available properties and work from there. The properties are stored in a filed named params.txt next to the Hamamatsu Driver

Note

When setting the ROI, Hamamatsu only allows to set multiples of 4 for every setting (X,Y and vsize, hsize). This is checked in the function. Changing the ROI cannot be done directly, one first needs to disable it and then re-enable.

copyright

Aquiles Carattino <aquiles@uetke.com>

license

GPLv3, see LICENSE for more details

class pynta.model.cameras.hamamatsu.Camera(camera)[source]

Bases: pynta.model.cameras.base_camera.BaseCamera

GetCCDHeight()[source]

Returns The CCD height in pixels

GetCCDWidth()[source]

Returns The CCD width in pixels

MODE_CONTINUOUS = 1
MODE_EXTERNAL = 2
MODE_SINGLE_SHOT = 0
acquisition_ready()[source]

Checks if the acquisition in the camera is over.

getSerialNumber()[source]

Returns the serial number of the camera.

get_acquisition_mode()[source]

Returns the acquisition mode, either continuous or single shot.

get_exposure()[source]

Gets the exposure time of the camera.

get_size()[source]

Returns the size in pixels of the image being acquired. This is useful for checking the ROI settings.

initialize()[source]

Initializes the camera.

Returns

read_camera()[source]

Reads the camera

set_ROI(X, Y)[source]

Sets up the ROI. Not all cameras are 0-indexed, so this is an important place to define the proper ROI. X – array type with the coordinates for the ROI X[0], X[1] Y – array type with the coordinates for the ROI Y[0], Y[1]

set_acquisition_mode(mode)[source]

Set the readout mode of the camera: Single or continuous. Parameters mode : int One of self.MODE_CONTINUOUS, self.MODE_SINGLE_SHOT

set_exposure(exposure)[source]

Sets the exposure of the camera.

stopAcq()[source]

Stops the acquisition without closing the connection to the camera.

stop_camera()[source]

Stops the acquisition and closes the connection with the camera.

trigger_camera()[source]

Triggers the camera.