sourceCompass.py

 
from typing import List
 
class SourceCompass(object):
    """ Source handler for compass simulation
 
    Attributes:
        sources : (List) : List of SutraSource instances
    """
    def __init__(self, sources : List):
        """ Initialize a SourceCompass component for target and wfs source related supervision
 
        Args:
            sources : (List) : List of SutraSource instances
        """
        self.sourcessources = sources
 
    def raytrace(self, index, *, tel=None, atm=None, dms=None, ncpa : bool=True, reset : bool = True, comp_avg_var : bool = True) -> None:
        """ Performs the raytracing operation through provided object phase screens
        to obtain the phase screen of the SutraSource
 
        Args:
            index : (int) : Index of the source  to raytrace in self.sources list
 
        Kwargs:
            tel : (TelescopeCompass) : TelescopeCompass instance.
                                                 If provided, raytrace through the telescope aberration phase in the pupil
 
            atm : (AtmosCompass) : AtmosCompass instance.
                                            If provided, raytrace through the layers phase screens
 
            dms : (dmsCompass) : DmCompass instance.
                                            If provided, raytrace through the DM shapes
 
            ncpa : (bool) : If True (default), raytrace through NCPA phase screen of the source (default is array of 0, i.e. no impact)
 
            reset: (bool): reset the phase screen before raytracing. Default is True
        """
        if (reset):
            self.sourcessources[index].d_phase.reset()
 
        if atm is not None:
            self.sourcessources[index].raytrace(atm._atmos) # Must be done first because of automatic reset of the phase screen when call
        if tel is not None:
            self.sourcessources[index].raytrace(tel._tel)
        if ncpa:
            self.sourcessources[index].raytrace()
        if dms is not None:
            self.sourcessources[index].raytrace(dms._dms, do_phase_var=comp_avg_var)