navigate.model.features.common_features.StackPause

class navigate.model.features.common_features.StackPause(model, pause_num='experiment.MicroscopeState.timepoints')

Bases: object

StackPause class for pausing stack acquisition.

This class provides functionality to pause stack acquisition for a specified number of timepoints or based on a defined pause time. It manages the data thread accordingly.

Notes:

• This class is used to pause stack acquisition for a specified number of timepoints

or based on a defined pause time during microscopy experiments.

• The StackPause class allows for flexible control of stack acquisition pauses,

ensuring synchronization with data acquisition.

• The stack pause control process involves managing the data thread, calculating

pause times, and handling stack acquisition pauses.

• The config_table attribute defines the configuration for the stack pause control

process, specifically the main pause function.

__init__(model, pause_num='experiment.MicroscopeState.timepoints')

Initialize the StackPause class.

Parameters:

modelMicroscopeModel

The microscope model object used for stack acquisition control.

pause_numint or str, optional

The number of timepoints to pause stack acquisition or a configuration reference to determine the pause count dynamically. Default is “experiment.MicroscopeState.timepoints”.

Methods

__init__(model[, pause_num])	Initialize the StackPause class.
signal_func()	Pause stack acquisition based on timepoints or pause time and manage the data thread.

signal_func()

Pause stack acquisition based on timepoints or pause time and manage the data thread.

This method pauses stack acquisition based on the remaining timepoints or defined pause time. It manages the data thread accordingly during the pause.