PYME.Acquire.stackSettings module

class PYME.Acquire.stackSettings.StackSettings(scope, **kwargs)

Bases: object

A class to keep settings for acquiring z-stacks

Create a stack settings object.

NB - extra args map 1:1 to stack metadata entries. Start and end pos are ignored if ScanMode = ‘Middle and Number’

Parameters
scope
ScanMode
StartPos
EndPos
StepSize
NumSlices
ScanPiezo
BACKWARDS = -1
CENTRE_AND_LENGTH = 0
DEFAULTS = {'DwellFrames': -1, 'EndPos': 0, 'NumSlices': 100, 'ScanMode': 'Middle and Number', 'ScanPiezo': 'z', 'StartPos': 0, 'StepSize': 0.2}
FORWARDS = 1
GetDirection()
GetEndPos()
GetPrevPos()
GetScanChannel()
GetSeqLength()
GetStartMode()
GetStartPos()
GetStepSize()
OBJECT = 0
PHASE = 1
ProvideStackMetadata(mdh)
SCAN_MODES = ['Middle and Number', 'Start and End']
START_AND_END = 1
SetDirection(dir)

Fowards = 1, backwards = -1

SetEndPos(ePos)
SetPrevPos(sPos)
SetScanChannel(iMode)
SetSeqLength(iLength)
SetStartMode(iMode)
SetStartPos(sPos)
SetStepSize(fSize)
Verify()
doStartLog()
doStopLog()
piezoGoHome()
settings()
settings_longpoll()
update(ScanMode=None, StartPos=None, EndPos=None, StepSize=None, NumSlices=None, ScanPiezo=None, DwellFrames=None)
update_json(body)