bmc.py

#!/usr/bin/env python3
 
 
 
"""Boston MicroMachines Corporation deformable mirrors.
"""
 
import ctypes
import os
import warnings
 
import numpy
 
import microscope
import microscope._utils
import microscope.abc
 
 
try:
    import microscope._wrappers.BMC as BMC
except Exception as e:
    raise microscope.LibraryLoadError(e) from e
 
 
class BMCDeformableMirror(
    microscope._utils.OnlyTriggersOnceOnSoftwareMixin,
    microscope.abc.DeformableMirror,
):
    """Boston MicroMachines (BMC) deformable mirror.
 
    BMC deformable mirrors only support software trigger.
    """
 
    def __init__(self, serial_number: str, **kwargs) -> None:
        super().__init__(**kwargs)
        self._dm = BMC.DM()
 
        if __debug__:
            BMC.ConfigureLog(os.devnull.encode(), BMC.LOG_ALL)
        else:
            BMC.ConfigureLog(os.devnull.encode(), BMC.LOG_OFF)
 
        status = BMC.Open(self._dm, serial_number.encode())
        if status:
            raise microscope.InitialiseError(BMC.ErrorString(status))
 
    @property
    def n_actuators(self) -> int:
        return self._dm.ActCount
 
    def _do_apply_pattern(self, pattern: numpy.ndarray) -> None:
        data_pointer = pattern.ctypes.data_as(ctypes.POINTER(ctypes.c_double))
        status = BMC.SetArray(self._dm, data_pointer, None)
        if status:
            raise microscope.DeviceError(BMC.ErrorString(status))
 
    def _do_shutdown(self) -> None:
        status = BMC.Close(self._dm)
        if status:
            warnings.warn(BMC.ErrorString(status), RuntimeWarning)