magscope.ipc_commands

magscope.ipc_commands#

Classes#

`Command`	Typed IPC payload sent between processes.
`QuitCommand`	Request that all manager processes exit.
`SetSettingsCommand`	Typed IPC payload sent between processes.
`UpdateSettingsCommand`	Typed IPC payload sent between processes.
`UpdateTrackingOptionsCommand`	Typed IPC payload sent between processes.
`SetAcquisitionOnCommand`	Typed IPC payload sent between processes.
`WaitUntilAcquisitionOnCommand`	Typed IPC payload sent between processes.
`SetAcquisitionDirOnCommand`	Typed IPC payload sent between processes.
`SetAcquisitionModeCommand`	Typed IPC payload sent between processes.
`SetAcquisitionDirCommand`	Typed IPC payload sent between processes.
`UpdateBeadRoisCommand`	Typed IPC payload sent between processes.
`LogExceptionCommand`	Typed IPC payload sent between processes.
`StartupReadyCommand`	Typed IPC payload sent between processes.
`UpdateCameraSettingCommand`	Typed IPC payload sent between processes.
`SetSimulatedFocusCommand`	Typed IPC payload sent between processes.
`MoveFocusMotorAbsoluteCommand`	Typed IPC payload sent between processes.
`RequestFocusMotorLimitsCommand`	Typed IPC payload sent between processes.
`ReportFocusMotorLimitsCommand`	Typed IPC payload sent between processes.
`UpdateVideoBufferPurgeCommand`	Typed IPC payload sent between processes.
`MoveBeadsCommand`	Typed IPC payload sent between processes.
`AddRandomBeadsCommand`	Typed IPC payload sent between processes.
`UpdateXYLockEnabledCommand`	Typed IPC payload sent between processes.
`UpdateXYLockIntervalCommand`	Typed IPC payload sent between processes.
`UpdateXYLockMaxCommand`	Typed IPC payload sent between processes.
`UpdateXYLockWindowCommand`	Typed IPC payload sent between processes.
`UpdateZLockEnabledCommand`	Typed IPC payload sent between processes.
`UpdateZLockBeadCommand`	Typed IPC payload sent between processes.
`UpdateZLockTargetCommand`	Typed IPC payload sent between processes.
`UpdateZLockIntervalCommand`	Typed IPC payload sent between processes.
`UpdateZLockMaxCommand`	Typed IPC payload sent between processes.
`UpdateZLockWindowCommand`	Typed IPC payload sent between processes.
`UpdateScriptStatusCommand`	Typed IPC payload sent between processes.
`UpdateScriptStepCommand`	Report the currently executing script step to the GUI.
`ShowMessageCommand`	Typed IPC payload sent between processes.
`ShowErrorCommand`	Typed IPC payload sent between processes.
`UpdateZLUTMetadataCommand`	Typed IPC payload sent between processes.
`LoadZLUTCommand`	Typed IPC payload sent between processes.
`UnloadZLUTCommand`	Clear the currently loaded Z-LUT.
`StartZLUTGenerationCommand`	Typed IPC payload sent between processes.
`CancelZLUTGenerationCommand`	Typed IPC payload sent between processes.
`UpdateZLUTGenerationStateCommand`	Typed IPC payload sent between processes.
`UpdateZLUTGenerationProgressCommand`	Typed IPC payload sent between processes.
`UpdateZLUTGenerationEvaluationCommand`	Typed IPC payload sent between processes.
`SelectGeneratedZLUTBeadCommand`	Typed IPC payload sent between processes.
`SaveGeneratedZLUTCommand`	Typed IPC payload sent between processes.
`CancelGeneratedZLUTEvaluationCommand`	Typed IPC payload sent between processes.
`RequestProfileLengthCommand`	Typed IPC payload sent between processes.
`ReportProfileLengthCommand`	Typed IPC payload sent between processes.
`RequestZLUTProfileLengthCommand`	Typed IPC payload sent between processes.
`ReportZLUTProfileLengthCommand`	Typed IPC payload sent between processes.
`ClearPendingZLUTProfileLengthCommand`	Typed IPC payload sent between processes.
`ArmZLUTSweepCaptureCommand`	Typed IPC payload sent between processes.
`DisarmZLUTSweepCaptureCommand`	Typed IPC payload sent between processes.
`ZLUTSweepCaptureCompleteCommand`	Typed IPC payload sent between processes.
`RemoveBeadFromPendingMovesCommand`	Typed IPC payload sent between processes.
`RemoveBeadsFromPendingMovesCommand`	Typed IPC payload sent between processes.
`SetXYLockOnCommand`	Typed IPC payload sent between processes.
`ExecuteXYLockCommand`	Typed IPC payload sent between processes.
`ExecuteZLockCommand`	Request the Z-Lock manager to perform one correction cycle.
`SetXYLockIntervalCommand`	Typed IPC payload sent between processes.
`SetXYLockMaxCommand`	Typed IPC payload sent between processes.
`SetXYLockWindowCommand`	Typed IPC payload sent between processes.
`SetZLockOnCommand`	Typed IPC payload sent between processes.
`SetZLockBeadCommand`	Typed IPC payload sent between processes.
`SetZLockTargetCommand`	Typed IPC payload sent between processes.
`SetZLockIntervalCommand`	Typed IPC payload sent between processes.
`SetZLockMaxCommand`	Typed IPC payload sent between processes.
`SetZLockWindowCommand`	Typed IPC payload sent between processes.
`GetCameraSettingCommand`	Typed IPC payload sent between processes.
`SetCameraSettingCommand`	Typed IPC payload sent between processes.
`LoadScriptCommand`	Typed IPC payload sent between processes.
`StartScriptCommand`	Start the currently loaded script.
`PauseScriptCommand`	Pause the running script.
`ResumeScriptCommand`	Resume a paused script.
`SleepCommand`	Typed IPC payload sent between processes.
`UpdateWaitingCommand`	Signal that a wait condition has been satisfied.

