navigate Logo

Getting Started

  • Computer Considerations
  • Computer Power Configuration
  • Software Installation
  • Launching Navigate
  • Configuring Navigate
  • Acquiring Data
  • Smart Acquisition Routines

User Guide

  • Supported Hardware
  • Supported File Formats
  • User Interface Walkthrough
  • Setting Up a Microscope
  • Acquiring Data
  • Case Studies

Development

  • Contributing Guidelines
  • Developer Install
  • Software Architecture
  • Developer Architecture Concepts
  • Feature Container
  • REST API
  • Plugin Architecture
  • Adding New Hardware

Troubleshooting & Known Issues

  • Troubleshooting
  • Known Issues

Plugins

  • navigate Plugin Template
  • navigate Confocal Projection
  • navigate at Scale
  • navigate Constant Velocity Acquisition
  • navigate MMCore
  • navigate ilastik Server
  • navigate Photoactivation

Reference

  • Implemented Microscopes
  • Software API
    • navigate.config
    • navigate.controller
    • navigate.controller.configurator
    • navigate.log_files
    • navigate.model
      • navigate.model.analysis
      • navigate.model.concurrency
      • navigate.model.data_sources
      • navigate.model.device_startup_functions
      • navigate.model.devices
      • navigate.model.features
        • navigate.model.features.adaptive_optics
        • navigate.model.features.auto_tile_scan
        • navigate.model.features.autofocus
        • navigate.model.features.base
        • navigate.model.features.common_features
        • navigate.model.features.feature_container
        • navigate.model.features.feature_related_functions
        • navigate.model.features.image_writer
        • navigate.model.features.parameter_tools
        • navigate.model.features.remove_empty_tiles
        • navigate.model.features.restful_features
        • navigate.model.features.update_setting
        • navigate.model.features.volume_search
      • navigate.model.metadata_sources
      • navigate.model.microscope
      • navigate.model.model
      • navigate.model.plugins_model
      • navigate.model.resolution_change
      • navigate.model.waveforms
    • navigate.tools
    • navigate.view
navigate
  • Software API
  • navigate.model
  • navigate.model.features
  • navigate.model.features.update_setting
  • navigate.model.features.update_setting.UpdateExperimentSetting
  • View page source

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()

signal_func()

Perform actions to change the resolution mode and update the active

Attributes

  • description

  • parameter_schema

  • config_table

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)}
Previous Next

© Copyright 2026, Dean Lab, UT Southwestern Medical Center.