Client#

class deapi.Client#

Bases: object

A class for connecting to the DE-Server

Examples

>>> client = Client()
>>> client.connect()
>>> client["Exposure Time (seconds)"]

Attributes

`Client.acquiring`	Check if the camera is currently acquiring images.
`Client.cameras`
`Client.connected`
`Client.currCamera`
`Client.debugImagesFolder`
`Client.exposureTime`
`Client.height`
`Client.host`
`Client.mmf`
`Client.port`
`Client.read_only`
`Client.refreshProperties`
`Client.usingMmf`
`Client.width`

Methods

`Client.connect`([host, port, read_only])	Connect to DE-Server
`Client.current_movie_buffer`()
`Client.disconnect`()	Disconnects from the server.
`Client.getProperty`(property_name)	Get the value of a property of the current camera on DE-Server
`Client.get_current_camera`()	Get the current camera on the server.
`Client.get_current_info`()
`Client.get_image`([frame_type, pixel_format, ...])	Get a single image and save it to disk if a file name is provided
`Client.get_movie_buffer`(movieBuffer, ...[, ...])	Get the movie buffer of the current camera on DE-Server.
`Client.get_movie_buffer_info`([...])	Get the movie buffer information of the current camera on DE-Server.
`Client.get_properties`([names])
`Client.get_property`(property_name)	Get the value of a property of the current camera on DE-Server
`Client.get_property_spec`(property_name)	Get a list of allowed values for a property of the current camera on DE-Server Deprecated since DE-MC 2.7.4
`Client.get_property_specifications`(property_name)	Get a list of allowed values for a property of the current camera on DE-Server Only works for DE-MC version greater or equal to 2.7.4
`Client.get_register`(register_name)	Get the value of a register of the current camera on DE-Server
`Client.get_result`([frame_type, ...])	Get the specified type of frames in the desired pixel format and associated information.
`Client.get_server_version`()	Get the server software version
`Client.get_time`()	Get the current time from the system clock
`Client.get_virtual_mask`(index)
`Client.grab`([frames, dataSetName, fileName])	Grab specified number of frames and print out stats.
`Client.gui`()
`Client.list_cameras`()	List the available cameras on the server.
`Client.list_properties`([options, search])	Get a list of property names from the current camera on DE-Server
`Client.list_registers`([options, search])	Get a list of register names from the current camera on DE-Server for each register, it contains attributes: name of the register, address, Read only, value of the register
`Client.print_acquisition_info`()	Print out the acquisition information
`Client.print_saving_info`()	Print out the saving information
`Client.print_server_info`([camera])	Print out the server information
`Client.save_image`(image, fileName[, textSize])
`Client.setEngMode`(enable, password)	Set the engineering mode of the current camera on DE-Server.
`Client.setEngModeAndGetChangedProperties`(...)
`Client.setProperty`(name, value)	Set the value of a property of the current camera on DE-Server
`Client.setROI`(offsetX, offsetY, sizeX, sizeY)	Set the region of interest (ROI) of the current camera on DE-Server.
`Client.set_adaptive_roi`(size_x, size_y[, ...])	Automatically choose the proper HW ROI and set SW ROI of the current camera on DE-Server.
`Client.set_adaptive_roi_and_get_changed_properties`(...)	Automatically choose the proper HW ROI and set SW ROI of the current camera on DE-Server and get all of the changed properties.
`Client.set_binning`(bin_x, bin_y[, use_hw])	Set the binning of the current camera on DE-Server.
`Client.set_client_read_only`(read_only)
`Client.set_current_camera`([camera_name])	Set the current camera on the server.
`Client.set_engineering_mode`(enable, password)	Set the engineering mode of the current camera on DE-Server.
`Client.set_hw_roi`(offset_x, offset_y, ...)	Set the hardware region of interest (ROI) of the current camera on DE-Server.
`Client.set_hw_roi_and_get_changed_properties`(...)	Set the hardware region of interest (ROI) of the current camera on DE-Server and get all the changed properties.
`Client.set_log_level`(level)
`Client.set_property`(name, value)	Set the value of a property of the current camera on DE-Server
`Client.set_property_and_get_changed_properties`(...)	Set the value of a property of the current camera on DE-Server and get all the changed properties.
`Client.set_register`(name, value)	Set the value of a register of the current camera on DE-Server
`Client.set_sw_roi`(offsetX, offsetY, sizeX, sizeY)	Set the software region of interest (ROI) of the current camera on DE-Server.
`Client.set_sw_roi_and_get_changed_properties`(...)	Set the software region of interest (ROI) of the current camera on DE-Server and get all of the changed properties.
`Client.set_virtual_mask`(id, w, h, mask)	Set the virtual mask of the current camera on DE-Server.
`Client.set_xy_array`(positions[, width, height])	Set the scan array for a set of x,y positions.
`Client.start_acquisition`([...])	Start acquiring images.
`Client.start_manual_final_saving`()	Start saving movie during acquisition.
`Client.start_manual_movie_saving`()	Start saving movie during acquisition.
`Client.stop_acquisition`()	Stop acquiring images.
`Client.stop_manual_final_saving`()	Stop saving movie during acquisition.
`Client.stop_manual_movie_saving`()	Stop saving movie during acquisition.
`Client.take_dark_reference`([frame_rate, ...])	Take dark reference images.
`Client.take_gain_reference`(frame_rate[, ...])	Take a gain reference.
`Client.take_trial_gain_reference`([...])	Take a trial gain reference.
`Client.update_image_size`()
`Client.update_scan_size`()
`Client.wait_for_saving_files`([quiet])	Wait for the saving files to complete