WIP documentation. Version now 1.0.0 (METIS-FDR)

.gitignore

@@ -135,10 +135,11 @@ dmypy.json
 *.tar.gz
 data/wavefront
 .idea/
+scripts/
 data/_archives/
 *bat
 *fits
-/data/pupil/eso
+data/pupil/eso
 !data/pupil/ELT_fullM1.fits
 !data/pupil/ls_CVC_L_285_dRext=0.0209_dRint=0.09_dRspi=0.0245.fits
 !data/pupil/ls_CVC_N2_119_dRext=0.0268_dRint=0.09_dRspi=0.0357.fits

config/config_demo_metis_compass.py

@@ -28,7 +28,7 @@
     # =======
     #    0. mode = 'ELT'  for no coronagraph (only telescope)
     #    1. mode = 'CVC'  for Classical Vortex Coronagraph
-    #    (2. mode = 'RAVC' for Ring Apodized Vortex Coronagraph)
+    #    2. mode = 'RAVC' for Ring Apodized Vortex Coronagraph
     #    (3. mode = 'APP'  for Apodizing Phase Plate)
     inst_mode = 'ELT',                  # HCI instrument mode
     vc_charge = 2,                      # (CVC and RAVC only) vortex topological charge
@@ -45,7 +45,6 @@
     # # CVC N2-band: ls_CVC_N2_119_dRext=0.0268_dRint=0.09_dRspi=0.0357.fits
     # # RAVC L-band: ls_RAVC_L_285_dRext=0.0477_dRint=0.04_dRspi=0.0249.fits
 
-
     # RAVC LS L-band:
     f_lyot_stop = _tmp_dir + 'pupil/ls_RAVC_L_285_dRext=0.0477_dRint=0.04_dRspi=0.0249.fits',
 

psi/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '1.0.0'

psi/configParser.py

@@ -51,7 +51,6 @@ class Parameters(object):
         ``ncpa_dynamic``            -
         ``ncpa_sampling``           -
         ``ncpa_scaling``            -
-        ``ncpa_expected_rms``       -
         ``ncpa_folder``             -
         ``ncpa_prefix``             -
         ``turb_folder``             -
@@ -71,6 +70,9 @@ def __init__(self, filename, logger=LazyLogger('Params')):
         self.logger = logger
 
     def readfile(self):
+        '''
+        Read configuration file -> create `conf` namespace
+        '''
 
         #Exec the config file, which should contain a dict ``simConfiguration``
         try:
@@ -85,6 +87,9 @@ def readfile(self):
         self.params = conf
 
     def check_parameters(self):
+        '''
+            Performs a number of sanity checks on the configuration parameters
+        '''
         # TODO had a check that the Lyot stop is for the correct mode and band
         #       look at the file name and search for strings
 
@@ -139,6 +144,9 @@ def check_parameters(self):
             self.params.save_results = True
 
     def compute_parameters(self):
+        '''
+        Compute some parameters based on the configuration file parameters
+        '''
         self.params.nb_ao_frames_per_science = int(self.params.dit / \
             (self.params.ao_frame_decimation / self.params.ao_framerate))
 
@@ -151,6 +159,9 @@ def compute_parameters(self):
 
 
 def loadConfiguration(filename):
+        '''
+        Load the configuration file and return a configuration object.
+        '''
         cfg_obj = Parameters(filename)
 
         cfg_obj.readfile()

psi/instruments.py

@@ -76,14 +76,14 @@ def aperture(self, aper):
         self._aperture = aper
 
     @abc.abstractmethod
-    def grabWfsTelemetry(self):
+    def grabWfsTelemetry(self, nbOfSeconds):
         '''
         Grab wavefront sensor telemetry and returns wavefront buffer
         '''
         pass
 
     @abc.abstractmethod
-    def grabScienceImages(self):
+    def grabScienceImages(self, nbOfSeconds):
         '''
         Grab science images and returns science images buffer
         '''
@@ -355,6 +355,17 @@ def _update_water_vapour(self, current_time):
     def grabScienceImages(self, nbOfPastSeconds):
         '''
             Grab a buffer of science images
+
+            Parameters
+            ------------
+            nbOfPastSeconds : float
+                number of seconds of science images (can be equivalent to one or several images)
+
+            Returns
+            --------
+            image_buffer  : numpy ndarray
+                science image buffer of dimension (nbOfSciImages, nx, ny)
+
         '''
         self.nbOfSciImages = int(nbOfPastSeconds / self.sci_exptime)
         assert self.nbOfSciImages <= nbOfPastSeconds / self.sci_exptime
@@ -485,8 +496,17 @@ def _grabOneScienceImage(self):
 
     def grabWfsTelemetry(self, nbOfPastSeconds):
         '''
+        Grab a buffer of WFS telemetry
+
+        Parameters
+        ------------
+        nbOfPastSeconds : float
+            number of seconds of science images (can be equivalent to one or several images)
+
         Returns
-                phase cube in units of radian
+        --------
+        phase_cube  : numpy ndarray
+            phase cube in units of radian
         '''
         # self._compass_start_time=2011 # COMPASS 0 indexing in msec
 
@@ -524,10 +544,28 @@ def grabWfsTelemetry(self, nbOfPastSeconds):
         return phase_cube
 
     def setNcpaCorrection(self, phase):
+        '''
+            Apply NCPA correction
+
+            Parameters
+            ----------
+            phase : numpy ndarray
+                phase correction to be applied
+        '''
         self.phase_ncpa_correction = self.phase_ncpa_correction + phase
 
     def synchronizeBuffers(self, wfs_telemetry_buffer, sci_image_buffer):
         '''
+            Synchronize science and wfs telemetry buffers
+
+            Parameters
+            ----------
+            wfs_telemetry_buffer : numpy ndarray
+                WFS telemetry buffer as returned by 'grabWfsTelemetry'
+            sci_image_buffer : numpy ndarray
+                Science image buffer as returned by 'grabScienceImages'
+
+
             Note:
                 wfs_telemetry_buffer & sci_image_buffer are actually not used here.
                 To be realistic, one could correlate the tip-tilt in both to sync them.
@@ -553,6 +591,11 @@ def synchronizeBuffers(self, wfs_telemetry_buffer, sci_image_buffer):
         return telemetry_indexing
 
     def getNumberOfPhotons(self):
+        '''
+            Returns
+            --------
+            Number of photons for a single science exposure
+        '''
         return self.num_photons
 
 class DemoCompassSimInstrument(CompassSimInstrument):
@@ -651,8 +694,17 @@ def _grabOneScienceImage(self):
 
     def grabWfsTelemetry(self, nbOfPastSeconds):
         '''
+        Grab a buffer of WFS telemetry
+
+        Parameters
+        ------------
+        nbOfPastSeconds : float
+            number of seconds of science images (can be equivalent to one or several images)
+
         Returns
-                phase cube in units of radian
+        --------
+        phase_cube  : numpy ndarray
+            phase cube in units of radian
         '''
         # self._compass_start_time=2011 # COMPASS 0 indexing in msec
 
@@ -690,10 +742,18 @@ def grabWfsTelemetry(self, nbOfPastSeconds):
         return phase_cube
 
 class HcipySimInstrument(GenericInstrument):
+    '''
+    Not implemented
+    '''
+    # raise NotImplementedError()
     pass
 
 
 class ErisInterfaceOffline(GenericInstrument):
+    '''
+    Not implemented
+    '''
+    # raise NotImplementedError()
     pass