Concrete implementation for Ximea camera

Xiseq file parser (pymanip.video.ximea.xiseq)

class pymanip.video.ximea.xiseq.XiseqFile(filepath)

Simple parser for Ximea Xiseq file.

Parameters

filepath (Path or str) – path to file

files()

Iterate through files in sequence. Yields a dictionnary with keys timestamp, frame and filename.

Ximea Camera module (pymanip.video.ximea.camera)

This module implements the pymanip.video.ximea.Ximea_Camera using the Python module provided by Ximea.

class pymanip.video.ximea.camera.Ximea_Camera(serial_number=None, pixelFormat=None)

Bases: Camera

Concrete pymanip.video.Camera class for Ximea camera.

async acquisition_async(num=inf, timeout=None, raw=False, initialising_cams=None, raise_on_timeout=True, wait_before_stopping=None)

Concrete implementation of pymanip.video.Camera.acquisition_async() for the Ximea camera.

timeout in milliseconds.

Parameters

• raw (bool (optional)) – if True, returns the XI_IMG object instead of a numpy array.

• wait_before_stopping (async function (optional)) – async function to be awaited before stopping the acquisition_async

close()

Close connection to the camera

get_exposure_time()

This method gets the exposure time in seconds for the camera.

async get_image(loop, image, timeout=5000)

Asynchronous version of xiapi.Camera.get_image method This function awaits for next image to be available in transport buffer. Color images are in BGR order (similar to OpenCV default). Attention: matplotlib expects RGB order.

Parameters

• image (xiapi.Image) – Image instance to copy image to

• timeout (int) – timeout in milliseconds

get_roi()

Get ROI

get_trigger_mode()

Returns True if external, False if software

property name

Camera name

set_auto_white_balance(toggle)

Enable/Disable auto white balance

Parameters

toggle (bool) – True if auto white balance

set_downsampling(binning)

Change image resolution by binning

set_exposure_time(seconds)

This method sets the exposure time for the camera.

Parameters

seconds (float) – exposure in seconds.

set_frame_rate(framerate_fps)

Sets the framerate in frames per seconds

set_limit_bandwidth(limit)

Enable limit bandwidth (useful if there are several cameras acquiring simultaneously).

set_roi(roiX0=0, roiY0=0, roiX1=0, roiY1=0)

This method sets the positions of the upper left corner (X0,Y0) and lower right (X1,Y1) corner of the ROI (region of interest) in pixels.

set_trigger_mode(external)

Set external trigger (edge rising).

set_vertical_skipping(factor)

Set vertical skipping

xidngFillMetadataFromCameraParams()

Fills entire metadata structure with current camera parameter values obtained from xiGetParam calls.

xidngStore(filename, img, camera_metadata)

Saves the image into the file in DNG image file format. Does not support images in planar RGB and Transport formats.