navigate.model.devices.mirror.imop.ImagineOpticsMirror

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

Bases: MirrorBase, IntegratedDevice

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 (IMOP_Mirror) – The cached IMOP_Mirror connection instance from the factory.

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

Methods

__init__(microscope_name, device_connection, ...)	Initialize the ImagineOpticsMirror class.
connect(wfc_config_file_path, ...)	Create and return IMOP_Mirror connection.
display_modes(coefs)	Display the mirror modes.
flat()	Move the mirror to the flat position.
get_connect_params()	Connection parameters read from the mirror's hardware config block.
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

classmethod connect(wfc_config_file_path, haso_config_file_path, flat_path, interaction_matrix_file_path) → navigate.model.devices.APIs.imagineoptics.imop.IMOP_Mirror

Create and return IMOP_Mirror connection.

Parameters:

• wfc_config_file_path (str) – Path to the wavefront-corrector (.dat) config file.

• haso_config_file_path (str) – Path to the HASO sensor (.dat) config file.

• flat_path (str) – Path to the .wcs file defining the flat actuator positions.

• interaction_matrix_file_path (str) – Path to the .aoc interaction matrix used to build the command matrix.

Returns:

The mirror controller instance.

Return type:

IMOP_Mirror

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.

classmethod get_connect_params() → list[str]

Connection parameters read from the mirror’s hardware config block.

Returns:

Names of the WaveKit config/calibration file paths required to connect to the mirror.

Return type:

list

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