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.devices.MonitoredSerial
        • navigate.model.devices.camera
        • navigate.model.devices.configuration_schema
        • navigate.model.devices.daq
        • navigate.model.devices.device_types
        • navigate.model.devices.filter_wheel
        • navigate.model.devices.galvo
        • navigate.model.devices.laser
        • navigate.model.devices.mirror
        • navigate.model.devices.objectives
        • navigate.model.devices.pump
        • navigate.model.devices.remote_focus
        • navigate.model.devices.shutter
        • navigate.model.devices.stage
        • navigate.model.devices.zoom
      • navigate.model.features
      • 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.devices
  • navigate.model.devices.filter_wheel
  • navigate.model.devices.filter_wheel.base
  • navigate.model.devices.filter_wheel.base.FilterWheelBase
  • View page source

navigate.model.devices.filter_wheel.base.FilterWheelBase

class navigate.model.devices.filter_wheel.base.FilterWheelBase(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0)

Bases: ABC

Abstract base class for filter wheels.

This class defines the interface for filter wheel devices used in the Navigate software. Implementations should handle the specifics of communication with particular hardware.

__init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0) → None

Initialize the FilterWheelBase class.

Parameters:
  • microscope_name (str) – Name of the microscope.

  • device_connection (Any) – The communication instance with the device.

  • configuration (Dict[str, Any]) – Global configuration dictionary.

  • device_id (int) – The ID of the device. Default is 0.

Methods

__init__(microscope_name, device_connection, ...)

Initialize the FilterWheelBase class.

check_if_filter_in_filter_dictionary(filter_name)

Checks if the filter designation (string) given exists in the filter dictionary

set_filter(position[, wait_until_done])

Set the filter wheel to the specified position.

Attributes

  • configuration_schema

  • device_connection

  • filter_dictionary

  • wheel_position

  • filter_wheel_number

check_if_filter_in_filter_dictionary(filter_name: str) → bool

Checks if the filter designation (string) given exists in the filter dictionary

Parameters:

filter_name (str) – Name of filter.

Returns:

filter_exists – Flag if filter exists in the filter dictionary.

Return type:

bool

Raises:

ValueError – If filter name is not in the filter dictionary.

abstract set_filter(position: Any, wait_until_done: bool = True) → None

Set the filter wheel to the specified position.

Parameters:
  • position (Any) – The desired filter position.

  • wait_until_done (bool) – Whether to wait until the filter wheel has completed the move. Default is True.

configuration_schema = {'available_filters': CollectionSpec(item_schema={'name': SettingSpec(value_type=<class 'str'>, default=None, label='Filter Name', help_text='Display name for this filter position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'position': SettingSpec(value_type=<class 'int'>, default=None, label='Position', help_text='Numeric position used by the filter-wheel controller.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=99, step=1, required=True, dynamic_source=None, depends_on=None)}, storage='mapping', key_field='name', value_field='position', storage_fields=None, label='Available Filters', help_text='Filter names and their corresponding wheel positions.', dynamic_source=None, minimum_items=1, none_option_label=None), 'filter_wheel_delay': SettingSpec(value_type=<class 'float'>, default=0.03, label='Filter Wheel Delay (s)', help_text='Estimated delay in seconds while the filter wheel changes position.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=60, step=0.001, required=True, dynamic_source=None, depends_on=None), 'hardware/wheel_number': SettingSpec(value_type=<class 'int'>, default=0, label='Wheel Number', help_text='Filter wheel identifier used by its controller. Some controllers use zero-based wheel numbers.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=16, step=1, required=True, dynamic_source=None, depends_on=None), 'name': SettingSpec(value_type=<class 'str'>, default='', label='Name', help_text='Display name for this filter wheel in the main application.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None)}
device_connection

Device connection object.

Type:

Any

filter_dictionary

Dictionary of filters available on the filter wheel.

Type:

dict

filter_wheel_number

index of filter wheel

Type:

int

wheel_position

Filter wheel position.

Type:

int

Previous Next

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