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.waveforms
    • navigate.tools
    • navigate.view
navigate
  • Software API
  • navigate.model
  • navigate.model.devices
  • navigate.model.devices.configuration_schema
  • navigate.model.devices.configuration_schema.SettingSpec
  • View page source

navigate.model.devices.configuration_schema.SettingSpec

class navigate.model.devices.configuration_schema.SettingSpec(value_type: type, default: Optional[Any] = None, label: Optional[str] = None, help_text: Optional[str] = None, choices: Optional[Tuple[Any, ...]] = None, minimum: Optional[float] = None, maximum: Optional[float] = None, step: Optional[float] = None, required: bool = False)

Bases: object

Description of one persisted, user-editable device setting.

choices defines a closed set of values. minimum, maximum, and step define a numeric range; they are intentionally mutually exclusive with choices.

__init__(value_type: type, default: Optional[Any] = None, label: Optional[str] = None, help_text: Optional[str] = None, choices: Optional[Tuple[Any, ...]] = None, minimum: Optional[float] = None, maximum: Optional[float] = None, step: Optional[float] = None, required: bool = False) → None

Methods

__init__(value_type[, default, label, ...])

Attributes

choices

default

display_label

Return the configured label, falling back to the setting key at render time.

help_text

label

maximum

minimum

required

step

value_type

property display_label: str

Return the configured label, falling back to the setting key at render time.

Previous Next

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