navigate Logo

Getting Started

  • Quick Start Guide
  • Software Installation
  • I Want To…

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
  • Feature Container
  • REST-API
  • Plugin Architecture

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.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.common_features
        • navigate.model.features.feature_container
        • navigate.model.features.feature_related_functions
        • navigate.model.features.image_writer
        • 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.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: object

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:

modelMicroscopeModel

The microscope model object used for resolution mode changes.

sensor_modestr, optional

The desired sensor mode to set for the camera. “Normal” or “Light-Sheet”

readout_directionstr, optional

The readout direction to set for the camera. “Top-to-Bottom”, “Bottom-to-Top”, “Bidirectional” or “Rev. Bidirectional”

rolling_shutter_widthint, 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

model

The microscope model associated with the resolution change.

config_table

A dictionary defining the configuration for the resolution change

microscope_name

Microscope name

sensor_mode

The desired sensor mode to set for the camera.

readout_direction

The reading direction to set for the microscope.

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:

bool

A boolean value indicating the success of the resolution change process.

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

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 2025, Dean Lab, UT Southwestern Medical Center.