API Reference v9.1.0

CameraTriggerclass

Module: zaber_motion.microscopy

An abstraction over a device and it's digital output channel.

The following examples illustrate how you can obtain an instance of this type:

Example 1

Example 2

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import Microscope

connection = Connection.open_serial_port('COM3')
microscope = Microscope.find(connection)
camera_trigger = microscope.camera_trigger

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import CameraTrigger

connection = Connection.open_serial_port('COM3')
device = connection.get_device(1)
camera_trigger = CameraTrigger(device, 1)

Index

pProperties

mMethods

Constructor

CameraTrigger(device, channel)

Creates instance of `CameraTrigger` based on the given device and digital output channel.

Arguments

Name	Type	Description
device	`Device`	The device whose digital output triggers the camera.
channel	`int`	The digital output channel that triggers the camera.

Properties

p

channel

readonly

camera_trigger.channel

int The digital output channel that triggers the camera.

p

device

readonly

camera_trigger.device

Device The device whose digital output triggers the camera.

Methods

m

repr()

camera_trigger.__repr__()

Returns a string that represents the device.

Return Value

str A string that represents the device.

m

trigger()

async available

camera_trigger.trigger(pulse_width, unit = Units.NATIVE, wait = True)

Triggers the camera. Schedules trigger pulse on the digital output channel. By default, the method waits until the trigger pulse is finished.

Arguments

Name	Type	Description
pulse_width	`float`	The time duration of the trigger pulse. Depending on the camera setting, the argument can be use to specify exposure.
unit	`TimeUnits`	Units of time.
wait	`bool`	If false, the method does not wait until the trigger pulse is finished.