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.mirror
  • navigate.model.devices.mirror.imop
  • navigate.model.devices.mirror.imop.ImagineOpticsMirror
  • View page source

navigate.model.devices.mirror.imop.ImagineOpticsMirror

class navigate.model.devices.mirror.imop.ImagineOpticsMirror(microscope_name, device_connection, configuration, *args, **kwargs)

Bases: MirrorBase

ImageineOpticsMirror mirror class.

__init__(microscope_name, device_connection, configuration, *args, **kwargs)

Initialize the ImagineOpticsMirror class.

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

  • device_connection (dict) – Dictionary containing the device connection information.

  • configuration (dict) – Dictionary containing the configuration information.

Methods

__init__(microscope_name, device_connection, ...)

Initialize the ImagineOpticsMirror class.

display_modes(coefs)

Display the mirror modes.

flat()

Move the mirror to the flat position.

get_modal_coefs()

Get the modal coefficients.

save_wcs_file([path, name])

Save the WCS file.

set_from_wcs_file([path, name])

Set the mirror from a WCS file.

set_positions_flat(pos)

Set the mirror to the flat position.

zero_flatness()

Zero the mirror flatness.

Attributes

display_modes(coefs)

Display the mirror modes.

Parameters:

coefs (list) – List of coefficients to display the mirror modes.

flat()

Move the mirror to the flat position.

get_modal_coefs()

Get the modal coefficients.

Returns:

List of modal coefficients.

Return type:

list

save_wcs_file(path=None, name=None)

Save the WCS file.

Parameters:
  • path (str, optional) – Path to save the WCS file, by default None

  • name (str, optional) – Name of the WCS file, by default None

set_from_wcs_file(path=None, name=None)

Set the mirror from a WCS file.

Parameters:
  • path (str, optional) – Path to the WCS file, by default None

  • name (str, optional) – Name of the WCS file, by default None

Returns:

List of coefficients.

Return type:

list

set_positions_flat(pos)

Set the mirror to the flat position.

Parameters:

pos (list) – List of positions to set the mirror to.

zero_flatness()

Zero the mirror flatness.

configuration

Configuration of the microscope

Type:

dict

is_synthetic

Is the mirror synthetic?

Type:

bool

mirror_controller

Hardware device to connect to

Type:

object

mirror_parameters

Configuration of the mirror

Type:

dict

Previous Next

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