Reference#

Below is the API reference for the DEAPI package. The Client class is the main entry point for communication with the DE Server. Also included are classes acting as containers for data and metadata!

Classes

Client()

A class for connecting to the DE-Server

Helper Classes

VirtualMask(client, index)

Class to interact with virtual masks in the DE API

PropertyCollection(client, name, properties)

Class to interact with collections of properties in the DE API

Attributes([center_x, center_y, zoom, ...])

Class to hold attributes for getting the result of an image acquisition

PropertySpec([data_type, value_type, ...])

Class to hold the specification of a property in the DE API

FrameType(value[, names, module, qualname, ...])

An Enum of the different frame types that can be returned by the DE API

PixelFormat(value[, names, module, ...])

An Enum describing the pixel format of the image data returned by the DE API

DataType(value[, names, module, qualname, ...])

An Enum describing the data type of the image data returned by the DE API

MovieBufferInfo([headerBytes, ...])

Structure to hold information about the movie buffer

MovieBufferStatus(value[, names, module, ...])

An Enum describing the status of the movie buffer in the DE API

Histogram([min, max, ...])

Class to hold the histogram data from an image acquisition

Fake Data Generation

fake_data

Classes for dealing with Fake Data generation.

This Page