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(propertyName)	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([pixelFormat, fileName, ...])	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(propertyName)	Get the value of a property of the current camera on DE-Server
Client.get_property_spec(propertyName)	Get a list of allowed values for a property of the current camera on DE-Server
Client.get_result([frameType, pixelFormat, ...])	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.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.property_valid_values(propertyName)	Get a list of allowed values for a property of the current camera on DE-Server
Client.save_image(image, fileName[, textSize])
Client.setEngMode(**kwargs)
Client.setEngModeAndGetChangedProperties(...)
Client.setProperty(**kwargs)
Client.set_client_read_only(read_only)
Client.set_current_camera(**kwargs)
Client.set_engineering_mode(**kwargs)
Client.set_hw_roi(**kwargs)
Client.set_hw_roi_and_get_changed_properties(...)
Client.set_log_level(level)
Client.set_property(**kwargs)
Client.set_property_and_get_changed_properties(...)
Client.set_sw_roi(**kwargs)
Client.set_sw_roi_and_get_changed_properties(...)
Client.set_virtual_mask(**kwargs)
Client.set_xy_array(**kwargs)
Client.start_acquisition(**kwargs)
Client.stop_acquisition(**kwargs)
Client.take_dark_reference(**kwargs)
Client.update_image_size()
Client.update_scan_size()
Client.wait_for_saving_files([quiet])	Wait for the saving files to complete

Examples using Client

Viewing Sensor Data During Acquisition

Viewing Sensor Data During Acquisition

Setting up a STEM Experiment

Setting up a STEM Experiment

Creating a Custom Virtual Mask

Creating a Custom Virtual Mask

Virtual Dark/Bright Field (VDF/VBF) Imaging

Virtual Dark/Bright Field (VDF/VBF) Imaging