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.config.config
      • navigate.config.configuration_database
      • navigate.config.configuration_schema
      • navigate.config.device_refs
      • navigate.config.device_schema
      • navigate.config.gui_settings
      • navigate.config.preload
        • navigate.config.preload.preload_configuration
        • navigate.config.preload.PreloadChange
        • navigate.config.preload.PreloadContext
        • navigate.config.preload.PreloadIssue
        • navigate.config.preload.PreloadReport
        • navigate.config.preload.PreloadRule
        • navigate.config.preload.PreloadError
      • navigate.config.preload_rules
    • navigate.controller
    • navigate.controller.configurator
    • navigate.log_files
    • navigate.model
    • navigate.tools
    • navigate.view
navigate
  • Software API
  • navigate.config
  • navigate.config.preload
  • navigate.config.preload.PreloadRule
  • View page source

navigate.config.preload.PreloadRule

class navigate.config.preload.PreloadRule(domain: str, name: str, apply: Callable[[PreloadContext], None], stop_on_fatal: bool = False)

Bases: object

One named preload rule in a configuration domain.

__init__(domain: str, name: str, apply: Callable[[PreloadContext], None], stop_on_fatal: bool = False) → None

Methods

__init__(domain, name, apply[, stop_on_fatal])

Attributes

rule_id

Return a stable rule identifier for reports.

stop_on_fatal

domain

name

apply

property rule_id: str

Return a stable rule identifier for reports.

Previous Next

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