navigate.model.features.update_setting.UpdateExperimentSetting
- class navigate.model.features.update_setting.UpdateExperimentSetting(model, experiment_parameters={})
Bases:
FeatureBase- __init__(model, experiment_parameters={})
Methods
__init__(model[, experiment_parameters])cleanup()Perform actions to change the resolution mode and update the active
Attributes
- cleanup()
- signal_func()
- Perform actions to change the resolution mode and update the active
microscope.
- This method carries out actions to change the resolution mode of the microscope
by reconfiguring the microscope settings, updating the active microscope, and resuming data acquisition.
- Returns:
A boolean value indicating the success of the resolution change process.
- Return type:
bool
- config_table
A dictionary defining the configuration for the resolution change
- Type:
dict
- description = 'Update experiment values on the fly'
- parameter_schema = {'experiment_parameters': CollectionSpec(item_schema={'MicroscopeState.stack_cycling_mode': SettingSpec(value_type=<class 'str'>, default='per_stack', label='Stack Cycling Mode', help_text='How channels cycle through a z-stack.', choices=('per_stack', 'per_z'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'MicroscopeState.start_position': SettingSpec(value_type=<class 'float'>, default=0, label='Start Position', help_text='Relative z-stack start position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=0.1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.end_position': SettingSpec(value_type=<class 'float'>, default=0, label='End Position', help_text='Relative z-stack end position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=0.1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.step_size': SettingSpec(value_type=<class 'float'>, default=0, label='Step Size', help_text='Distance between z planes.', choices=None, choice_values=None, minimum=None, exclusive_minimum=0, maximum=None, step=0.01, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.timepoints': SettingSpec(value_type=<class 'int'>, default=1, label='Timepoints', help_text='Number of timepoints to acquire.', choices=None, choice_values=None, minimum=1, exclusive_minimum=None, maximum=None, step=1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.stack_pause': SettingSpec(value_type=<class 'float'>, default=0, label='Stack Pause', help_text='Pause between z-stack acquisitions.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=None, step=0.1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.start_focus': SettingSpec(value_type=<class 'float'>, default=0, label='Start Focus', help_text='Relative remote-focus start position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=0.1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.end_focus': SettingSpec(value_type=<class 'float'>, default=0, label='End Focus', help_text='Relative remote-focus end position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=0.1, required=False, dynamic_source=None, depends_on=None), 'MicroscopeState.channels': SettingSpec(value_type=<class 'dict'>, default={}, label='Channels', help_text='Complete channel mapping for MicroscopeState.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None)}, storage='single_mapping', key_field='name', value_field='value', storage_fields=None, label='Experiment Parameters', help_text='MicroscopeState values to update when this feature runs.', dynamic_source='microscope_state', minimum_items=0, none_option_label=None)}