calibration.py

 
import numpy as np
 
class Calibration(object):
    """ This optimizer class handles all the modal basis and DM Influence functions
    related operations.
 
    Attributes:
        config : (config) : Configuration parameters module
 
        tel : (TelescopeCompass) : TelescopeCompass instance
 
        atmos : (AtmosScompass) : AtmosCompass instance
 
        dms : (DmCompass) : DmCompass instance
 
        target : (TargetCompass) : TargetCompass instance
 
        rtc : (RtcCompass) : RtcCompass instance
 
        wfs : (WfsCompass) : WfsCompass instance
    """
    def __init__(self, config, tel, atmos, dms, target, rtc, wfs):
        """ Instantiate a ModalBasis object
 
        Parameters:
            config : (config) : Configuration parameters module
 
            tel : (TelescopeCompass) : TelescopeCompass instance
 
            atmos : (AtmosScompass) : AtmosCompass instance
 
            dms : (DmCompass) : DmCompass instance
 
            target : (TargetCompass) : TargetCompass instance
 
            rtc : (RtcCompass) : RtcCompass instance
 
            wfs : (WfsCompass) : WfsCompass instance
        """
        self.config = config
        self.tel = tel
        self.atmos = atmos
        self.dms = dms
        self.target = target
        self.rtc = rtc
        self.wfs = wfs
 
    def apply_volts_and_get_slopes(self, controller_index: int, *, noise: bool = False,
                                   turbu: bool = False, reset: bool = True):
        """ Apply voltages, raytrace, compute WFS image, compute slopes and returns it
 
        Parameters:
            controller_index : (int) : Controller index
 
            noise : (bool, optional) : Flag to enable noise for WFS image compuation. Default is False
 
            turbu : (bool, optional) : Flag to enable atmosphere for WFS phase screen raytracing.
                                       Default is False
 
            reset : (bool, optional) : Flag to reset previous phase screen before raytracing.
                                       Default is True
        """
        self.rtc.apply_control(controller_index)
        for w in range(len(self.config.p_wfss)):
            if (turbu):
                self.wfs.raytrace(w, tel=self.tel, atm=self.atmos, dms=self.dms)
            else:
                self.wfs.raytrace(w, dms=self.dms, reset=reset)
            self.wfs.compute_wfs_image(w, noise=noise)
        return self.rtc.compute_slopes(controller_index)
 
    def do_imat_modal(self, controller_index : int, ampli : np.ndarray, modal_basis : np.ndarray, 
                      *, noise : bool=False, nmodes_max : int=0, with_turbu : bool=False, push_pull : bool=False) -> np.ndarray:
        """ Computes an interaction matrix from provided modal basis
 
        Parameters:
            controller_index : (int) : Controller index
 
            ampli : (np.ndarray) : amplitude to apply on each mode
 
            modal_basis : (np.ndarray) : modal basis matrix
 
            noise : (bool, optional) : Flag to enable noise for WFS image compuation. Default is False
 
            nmodes_max : (int, optional) : Default is 0. TODO : description
 
            with_turbu : (bool, optional) : Flag to enable atmosphere for WFS phase screen raytracing.
                                            Default is False
 
            push_pull : (bool, optional) : If True, imat is computed as an average of push and pull ampli
                                            on each mode
 
        Return:
            modal_imat : (np.ndarray) : Modal interaction matrix
        """
        modal_imat = np.zeros((self.config.p_controllers[controller_index].nslope, modal_basis.shape[1]))
 
        if (nmodes_max == 0):
            nmodes_max = modal_basis.shape[1]
        v_old = self.rtc.get_command(controller_index)
        self.rtc.open_loop(controller_index, reset=False)
        for m in range(nmodes_max):
            v = ampli[m] * modal_basis[:, m]
            if ((push_pull is True) or
                (with_turbu is True)):  # with turbulence/aberrations => push/pull
                self.rtc.set_perturbation_voltage(
                        controller_index, "imat_modal",
                        v_old + v)  # Adding Perturbation voltage on current iteration
                devpos = self.apply_volts_and_get_slopes(controller_index,
                                                         turbu=with_turbu, noise=noise)
                self.rtc.set_perturbation_voltage(controller_index, "imat_modal", v_old - v)
                devmin = self.apply_volts_and_get_slopes(controller_index,
                                                         turbu=with_turbu, noise=noise)
                modal_imat[:, m] = (devpos - devmin) / (2. * ampli[m])
            else:  # No turbulence => push only
                self.rtc.open_loop(controller_index)  # open_loop
                self.rtc.set_perturbation_voltage(controller_index, "imat_modal", v)
                modal_imat[:, m] = self.apply_volts_and_get_slopes(controller_index, noise=noise) / ampli[m]
        self.rtc.remove_perturbation_voltage(controller_index, "imat_modal")
        if ((push_pull is True) or (with_turbu is True)):
            self.rtc.close_loop(controller_index)  # We are supposed to be in close loop now
        return modal_imat
 
    def do_imat_phase(self, controller_index: int, cube_phase: np.ndarray, *, noise : bool=False,
                      nmodes_max : int=0, with_turbu : bool=False, push_pull : bool=False, wfs_index : int=0) -> np.ndarray:
        """ Computes an interaction matrix with the provided cube phase
 
        Parameters:
            controller_index : (int) : Controller index
 
            cube_phase : (np.ndarray) : Cube of phase to insert as NCPA
 
            noise : (bool, optional) : Flag to enable noise for WFS image compuation. Default is False
 
            nmodes_max : (int, optional) : Default is 0. TODO : description
 
            with_turbu : (bool, optional) : Flag to enable atmosphere for WFS phase screen raytracing.
                                            Default is False
 
            push_pull : (bool, optional) : If True, imat is computed as an average of push and pull ampli
                                            on each mode
 
            wfs_index : (int, optional) : WFS index. Default is 0
 
        Return:
            phase_imat : (np.ndarray) : Phase interaction matrix
        """
        imat_phase = np.zeros((cube_phase.shape[0], self.config.p_controllers[controller_index].nslope))
        for nphase in range(cube_phase.shape[0]):
            if ((push_pull is True) or (with_turbu is True)
                ):  # with turbulence/aberrations => push/pullADOPT/projects/cosmic/
                self.wfs.set_ncpa_wfs(wfs_index, cube_phase[nphase, :, :])
                devpos = self.apply_volts_and_get_slopes(controller_index,
                                                         turbu=with_turbu, noise=noise)
                self.set_ncpa_wfs(wfs_index, -cube_phase[nphase, :, :])
                devmin = self.apply_volts_and_get_slopes(controller_index,
                                                         turbu=with_turbu, noise=noise)
                imat_phase[nphase, :] = (devpos - devmin) / 2
            else:  # No turbulence => push only
                self.rtc.open_loop(controller_index)  # open_loop
                self.wfs.set_ncpa_wfs(wfs_index, cube_phase[nphase, :, :])
                imat_phase[nphase, :] = self.apply_volts_and_get_slopes(
                        controller_index, noise=noise)
        self.wfs.set_ncpa_wfs(wfs_index,
                          cube_phase[nphase, :, :] * 0.)  # Remove the Phase on WFS
        _ = self.apply_volts_and_get_slopes(controller_index, turbu=with_turbu,
                                            noise=noise)
 
        return imat_phase
 
    def compute_modal_residuals(self, projection_matrix : np.ndarray, 
                                *, selected_actus : np.ndarray=None) -> np.ndarray:
        """ Computes the modal residual coefficients of the residual phase.
 
        /!\ It supposed that roket is enabled, and the associated GEO controller is index 1.
 
        Uses the projection matrix computed from compute_modes_to_volts_basis (modalBasis module)
 
        Parameters:
            projection_matrix : (np.ndarray) : Modal projection matrix
 
            selected_actus : (np.ndarray) : TODO : description
 
        Return:
            ai : (np.ndarray) : Modal coefficients
        """
        try:
            self.rtc.do_control(1, sources=self.target.sources)
        except:
            return [0]
        v = self.rtc.get_command(1)  # We compute here the residual phase on the DM modes. Gives the Equivalent volts to apply/
        if (selected_actus is None):
            ai = projection_matrix.dot(v) * 1000.  # np rms units
        else:  # Slaving actus case
            v2 = v[:-2][list(
                    selected_actus)]  # If actus are slaved then we select them.
            v3 = v[-2:]
            ai = projection_matrix.dot(np.concatenate((v2, v3))) * 1000.
        return ai