slmsuite.hardware.cameras.template.Template

class Template(serial='', verbose=True, **kwargs)

Bases: Camera

Template for adding a new camera to slmsuite. Replace Template with the desired subclass name. Camera is the superclass that sets the requirements for Template.

sdk

Many cameras have a singleton SDK class which handles all the connected cameras of a certain brand. This is generally implemented as a class variable.

Type

object

cam

Most cameras will wrap some handle which connects to the the hardware.

Type

object

Methods

autoexposure	Sets the exposure of the camera such that the maximum value is at set_fraction of the dynamic range.
autofocus	Uses an FFT contrast metric to find optimal focus when scanning over some variable z.
close	See Camera.close().
flush	See Camera.flush().
get_exposure	See Camera.get_exposure().
get_image	See Camera.get_image().
get_images	Grab image_count images in succession.
info	Discovers all cameras detected by the SDK.
reset	Abstract method to reset the camera to a default state.
set_exposure	See Camera.set_exposure().
set_woi	See Camera.set_woi().

Attributes

sdk

__init__(serial='', verbose=True, **kwargs)

Initialize camera and attributes.

Parameters

• serial (str) – Most SDKs identify different cameras by some serial number or string.

• verbose (bool) – Whether or not to print extra information.

• kwargs – See Camera.__init__() for permissible options.

close()

See Camera.close().

static info(verbose=True)

Discovers all cameras detected by the SDK. Useful for a user to identify the correct serial numbers / etc.

Parameters

verbose (bool) – Whether to print the discovered information.

Returns

List of serial numbers or identifiers.

Return type

list of str

get_exposure()

See Camera.get_exposure().

set_exposure(exposure_s)

See Camera.set_exposure().

set_woi(woi=None)

See Camera.set_woi().

get_image(timeout_s=1)

See Camera.get_image().

flush()

See Camera.flush().

autoexposure(set_fraction=0.5, tol=0.05, exposure_bounds_s=None, window=None, average_count=5, timeout_s=5, verbose=True)

Sets the exposure of the camera such that the maximum value is at set_fraction of the dynamic range. Useful for mitigating deleterious over- or under- exposure.

Parameters

• set_fraction (float) – Fraction of camera dynamic range to target image maximum.

• tol (float) – Fractional tolerance for exposure adjustment.

• exposure_bounds_s ((float, float) OR None) – Shortest and longest allowable integration in seconds. If None, defaults to exposure_bounds_s. If this attribute was not set (or not availible on a particular camera), then None instead defaults to unbounded.

• window (array_like or None) – See window. If None, the full camera frame will be used.

• average_count (int) – Number of frames to average intensity over for noise reduction.

• timeout_s (float) – Stop attempting to autoexpose after timeout_s seconds.

• verbose (bool) – Whether to print exposure updates.

Returns

Resulting exposure in seconds.

Return type

float

autofocus(z_get, z_set, z_list=None, plot=False)

Uses an FFT contrast metric to find optimal focus when scanning over some variable z. This z often takes the form of a vertical stage to position a sample precisely at the plane of imaging of a lens or objective. The contrast metric works particularly well when combined with a projected spot array hologram.

Parameters

• z_get (lambda) – Gets the current position of the focusing stage. Should return a float.

• z_set (lambda) – Sets the position of the focusing stage to a given float.

• z_list (array_like or None) – z values to sweep over during search. Defaults (when None) to numpy.linspace(-4,4,16).

• plot (bool) – Whether to provide illustrative plots.

get_images(image_count, flush=False)

Grab image_count images in succession. Overwrite this implementation if a camera supports faster batch acquisition.

Parameters

• image_count (int) – Number of images to grab.

• flush (bool) – Whether to flush before grabbing.

Returns

Array of shape (image_count, height, width).

Return type

numpy.ndarray

reset()

Abstract method to reset the camera to a default state.