navigate.model.features.common_features.MoveToNextPositionInMultiPositionTable

class navigate.model.features.common_features.MoveToNextPositionInMultiPositionTable(model, resolution_value=None, zoom_value=None, offset=None)

Bases: object

MoveToNextPositionInMultiPositionTable class for advancing in a multi-position table.

This class provides functionality to move to the next position in a multi-position table and control the data thread accordingly.

Notes:

• This class is used to advance to the next position in a multi-position table,

controlling the data thread based on stage distance thresholds.

• The MoveToNextPositionInMultiPositionTable class is typically used to automate

position changes during microscopy experiments, ensuring proper data thread management.

• The position control process involves moving to the next position in the table,

pausing the data thread if necessary, and resuming it after the movement.

• The config_table attribute defines the configuration for the position control

process, including signal acquisition and cleanup steps.

__init__(model, resolution_value=None, zoom_value=None, offset=None)

Initialize the MoveToNextPositionInMultiPositionTable class.

Parameters:

modelMicroscopeModel

The microscope model object used for position control.

resolution_valuestr

The resolution/microscope name of the current multiposition table

zoom_valuestr

The zoom name. For example “1x”, “2x”, …

offsetlist

The position offset [x, y, z, theta, f]

Methods

__init__(model[, resolution_value, ...])	Initialize the MoveToNextPositionInMultiPositionTable class.
cleanup()	Cleanup method to resume the data thread.
pre_signal_func()	Calculate stage offset if applicable.
signal_func()	Move to the next position in the multi-position table and control the data thread.

Attributes

model	The microscope model associated with position control.
config_table	A dictionary defining the configuration for the position control
pre_z	The current index of the position being acquired in the multi-position
current_idx	The current index of the position being acquired in the multi-position
multiposition_table	A dictionary defining the configuration for the position control
position_count	The total number of positions in the multi-position table.
stage_distance_threshold	The stage distance threshold for pausing the data thread.
resolution_value	The microscope name/resolution name
zoom_value	The zoom value
offset	stage offset table
initialized	The flag inidicates whether this node is initialized

cleanup()

Cleanup method to resume the data thread.

This method is responsible for resuming the data thread after position control.

pre_signal_func()

Calculate stage offset if applicable.

signal_func()

Move to the next position in the multi-position table and control the data thread.

This method advances to the next position in the multi-position table, controls the data thread based on stage distance thresholds, and updates position-related information.

Returns:

bool

A boolean value indicating whether to continue the position control process.

config_table

A dictionary defining the configuration for the position control

Type:

dict

current_idx

The current index of the position being acquired in the multi-position

Type:

int

initialized

The flag inidicates whether this node is initialized

Type:

bool

model

The microscope model associated with position control.

Type:

MicroscopeModel

multiposition_table

A dictionary defining the configuration for the position control

Type:

dict

offset

stage offset table

Type:

dict

position_count

The total number of positions in the multi-position table.

Type:

int

pre_z

The current index of the position being acquired in the multi-position

Type:

int

resolution_value

The microscope name/resolution name

Type:

str

stage_distance_threshold

The stage distance threshold for pausing the data thread.

Type:

int

zoom_value

The zoom value

Type:

str