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
  • navigate.controller.configuration_controller.ConfigurationController
  • View page source

navigate.controller.configuration_controller.ConfigurationController

class navigate.controller.configuration_controller.ConfigurationController(configuration)

Bases: object

Configuration Controller - Used to get the configuration of the microscope.

__init__(configuration)

Initialize the Configuration Controller

Parameters:

configuration (dict) – The configuration dictionary.

Methods

__init__(configuration)

Initialize the Configuration Controller

change_microscope()

Get the new microscope configuration dict according to the name.

get_microscope_configuration_dict()

Return microscope configuration dictionary

get_stage_position_limits(suffix)

Return the position limits of the stage

get_zoom_value_list(microscope_name)

Return a list of zoom values

Attributes

all_stage_axes

Return all the axes of the stage

camera_config_dict

Get camera configuration dict

camera_flip_flags

Return the flip flags of the camera

camera_pixels

Get default pixel values from camera

channels_info

Return the channels info

daq_sample_rate

Return daq sample rate.

filter_wheel_names

Return a list of filter wheel names

filter_wheel_setting_dict

Return filter wheel setting dict.

galvo_parameter_dict

Return galvo parameter dict.

gui_setting

lasers_info

Return the lasers info

microscope_list

Return a list of microscope names

number_of_channels

Return number of channels.

number_of_filter_wheels

Return number of filter wheels

remote_focus_dict

Return delay_percent, pulse_percent.

stage_axes

Return the axes of the stage

stage_default_position

Get current position of the stage

stage_flip_flags

Return the flip flags of the stage

stage_setting_dict

Return stage setting dict.

stage_step

Get the step size of the stage

z_stages

Return a list of all z stage names.

configuration

The configuration dictionary.

microscope_name

The microscope name.

microscope_config

The microscope configuration dictionary.

galvo_num

The number of galvos.

change_microscope() → bool

Get the new microscope configuration dict according to the name.

Gets the name of the microscope, retrieves its configuration, and updates the Configuration Controller’s attributes.

Returns:

result

Return type:

bool

get_microscope_configuration_dict()

Return microscope configuration dictionary

Returns:

microscope_configuration_dict

Return type:

dict

get_stage_position_limits(suffix)

Return the position limits of the stage

Parameters:

suffix (str) – ‘_min’ or ‘_max’

Returns:

position_limits – Depending on suffix, min or max stage limits, e.g. {‘x’: 2000, ‘y’: 2000, ‘z’: 2000, ‘theta’: 0, ‘f’: 2000}.

Return type:

dict

get_zoom_value_list(microscope_name)

Return a list of zoom values

Returns:

zoom_value_list – List of zoom values.

Return type:

list

property all_stage_axes

Return all the axes of the stage

Returns:

axes – List of all axes, e.g. [‘x’, ‘y’, ‘z’, ‘theta’, ‘f’].

Return type:

list

property camera_config_dict

Get camera configuration dict

Returns:

camera_setting – Camera Setting, e.g. {

}

Return type:

dict

property camera_flip_flags

Return the flip flags of the camera

Returns:

flip_flags – {‘x’: bool, ‘y’: bool}.

Return type:

dict

property camera_pixels

Get default pixel values from camera

Returns:

  • x_pixels (int) – Number of x pixels

  • y_pixels (int) – Number of y pixels

property channels_info

Return the channels info

Populate the channel combobox with the channels that are available in the configuration

Returns:

setting –

Channel settings, e.g. {

‘laser’: [‘488nm’, ‘561nm’, ‘642nm’], ‘filter’: [‘Empty-Alignment’, ‘GFP - FF01-515/30-32’, ‘…}

Return type:

dict

configuration

The configuration dictionary.

Type:

dict

property daq_sample_rate

Return daq sample rate.

Returns:

daq_sample_rate – Sample rate of the daq.

Return type:

float

property filter_wheel_names

Return a list of filter wheel names

Returns:

filter_wheel_names – List of filter wheel names.

Return type:

list

property filter_wheel_setting_dict

Return filter wheel setting dict.

Returns:

filter_wheel_setting_dict – Dictionary with the filter wheel settings.

Return type:

dict

galvo_num

The number of galvos.

Type:

int

property galvo_parameter_dict

Return galvo parameter dict.

Returns:

galvo_parameter_dict – Dictionary with the galvo parameters.

Return type:

dict

property lasers_info

Return the lasers info

Populate the laser combobox with the lasers that are available in the configuration

Returns:

laser_list – List of lasers, e.g. [‘488nm’, ‘561nm’, ‘642nm’]

Return type:

list

microscope_config

The microscope configuration dictionary.

Type:

dict

property microscope_list

Return a list of microscope names

Returns:

microscope_list – List of microscope names.

Return type:

list

microscope_name

The microscope name.

Type:

str

property number_of_channels

Return number of channels.

Returns:

number_of_channels – Number of channels.

Return type:

int

property number_of_filter_wheels

Return number of filter wheels

Returns:

number_of_filter_wheels – Number of filter wheels

Return type:

int

property remote_focus_dict

Return delay_percent, pulse_percent.

Returns:

remote_focus_parameters – Dictionary with the remote focus percent delay and pulse percent.

Return type:

dict

property stage_axes

Return the axes of the stage

Returns:

axes – List of axes, e.g. [‘x’, ‘y’, ‘z’, ‘theta’, ‘f’].

Return type:

list

property stage_default_position

Get current position of the stage

Returns:

position – Dictionary with x, y, z, theta, and f positions.

Return type:

dict

property stage_flip_flags

Return the flip flags of the stage

Returns:

flip_flags – {‘x’: bool, ‘y’: bool, ‘z’: bool, ‘theta’: bool, ‘f’: bool}.

Return type:

dict

property stage_setting_dict

Return stage setting dict.

Returns:

stage_setting_dict – Dictionary with the stage settings.

Return type:

dict

property stage_step

Get the step size of the stage

Returns:

steps – Step size in x (same step size for y), z, theta, and f.

Return type:

dict

property z_stages

Return a list of all z stage names.

Returns:

z_stages – A list of z stage names.

Return type:

list


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