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.devices.camera
        • 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.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.galvo
  • navigate.model.devices.galvo.asi
  • navigate.model.devices.galvo.asi.ASIGalvo
  • View page source

navigate.model.devices.galvo.asi.ASIGalvo

class navigate.model.devices.galvo.asi.ASIGalvo(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], device_id: int = 0)

Bases: GalvoBase, SerialDevice

GalvoASI Class - ASI DAQ Control of Galvanometers

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

Initialize the GalvoASI class.

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

  • device_connection (Any) – Connection to the NI DAQ device.

  • configuration (Dict[str, Any]) – Dictionary of configuration parameters.

  • device_id (int) – Galvo ID. Default is 0.

Methods

__init__(microscope_name, device_connection, ...)

Initialize the GalvoASI class.

adjust(exposure_times, sweep_times)

Adjust the galvo waveform to account for the camera readout time.

close()

Close the ASI galvo serial port.

connect(port[, baudrate, timeout])

Build ASILaser Serial Port connection

disconnect()

Disconnect from serial device.

sawtooth([period, amplitude, offset, duty_cycle])

Sends the tiger controller commands to initiate the sawtooth wave.

sine_wave([period, amplitude, offset])

Sends the tiger controller commands to initiate the sine wave.

turn_off()

Stops the galvo waveform

Attributes

galvo

Device connection.

axis

Galvo Axis

adjust(exposure_times, sweep_times)

Adjust the galvo waveform to account for the camera readout time.

Parameters:
  • exposure_times (dict) – Dictionary of camera exposure time in seconds on a per-channel basis. e.g., exposure_times = {“channel_1”: 0.1, “channel_2”: 0.2}

  • sweep_times (dict) – Dictionary of acquisition sweep time in seconds on a per-channel basis. e.g., sweep_times = {“channel_1”: 0.1, “channel_2”: 0.2}

Returns:

waveform_dict – Dictionary that includes the galvo waveforms on a per-channel basis.

Return type:

dict

close()

Close the ASI galvo serial port.

Stops the remote focus waveform and then closes the port.

classmethod connect(port, baudrate=115200, timeout=0.25)

Build ASILaser Serial Port connection

Parameters:
  • port (str) – Port for communicating with the filter wheel, e.g., COM1.

  • baudrate (int) – Baud rate for communicating with the filter wheel, default is 115200.

  • timeout (float) – Timeout for communicating with the filter wheel, default is 0.25.

Returns:

tiger_controller – ASI Tiger Controller object.

Return type:

TigerController

disconnect()

Disconnect from serial device.

sawtooth(period=10, amplitude=1, offset=0, duty_cycle=100)

Sends the tiger controller commands to initiate the sawtooth wave.

If the duty cycle given is 50, a triangle wave will be initiated.

Parameters:
  • period (Float) – Unit - milliseconds

  • amplitude (Float) – Unit - Volts

  • offset (Float) – Unit - Volts

  • duty_cycle (Float) – Unit - Percent

sine_wave(period=10.0, amplitude=1.0, offset=0.0)

Sends the tiger controller commands to initiate the sine wave.

Parameters:
  • period (Float) – Unit - milliseconds

  • amplitude (Float) – Unit - Volts

  • offset (Float) – Unit - Volts

turn_off()

Stops the galvo waveform

axis

Galvo Axis

Type:

str

camera_delay

Camera delay

Type:

float

configuration

Dictionary of microscope configuration parameters.

Type:

dict

device_config

Dictionary of device connections.

Type:

dict

device_connection

Device connection.

Type:

Any

galvo

Device connection.

Type:

Any

galvo_max_voltage

Galvo max voltage.

Type:

float

galvo_min_voltage

Galvo min voltage.

Type:

float

galvo_name

Name of the galvo.

Type:

str

galvo_waveform

Galvo waveform. Waveform or Sawtooth.

Type:

str

microscope_name

Name of the microscope.

Type:

str

sample_rate

Sample rate.

Type:

int

sweep_time

Sweep time.

Type:

float

waveform_dict

Dictionary of galvo waveforms.

Type:

dict

Previous Next

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