navigate.model.features.common_features.MoveToNextPositionInMultiPositionTable
- class navigate.model.features.common_features.MoveToNextPositionInMultiPositionTable(model, resolution_value=None, zoom_value=None, offset=None)
Bases:
FeatureBaseMoveToNextPositionInMultiPositionTable 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:
model (MicroscopeModel) – The microscope model object used for position control.
resolution_value (str) – The resolution/microscope name of the current multiposition table
zoom_value (str) – The zoom name. For example “1x”, “2x”, …
offset (dict) – The position offsets keyed by axis name.
Methods
__init__(model[, resolution_value, ...])Initialize the MoveToNextPositionInMultiPositionTable class.
cleanup()Cleanup method to resume the data thread.
Normalize optional stage offsets into an axis-keyed float mapping.
Calculate stage offset if applicable.
Move to the next position in the multi-position table and control the data thread.
Attributes
- cleanup()
Cleanup method to resume the data thread.
This method is responsible for resuming the data thread after position control.
- normalize_stage_offset()
Normalize optional stage offsets into an axis-keyed float mapping.
- 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:
A boolean value indicating whether to continue the position control process.
- Return type:
bool
- 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 indicates 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
- parameter_schema = {'offset': CollectionSpec(item_schema={}, storage='single_mapping', key_field='name', value_field='value', storage_fields=None, label='Offset', help_text='Optional stage offsets keyed by axis.', dynamic_source='stage_axes', minimum_items=0, none_option_label=None), 'resolution_value': SettingSpec(value_type=<class 'str'>, default=None, label='Resolution', help_text='Microscope/resolution name for the source multi-position table.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source='microscopes', depends_on=None), 'zoom_value': SettingSpec(value_type=<class 'str'>, default=None, label='Zoom', help_text='Zoom value for the source multi-position table.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source='zoom_values', depends_on='resolution_value')}
- 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