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.shutter
  • navigate.model.devices.shutter.asi
  • navigate.model.devices.shutter.asi.ASIShutter
  • View page source

navigate.model.devices.shutter.asi.ASIShutter

class navigate.model.devices.shutter.asi.ASIShutter(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], address=None)

Bases: ShutterBase, SerialDevice

ShutterTTL Class

Triggering for shutters delivered from the TigerController. Each output keeps their last digital state for as long the device is not powered down.

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

Initialize the ASIShutter.

Parameters:
  • microscope_name (str) – Name of microscope in configuration

  • device_connection (Any) – Hardware device to connect to

  • configuration (Dict[str, Any]) – Global configuration of the microscope

Methods

__init__(microscope_name, device_connection, ...)

Initialize the ASIShutter.

close_shutter()

Closes the shutter.

connect(port[, baudrate, timeout])

Build ASILaser Serial Port connection

disconnect()

Disconnect from serial device.

open_shutter()

Opens the shutter.

Attributes

state

Get the state of the shutter.

address

Address of the shutter, if applicable.

shutter

ASI Tiger Controller object.

axis

Axis of the shutter.

port

Port for communicating with the shutter.

close_shutter() → None

Closes the shutter.

Raises:

Exception – If there is an error while trying to close the shutter.

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

Build ASILaser Serial Port connection

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

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

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

Returns:

tiger_controller – ASI Tiger Controller object.

Return type:

TigerController

disconnect()

Disconnect from serial device.

open_shutter() → None

Opens the shutter.

Raises:

Exception – If there is an error while trying to open the shutter.

address

Address of the shutter, if applicable.

Type:

str

axis

Axis of the shutter.

Type:

str

configuration

Global configuration of the microscope

Type:

Dict[str, Any]

device_connection

Hardware device to connect to

Type:

Any

microscope_name

Name of the microscope

Type:

str

port

Port for communicating with the shutter.

Type:

str

shutter

ASI Tiger Controller object.

Type:

TigerController

shutter_state

Shutter state

Type:

bool

property state: bool

Get the state of the shutter.

Returns:

True if the shutter is open, False if it is closed.

Return type:

bool

Previous Next

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