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.SetCameraParameters
  • View page source

navigate.model.features.update_setting.SetCameraParameters

class navigate.model.features.update_setting.SetCameraParameters(model, microscope_name=None, sensor_mode='Normal', readout_direction=None, rolling_shutter_width=None)

Bases: FeatureBase

SetCameraParameters class for modifying the parameters of a camera.

This class provides functionality to update the parameters of a camera.

Notes

  • This class can set sensor_mode, readout_direction and rolling_shutter_with.

  • If the value of a parameter is None it doesn’t update the parameter value.

__init__(model, microscope_name=None, sensor_mode='Normal', readout_direction=None, rolling_shutter_width=None)

Initialize the ChangeResolution class.

Parameters:
  • model (MicroscopeModel) – The microscope model object used for resolution mode changes.

  • sensor_mode (str, optional) – The desired sensor mode to set for the camera. “Normal” or “Light-Sheet”

  • readout_direction (str, optional) – The readout direction to set for the camera. “Top-to-Bottom”, “Bottom-to-Top”, “Bidirectional” or “Rev. Bidirectional”

  • rolling_shutter_width (int, optional) – The number of pixels for the rolling shutter.

Methods

__init__(model[, microscope_name, ...])

Initialize the ChangeResolution class.

cleanup()

signal_func()

Perform actions to change the resolution mode and update the active

Attributes

  • parameter_schema

  • model

  • config_table

  • microscope_name

  • sensor_mode

  • readout_direction

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

microscope_name

Microscope name

Type:

str

model

The microscope model associated with the resolution change.

Type:

MicroscopeModel

parameter_schema = {'microscope_name': SettingSpec(value_type=<class 'str'>, default=None, label='Microscope', help_text='Microscope name to update. Leave empty for the active microscope.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source='microscopes', depends_on=None), 'readout_direction': SettingSpec(value_type=<class 'str'>, default=None, label='Readout Direction', help_text='Readout direction for light-sheet sensor mode.', choices=('Top-to-Bottom', 'Bottom-to-Top', 'Bidirectional', 'Rev. Bidirectional'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'rolling_shutter_width': SettingSpec(value_type=<class 'int'>, default=None, label='Rolling Shutter Width', help_text='Number of pixels used for rolling-shutter acquisition.', choices=None, choice_values=None, minimum=1, exclusive_minimum=None, maximum=None, step=1, required=False, dynamic_source=None, depends_on=None), 'sensor_mode': SettingSpec(value_type=<class 'str'>, default='Normal', label='Sensor Mode', help_text='Camera sensor mode.', choices=('Normal', 'Light-Sheet'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None)}
readout_direction

The reading direction to set for the microscope.

Type:

str

sensor_mode

The desired sensor mode to set for the camera.

Type:

str

Previous Next

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