Module Contents#

class magscope.ipc_commands.Command[source]#: Typed IPC payload sent between processes.

class magscope.ipc_commands.QuitCommand[source]#

Bases: Command

Request that all manager processes exit.

class magscope.ipc_commands.SetSettingsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

settings: magscope.settings.MagScopeSettings[source]#

class magscope.ipc_commands.UpdateSettingsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

settings: magscope.settings.MagScopeSettings[source]#

class magscope.ipc_commands.UpdateTrackingOptionsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: dict[source]#

class magscope.ipc_commands.SetAcquisitionOnCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.WaitUntilAcquisitionOnCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.SetAcquisitionDirOnCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.SetAcquisitionModeCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

mode: magscope.utils.AcquisitionMode[source]#

class magscope.ipc_commands.SetAcquisitionDirCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: str | None[source]#

class magscope.ipc_commands.UpdateBeadRoisCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.LogExceptionCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

process_name: str[source]#

details: str[source]#

class magscope.ipc_commands.StartupReadyCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

process_name: str = 'UIManager'[source]#

class magscope.ipc_commands.UpdateCameraSettingCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

name: str[source]#

value: str[source]#

class magscope.ipc_commands.SetSimulatedFocusCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

offset: float[source]#

class magscope.ipc_commands.MoveFocusMotorAbsoluteCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

z: float[source]#

class magscope.ipc_commands.RequestFocusMotorLimitsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.ReportFocusMotorLimitsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

z_min: float[source]#

z_max: float[source]#

class magscope.ipc_commands.UpdateVideoBufferPurgeCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

t: float[source]#

class magscope.ipc_commands.MoveBeadsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

moves: list[tuple[int, int, int]][source]#

class magscope.ipc_commands.AddRandomBeadsCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

count: int[source]#

seed: int | None = None[source]#

class magscope.ipc_commands.UpdateXYLockEnabledCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.UpdateXYLockIntervalCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.UpdateXYLockMaxCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.UpdateXYLockWindowCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.UpdateZLockEnabledCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.UpdateZLockBeadCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.UpdateZLockTargetCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float | None[source]#

class magscope.ipc_commands.UpdateZLockIntervalCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.UpdateZLockMaxCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.UpdateZLockWindowCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.UpdateScriptStatusCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

status: magscope.scripting.ScriptStatus[source]#

class magscope.ipc_commands.UpdateScriptStepCommand[source]#

Bases: Command

Report the currently executing script step to the GUI.

current_step: int | None[source]#

total_steps: int[source]#

description: str | None[source]#

class magscope.ipc_commands.ShowMessageCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

text: str[source]#

details: str | None = None[source]#

class magscope.ipc_commands.ShowErrorCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

text: str[source]#

details: str | None = None[source]#

class magscope.ipc_commands.UpdateZLUTMetadataCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

filepath: str | None = None[source]#

z_min: float | None = None[source]#

z_max: float | None = None[source]#

step_size: float | None = None[source]#

