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.laser
  • navigate.model.devices.laser.ni
  • navigate.model.devices.laser.ni.NILaser
  • View page source

navigate.model.devices.laser.ni.NILaser

class navigate.model.devices.laser.ni.NILaser(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], device_id: int)

Bases: LaserBase, NIDevice

LaserNI Class

This class is used to control a laser connected to a National Instruments DAQ.

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

Initialize the LaserNI class.

Parameters:
  • microscope_name (str) – The microscope name.

  • device_connection (Any) – The device connection object.

  • configuration (Dict[str, Any]) – The device configuration.

  • device_id (int) – The laser id.

Methods

__init__(microscope_name, device_connection, ...)

Initialize the LaserNI class.

close()

Close the NI Task before exit.

initialize_analog_modulation()

Initialize the analog modulation of the laser.

initialize_digital_modulation()

Initialize the digital modulation of the laser.

initialize_laser()

Initialize lasers.

set_power(laser_intensity)

Sets the analog laser power.

turn_off()

Turns off the laser.

turn_on()

Turns on the laser.

Attributes

modulation_type

The modulation type of the laser - Analog, Digital, or Mixed.

digital_port_type

Modulation type of the laser - Analog or Digital.

laser_min_do

The minimum digital modulation voltage.

laser_max_do

The maximum digital modulation voltage.

laser_do_task

The laser digital modulation task.

laser_min_ao

The minimum analog modulation voltage.

laser_max_ao

The maximum analog modulation voltage.

laser_ao_task

The laser analog modulation task.

close() → None

Close the NI Task before exit.

initialize_analog_modulation() → None

Initialize the analog modulation of the laser.

initialize_digital_modulation() → None

Initialize the digital modulation of the laser.

initialize_laser() → None

Initialize lasers.

set_power(laser_intensity: float) → None

Sets the analog laser power.

Parameters:

laser_intensity (float) – The laser intensity.

turn_off() → None

Turns off the laser.

turn_on() → None

Turns on the laser.

configuration

Configuration dictionary

Type:

dict

device_config

Laser ID

Type:

int

device_connection

Communication instance with the device

Type:

Any

digital_port_type

Modulation type of the laser - Analog or Digital.

Type:

str

laser_ao_task

The laser analog modulation task.

Type:

nidaqmx.Task

laser_do_task

The laser digital modulation task.

Type:

nidaqmx.Task

laser_max_ao

The maximum analog modulation voltage.

Type:

float

laser_max_do

The maximum digital modulation voltage.

Type:

float

laser_min_ao

The minimum analog modulation voltage.

Type:

float

laser_min_do

The minimum digital modulation voltage.

Type:

float

microscope_name

Name of the microscope

Type:

str

modulation_type

The modulation type of the laser - Analog, Digital, or Mixed.

Type:

str

Previous Next

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