telescopeCompass.py

 
from shesha.init.geom_init import tel_init
import numpy as np
 
 
class TelescopeCompass(object):
    """ Telescope handler for compass simulation
 
    Attributes:
        _tel : (sutraWrap.Tel) : Sutra telescope instance
 
        _context : (carmaContext) : CarmaContext instance
 
        _config : (config module) : Parameters configuration structure module
    """
 
    def __init__(self, context, config):
        """ Initialize an AtmosCompass component for atmosphere related supervision
 
        Args:
            context : (carmaContext) : CarmaContext instance
 
            config : (config module) : Parameters configuration structure module
        """
        self._context_context = context
        self._config_config = config  # Parameters configuration coming from supervisor init
        if self._config_config.p_atmos is not None:
            r0 = self._config_config.p_atmos.r0
        else:
            raise ValueError('A r0 value through a Param_atmos is required.')
 
        if self._config_config.p_loop is not None:
            ittime = self._config_config.p_loop.ittime
        else:
            raise ValueError(
                    'An ittime (iteration time in seconds) value through a Param_loop is required.'
            )
        print("->telescope init")
        self._tel_tel = tel_init(self._context_context, self._config_config.p_geom, self._config_config.p_tel, r0,
                             ittime, self._config_config.p_wfss)
 
    def set_input_phase(self, phase : np.ndarray):
        """ Set a circular buffer of phase screens to be raytraced as a 
        Telescope layer. Buffer size shall be (mpup size, mpup size, N).
 
        Args:
            phase : (np.ndarray[ndim=3, dtype=float]) : circular buffer of phase screen
        """
        if (phase.ndim != 3 or phase.shape[0] != self._config_config.p_geom._mpupil.shape[0] or phase.shape[1] != self._config_config.p_geom._mpupil.shape[1]):
            print("Input shall be a np.ndarray of dimensions (mpup size, mpup size, N)")
            return
        self._tel_tel.set_input_phase(phase)
    
    def update_input_phase(self):
        """ Update the index of the current phase screen in the circular buffer, so it passes to the next one
        """
        self._tel_tel.update_input_phase()
 
    def reset_input_phase(self):
        """ Reset circular buffer d_input_phase
        """
        self._tel_tel.reset_input_phase()
        
    def get_input_phase(self):
        """ Return the circular buffer of telescope phase screens
 
        Returns:
            phase : (np.ndarray[ndim=3, dtype=float]) : circular buffer of phase screen
        """
        if (self._tel_tel.d_input_phase is None):
            return None
        return np.array(self._tel_tel.d_input_phase)
    
    def get_input_phase_counter(self):
        """ Return the index of the current phase screen to be raytraced inside the telescope circular buffer
 
        Returns:
            counter : (int) : Phase screen index in the circular buffer
        """
        return self._tel_tel.input_phase_counter