profile_length: int | None = None[source]#

class magscope.ipc_commands.LoadZLUTCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

filepath: str[source]#

class magscope.ipc_commands.UnloadZLUTCommand[source]#

Bases: Command

Clear the currently loaded Z-LUT.

class magscope.ipc_commands.StartZLUTGenerationCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

start_nm: float[source]#

step_nm: float[source]#

stop_nm: float[source]#

profiles_per_bead: int[source]#

class magscope.ipc_commands.CancelZLUTGenerationCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.UpdateZLUTGenerationStateCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

status: str[source]#

detail: str | None = None[source]#

running: bool = False[source]#

can_cancel: bool = False[source]#

phase: str = 'idle'[source]#

z_axis_min_nm: float | None = None[source]#

z_axis_max_nm: float | None = None[source]#

z_axis_descending: bool = False[source]#

class magscope.ipc_commands.UpdateZLUTGenerationProgressCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

current_step: int[source]#

total_steps: int[source]#

capture_count: int[source]#

capture_capacity: int[source]#

motor_z_value: float | None = None[source]#

class magscope.ipc_commands.UpdateZLUTGenerationEvaluationCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

active: bool[source]#

bead_ids: list[int][source]#

selected_bead_id: int | None = None[source]#

class magscope.ipc_commands.SelectGeneratedZLUTBeadCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

bead_id: int[source]#

class magscope.ipc_commands.SaveGeneratedZLUTCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

filepath: str[source]#

bead_id: int[source]#

load_after_save: bool = True[source]#

class magscope.ipc_commands.CancelGeneratedZLUTEvaluationCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.RequestProfileLengthCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.ReportProfileLengthCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

profile_length: int | None = None[source]#

class magscope.ipc_commands.RequestZLUTProfileLengthCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

bead_ids: tuple[int, Ellipsis] = ()[source]#

bead_rois: tuple[tuple[int, int, int, int], Ellipsis] = ()[source]#

class magscope.ipc_commands.ReportZLUTProfileLengthCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

profile_length: int | None = None[source]#

class magscope.ipc_commands.ClearPendingZLUTProfileLengthCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.ArmZLUTSweepCaptureCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

step_index: int[source]#

motor_z_value: float[source]#

remaining_profiles_per_bead: int[source]#

earliest_timestamp: float[source]#

bead_ids: tuple[int, Ellipsis] = ()[source]#

bead_rois: tuple[tuple[int, int, int, int], Ellipsis] = ()[source]#

class magscope.ipc_commands.DisarmZLUTSweepCaptureCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

class magscope.ipc_commands.ZLUTSweepCaptureCompleteCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

step_index: int[source]#

written_count: int[source]#

written_profiles_per_bead: int[source]#

error: str | None = None[source]#

class magscope.ipc_commands.RemoveBeadFromPendingMovesCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

id: int[source]#

class magscope.ipc_commands.RemoveBeadsFromPendingMovesCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

ids: list[int][source]#

class magscope.ipc_commands.SetXYLockOnCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.ExecuteXYLockCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

now: float | None = None[source]#

class magscope.ipc_commands.ExecuteZLockCommand[source]#

Bases: Command

Request the Z-Lock manager to perform one correction cycle.

class magscope.ipc_commands.SetXYLockIntervalCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.SetXYLockMaxCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.SetXYLockWindowCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.SetZLockOnCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: bool[source]#

class magscope.ipc_commands.SetZLockBeadCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.SetZLockTargetCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float | None[source]#

class magscope.ipc_commands.SetZLockIntervalCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.SetZLockMaxCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: float[source]#

class magscope.ipc_commands.SetZLockWindowCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

value: int[source]#

class magscope.ipc_commands.GetCameraSettingCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

name: str[source]#

class magscope.ipc_commands.SetCameraSettingCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

name: str[source]#

value: str[source]#

class magscope.ipc_commands.LoadScriptCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

path: str[source]#

class magscope.ipc_commands.StartScriptCommand[source]#

Bases: Command

Start the currently loaded script.

class magscope.ipc_commands.PauseScriptCommand[source]#

Bases: Command

Pause the running script.

class magscope.ipc_commands.ResumeScriptCommand[source]#

Bases: Command

Resume a paused script.

class magscope.ipc_commands.SleepCommand[source]#

Bases: Command

Typed IPC payload sent between processes.

duration: float[source]#

class magscope.ipc_commands.UpdateWaitingCommand[source]#

Bases: Command

Signal that a wait condition has been satisfied.