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.metadata_sources
      • navigate.model.microscope
      • navigate.model.model
      • navigate.model.plugins_model
      • navigate.model.waveforms
        • navigate.model.waveforms.camera_exposure
        • navigate.model.waveforms.dc_value
        • navigate.model.waveforms.remote_focus_ramp
        • navigate.model.waveforms.remote_focus_ramp_triangular
        • navigate.model.waveforms.sawtooth
        • navigate.model.waveforms.sine_wave
        • navigate.model.waveforms.single_pulse
        • navigate.model.waveforms.smooth_waveform
        • navigate.model.waveforms.square
    • navigate.tools
    • navigate.view
navigate
  • Software API
  • navigate.model
  • navigate.model.waveforms
  • navigate.model.waveforms.remote_focus_ramp
  • View page source

navigate.model.waveforms.remote_focus_ramp

navigate.model.waveforms.remote_focus_ramp(sample_rate=100000, exposure_time=0.2, sweep_time=0.24, remote_focus_delay=0.005, camera_delay=0.001, fall=0.05, amplitude=1, offset=0)

Returns a numpy array with a sawtooth ramp - typically used for remote focusing.

The waveform starts at offset and stays there for the delay period, then rises linearly to 2x amplitude (amplitude here refers to 1/2 peak-to-peak) and drops back down to the offset voltage during the fall period.

Switching from a left to right remote focus ramp is possible by exchanging the rise and fall periods.

Parameters:
  • sample_rate (Integer) – Unit - Hz

  • exposure_time (Float) – Unit - Seconds

  • sweep_time (Float) – Unit - Seconds

  • remote_focus_delay (Float) – Unit - seconds

  • camera_delay (Float) – Unit - seconds

  • fall (Float) – Unit - seconds

  • amplitude (Float) – Unit - Volts

  • offset (Float) – Unit - Volts

Returns:

waveform

Return type:

np.array

Examples

>>> etl_ramp = tunable_lens_ramp(sample_rate, exposure_time, sweep_time, etl_delay,
    camera_delay, fall, amplitude, offset)
Previous Next

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