PYME.Acquire.protocol module

PYME.Acquire.protocol.C

alias of PreflightCheckItem

PYME.Acquire.protocol.Ex(str)

class PYME.Acquire.protocol.PreflightCheckItem(check, message)

Bases: object

class PYME.Acquire.protocol.Protocol(filename=None)

Bases: object

Init(spooler)

OnFinish()

OnFrame(frameNum)

PreflightCheck()

PYME.Acquire.protocol.SetCameraShutter(open)

PYME.Acquire.protocol.SetContinuousMode(contMode)

PYME.Acquire.protocol.SetEMGain(emGain)

PYME.Acquire.protocol.SetIntegTime(iTime)

PYME.Acquire.protocol.T

alias of TaskListTask

class PYME.Acquire.protocol.TaskListProtocol(taskList, metadataEntries=[], preflightList=[], filename=None)

Bases: Protocol

Init(spooler)

OnFinish()

OnFrame(frameNum)

PreflightCheck()

class PYME.Acquire.protocol.TaskListTask(when, what, *withParams)

Bases: object

class PYME.Acquire.protocol.ZStackTaskListProtocol(taskList, startFrame, dwellTime, metadataEntries=[], preflightList=[], randomise=False, slice_order='saw', require_camera_restart=True, filename=None)

Bases: TaskListProtocol

Parameters

taskList: list

List of tasks

startFrame: int

Frame to begin acquisition

dwellTime: int

Number of frames to spent on each step

metadataEntries: list

List of metadata entries to propagate through spooling

preflightList: list

List of tasks to perform before starting, i.e. before frame zero

randomise: bool

Deprecated, use slice_order=’random’ instead

slice_order: str

Setting for reordering z steps.

‘saw’: standard z-step moving linearly from one extreme to the other ‘random’: acquire z steps in a random order ‘triangle’: acquire z-steps in an up-then-down or down-then-up fashion like a triangle waveform

require_camera_restart: bool

Flag to toggle restarting the camera/frameWrangler on each step (True) or leave the camera running (False)

Init(spooler)

OnFinish()

OnFrame(frameNum)

PYME.Acquire.protocol.get_protocol(protocol_name, reloadProtocol=True)

PYME.Acquire.protocol.get_protocol_list()