OOPAO 1.0.0__py3-none-any.whl

OOPAO/Asterism.py

@@ -0,0 +1,287 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Tue Aug 23 14:35:32 2022
+
+@author: cheritie
+"""
+import numpy as np
+import matplotlib.pyplot as plt
+from OOPAO.tools.displayTools import makeSquareAxes
+from OOPAO.runtime import array_backend
+
+_xp, _gpu_flag = array_backend()
+
+
+def _on_gpu(items):
+    return _gpu_flag and any(isinstance(item, _xp.ndarray) for item in items)
+
+
+def _stack(items):
+    """np.array(items), or a CuPy stack when the sources hold GPU-resident arrays (np.array would refuse them)."""
+    if _on_gpu(items):
+        return _xp.stack([_xp.asarray(item) for item in items])
+    return np.array(items)
+
+
+def _object_array(items):
+    """np.array(items, dtype=object); with GPU-resident arrays, a 1D object array holding them."""
+    if _on_gpu(items):
+        out = np.empty(len(items), dtype=object)
+        for i, item in enumerate(items):
+            out[i] = item
+        return out
+    return np.array(items, dtype=object)
+
+
+class Asterism:
+    def __init__(self,
+                 list_src: list):
+        """
+        ************************** REQUIRED PARAMETERS **************************
+
+        An Asterism object is an asterism of Source objects. It requires the following parameters:
+
+        _ list_src              : a list of Source objects that can combine NGS and LGS types
+
+        ************************** COUPLING AN ASTERISM OBJECT **************************
+
+        Once generated, an asterism  object "ast" can be coupled to a Telescope "tel" that contains the OPD.
+        _ This is achieved using the * operator     : ast*tel
+        _ It can be accessed using                  : tel.src
+
+
+        ************************** MAIN PROPERTIES **************************
+
+        The main properties of a Telescope object are listed here:
+        _ ast.coordinates   : coordinates of the source objects
+        _ ast.altitude      : altitude of the source objects
+        _ ast.nPhoton       : nPhoton property of the source objects
+
+        ************************** EXEMPLE **************************
+
+        Create a list of source object in H band with a magnitude 8 and combine it to the telescope
+
+        src_1 = Source(opticalBand = 'H', magnitude = 8, coordinates=[0,0])
+        src_2 = Source(opticalBand = 'H', magnitude = 8, coordinates=[60,0])
+        src_3 = Source(opticalBand = 'H', magnitude = 8, coordinates=[60,120])
+        src_4 = Source(opticalBand = 'H', magnitude = 8, coordinates=[60,240])
+
+        ast = Asterism([src_1,src_2,src_3, src_4])
+
+
+        """
+
+        self.n_source = len(list_src)
+        self.src = list_src
+
+        for i, src in enumerate(self.src):
+            src.inAsterism = True
+            src.ast_idx = i
+        self.chromatic_shift = None
+        print(self)
+        self.tag = 'asterism'
+        self.type = 'asterism'
+        self.wavelength = self.src[0].wavelength
+
+    @property
+    def laser_coordinates(self):
+        _laser_coordinates = []
+        for src in self.src:
+            _laser_coordinates.append(src.laser_coordinates)
+        return _laser_coordinates
+
+    @property
+    def Na_profile(self):
+        _Na_profile = []
+        for src in self.src:
+            _Na_profile.append(src.Na_profile)
+        return _Na_profile
+
+    @property
+    def fwhm_spot_up(self):
+        _fwhm_spot_up = []
+        for src in self.src:
+            _fwhm_spot_up.append(src.fwhm_spot_up)
+        return _fwhm_spot_up
+ 
+    @property
+    def fluxMap(self):
+        _fluxMap = []
+        for src in self.src:
+            _fluxMap.append(src.fluxMap)
+        return _fluxMap
+
+    @property
+    def phase(self):
+        _phase = []
+        for src in self.src:
+            _phase.append(src.phase)
+        return _phase
+
+    @phase.setter
+    def phase(self, val):
+        for src in self.src:
+            src.phase = val[src.ast_idx]
+
+    @property
+    def phase_no_pupil(self):
+        _phase_no_pupil = []
+        for src in self.src:
+            _phase_no_pupil.append(src.phase_no_pupil)
+        return _phase_no_pupil
+
+    @property
+    def coordinates(self):
+        _coordinates = []
+        for src in self.src:
+            _coordinates.append(src.coordinates)
+        return _coordinates
+
+    @property
+    def altitude(self):
+        _altitude = []
+        for src in self.src:
+            _altitude.append(src.altitude)
+        return _altitude
+
+    @property
+    def nPhoton(self):
+        _nPhoton = []
+        for src in self.src:
+            _nPhoton.append(src.nPhoton)
+        return _nPhoton
+
+    @property
+    def OPD(self):
+        _OPD = []
+        for src in self.src:
+            _OPD.append(src.OPD)
+        return _stack(_OPD)
+
+    @property
+    def OPD_no_pupil(self):
+        _OPD_no_pupil = []
+        for src in self.src:
+            _OPD_no_pupil.append(src.OPD_no_pupil)
+        return _stack(_OPD_no_pupil)
+    
+    @property
+    def scintillation(self):
+        _scintillation = []
+        for src in self.src:
+            _scintillation.append(getattr(src, 'scintillation', None))
+        return _object_array(_scintillation)
+
+    @scintillation.setter
+    def scintillation(self, val):
+        for src in self.src:
+            src.scintillation = val[src.ast_idx]
+
+    @property
+    def scintillation_no_pupil(self):
+        _scintillation_no_pupil = []
+        for src in self.src:
+            _scintillation_no_pupil.append(getattr(src, 'scintillation_no_pupil', None))
+        return _object_array(_scintillation_no_pupil)
+
+    @property
+    def intensity(self):
+        # Aggregated field intensity (fluxMap * scintillation) of each source.
+        # This is the energy-bearing quantity; the per-source intensity is kept
+        # as a SINGLE array on each Source so a FieldTransformer warp conserves
+        # energy (no W(flux)*W(scint) cross-term). dtype=object mirrors the
+        # scintillation aggregation since sources may have None / differently
+        # shaped intensities (e.g. before propagation, or NGS vs LGS).
+        _intensity = []
+        for src in self.src:
+            _intensity.append(getattr(src, 'intensity', None))
+        return _object_array(_intensity)
+
+    @intensity.setter
+    def intensity(self, val):
+        # Distribute a per-source intensity back to each Source so a
+        # FieldTransformer can write warped intensities the same way it does
+        # for scintillation. After such a write the per-source fluxMap /
+        # scintillation are stale relative to intensity -- intensity is the
+        # authoritative amplitude path (amplitude = sqrt(intensity)).
+        for src in self.src:
+            src.intensity = val[src.ast_idx]
+
+    def __pow__(self, obj):
+        # Re-propagation function. Same as .* in OOMAO
+        obj.src = self
+        for src in self.src:
+            src.optical_path = [[src.type + '('+src.optBand+')', src]]
+        self.reset()
+        self*obj
+        return self
+
+    def __mul__(self, obj):
+        # Propagation function.
+        if obj is not None:
+            if isinstance(obj, list):
+                for i in range(len(obj)):
+                    self*obj[i]
+            else:
+                obj.relay(self)
+        return self
+
+    def reset(self):
+        for src in self.src:
+            src.reset()
+
+    def print_optical_path(self):
+        for src in self.src:
+            src.print_optical_path()
+
+    # for backward compatibility
+    def print_properties(self):
+        print(self)
+
+    def display_asterism(self):
+        plt.figure()
+        x = np.linspace(0, 2*np.pi, 100, endpoint=True)
+        r = np.linspace(0, max(self.coordinates)[0], 6, endpoint=True)
+        for i_circle in range(1, 6):
+            plt.plot(r[i_circle]*np.cos(x), r[i_circle]*np.sin(x), '--k')
+            cm = plt.get_cmap('gist_rainbow')
+        for i_src in range(self.n_source):
+            if self.src[i_src].type == "NGS":
+                marker = '*'
+                size_marker = 20
+            else:
+                marker = '*'
+                size_marker = 10
+            plt.plot(self.src[i_src].coordinates[0]*np.cos(np.deg2rad(self.src[i_src].coordinates[1])),
+                     self.src[i_src].coordinates[0]*np.sin(np.deg2rad(self.src[i_src].coordinates[1])),
+                     marker,
+                     markersize=size_marker,
+                     color=cm(1.*i_src/self.n_source),
+                     markeredgecolor='k',
+                     label=self.src[i_src].type+'_'+str(i_src))
+        makeSquareAxes()
+        plt.xlabel('[Arcsec]')
+        plt.ylabel('[Arcsec]')
+        plt.legend()
+
+    def properties(self) -> dict:
+        self.prop = dict()
+        self.prop['parameters'] = f"{'Source':^8s}|{'Wavelength':^12s}|{'Zenith':^8s}|{'Azimuth':^9s}|{'Altitude':^10s}|{'Magnitude':^11s}|{'Flux':^11s}|"
+        self.prop['units'] = f"{'':^8s}|{'[m]':^12s}|{'[arcsec]':^8s}|{'[°]':^9s}|{'[m]':^10s}|{'':^11s}|{'[ph/m²/s]':^11s}|"
+        for i in range(self.n_source):
+            if i % 2 == 0:
+                self.prop['layer_%02d'%i] = f"\033[00m{'%3d-%s'%(i+1,self.src[i].type):^8s}|{self.src[i].wavelength:^12.1e}|{self.src[i].coordinates[0]:^8.2f}|{self.src[i].coordinates[1]:^9.2f}|{self.src[i].altitude:^10.2f}|{self.src[i]._magnitude:^11.2f}|{self.src[i]._nPhoton:^11.1e}|"
+            else:
+                self.prop['layer_%02d'%i] = f"\033[47m{'%3d-%s'%(i+1,self.src[i].type):^8s}|{self.src[i].wavelength:^12.1e}|{self.src[i].coordinates[0]:^8.2f}|{self.src[i].coordinates[1]:^9.2f}|{self.src[i].altitude:^10.2f}|{self.src[i]._magnitude:^11.2f}|{self.src[i]._nPhoton:^11.1e}|"
+        return self.prop
+
+    def __repr__(self):
+        self.properties()
+        str_prop = str()
+        n_char = len(max(self.prop.values(), key=len)) - len('\033[00m')
+        for i in range(len(self.prop.values())):
+            str_prop += list(self.prop.values())[i] + '\n'
+        title = f'\n{" Asterism ":-^{n_char}}\n'
+        end_line = f'\033[00m{"":-^{n_char}}\n'
+        table = title + str_prop + end_line
+        return table