shesha.supervisor.compassSupervisor.CompassSupervisor Class Reference

This class implements generic supervisor to handle compass simulation. More...

Inheritance diagram for shesha.supervisor.compassSupervisor.CompassSupervisor:

Collaboration diagram for shesha.supervisor.compassSupervisor.CompassSupervisor:

Public Member Functions
def	__init__ (self, config, bool cacao=False)
None	next (self, *bool move_atmos=True, int nControl=0, Iterable[int] tar_trace=None, Iterable[int] wfs_trace=None, bool do_control=True, bool apply_control=True, bool compute_tar_psf=True)
	Iterates the AO loop, with optional parameters. More...
def	record_ao_circular_buffer (self, int cb_count, np.ndarray projection_matrix, int sub_sample=1, int controller_index=0, int tar_index=0, bool see_atmos=True, str cube_data_type=None, str cube_data_file_path="", int ncpa=0, np.ndarray ncpa_wfs=None, np.ndarray ref_slopes=None, bool ditch_strehl=True)
	Used to record a synchronized circular buffer AO loop data. More...
Public Member Functions inherited from shesha.supervisor.genericSupervisor.GenericSupervisor
def	__init__ (self, config)
def	get_config (self)
	Returns the configuration in use, in a supervisor specific format ? More...
int	get_frame_counter (self)
	Return the current iteration number of the loop. More...
None	force_context (self)
	Active all the GPU devices specified in the parameters file. More...
def	loop (self, int number_of_iter, *int monitoring_freq=100, bool compute_tar_psf=True, **kwargs)
	Perform the AO loop for <number_of_iter> iterations. More...
def	reset (self)
	Reset the simulation to return to its original state. More...

Public Attributes
	cacao
	Instantiates a CompassSupervisor object. More...
	basis
	calibration
	tel
	atmos
	dms
	target
	wfs
	rtc
Public Attributes inherited from shesha.supervisor.genericSupervisor.GenericSupervisor
	context
	config
	telescope
	atmos
	target
	wfs
	dms
	rtc
	is_init
	iter
	Init the a supervisor. More...

Detailed Description

This class implements generic supervisor to handle compass simulation.

Definition at line 57 of file compassSupervisor.py.

Constructor & Destructor Documentation

__init__()

def shesha.supervisor.compassSupervisor.CompassSupervisor.__init__	(		self,
			config,
		bool	cacao = False
	)

Definition at line 119 of file compassSupervisor.py.

            raise ValueError("Configuration not loaded or Telescope not initilaized")
 
    def _init_wfs(self):
        """Initialize the wfs component of the supervisor as a WfsCompass
        """ 
        if self.tel is not None:
            self.wfs = WfsCompass(self.context, self.config, self.tel)
        else:
            raise ValueError("Configuration not loaded or Telescope not initilaized")
 
    def _init_rtc(self):

Member Function Documentation

next()

None shesha.supervisor.compassSupervisor.CompassSupervisor.next	(		self,
		*bool	move_atmos = True,
		int	nControl = 0,
		Iterable[int]	tar_trace = None,
		Iterable[int]	wfs_trace = None,
		bool	do_control = True,
		bool	apply_control = True,
		bool	compute_tar_psf = True
	)

Iterates the AO loop, with optional parameters.

   Overload the GenericSupervisor next() method to handle the GEO controller
   specific raytrace order operations

Parameters

move_atmos (bool), optional: move the atmosphere for this iteration. Default is True

nControl (int, optional): Controller number to use. Default is 0 (single control configuration)

tar_trace (List, optional): list of targets to trace. None is equivalent to all (default)

wfs_trace (List, optional): list of WFS to trace. None is equivalent to all (default)

do_control (bool, optional) : Performs RTC operations if True (Default)

apply_control (bool): (optional) if True (default), apply control on DMs

compute_tar_psf (bool, optional) : If True (default), computes the PSF at the end of the iteration

Reimplemented from shesha.supervisor.genericSupervisor.GenericSupervisor.

Definition at line 201 of file compassSupervisor.py.

    def record_ao_circular_buffer(
            self, cb_count: int, projection_matrix : np.ndarray, sub_sample: int = 1, controller_index: int = 0,
            tar_index: int = 0, see_atmos: bool = True, cube_data_type: str = None,
            cube_data_file_path: str = "", ncpa: int = 0, ncpa_wfs: np.ndarray = None,
            ref_slopes: np.ndarray = None, ditch_strehl: bool = True):
        """ Used to record a synchronized circular buffer AO loop data.
 
        Parameters:
            cb_count: (int) : the number of iterations to record.
 
            projection_matrix : (np.ndarray) : projection matrix on modal basis to compute residual coefficients
 
            sub_sample:  (int) : sub sampling of the data (default=1, I.e no subsampling)
 
            controller_index:  (int) :
 
            tar_index:  (int) : target number
 
            see_atmos:  (int) : used for the next function to enable or not the Atmos
 
            cube_data_type:   (int) : if  specified ("tarPhase" or "psfse") returns the target phase or short exposure PSF data cube in the output variable
 
            cube_data_file_path:  (int) : if specified it will also save the target phase cube data (full path on the server)
 
            ncpa:  (int) : !!experimental!!!: Used only in the context of PYRWFS + NCPA compensation on the fly (with optical gain)
            defines how many iters the NCPA refslopes are updates with the proper optical gain. Ex: if NCPA=10 refslopes will be updates every 10 iters.
 
            ncpa_wfs:  (int) : the ncpa phase as seen from the wfs array with dims = size of Mpupil
 
            ref_slopes:  (int) : the reference slopes to use.
 
            ditch_strehl:  (int) : resets the long exposure SR computation at the beginning of the Circular buffer (default= True)
 
        Return:
            slopes:  (int) : the slopes CB
 
            volts:  (int) : the volts applied to the DM(s) CB
 
            ai:  (int) : the modal coefficient of the residual phase projected on the currently used modal Basis
 
            psf_le:  (int) : Long exposure PSF over the <cb_count> iterations (I.e SR is reset at the begining of the CB if ditch_strehl=True)
 
            sthrel_se_list:  (int) : The SR short exposure evolution during CB recording
 

Here is the caller graph for this function:

record_ao_circular_buffer()

def shesha.supervisor.compassSupervisor.CompassSupervisor.record_ao_circular_buffer	(		self,
		int	cb_count,
		np.ndarray	projection_matrix,
		int	sub_sample = 1,
		int	controller_index = 0,
		int	tar_index = 0,
		bool	see_atmos = True,
		str	cube_data_type = None,
		str	cube_data_file_path = "",
		int	ncpa = 0,
		np.ndarray	ncpa_wfs = None,
		np.ndarray	ref_slopes = None,
		bool	ditch_strehl = True
	)

Used to record a synchronized circular buffer AO loop data.

Parameters

cb_count (int) : the number of iterations to record.

projection_matrix (np.ndarray) : projection matrix on modal basis to compute residual coefficients

sub_sample (int) : sub sampling of the data (default=1, I.e no subsampling)

controller_index (int) :

tar_index (int) : target number

see_atmos (int) : used for the next function to enable or not the Atmos

cube_data_type (int) : if specified ("tarPhase" or "psfse") returns the target phase or short exposure PSF data cube in the output variable

cube_data_file_path (int) : if specified it will also save the target phase cube data (full path on the server)

ncpa (int) : !!experimental!!!: Used only in the context of PYRWFS + NCPA compensation on the fly (with optical gain) defines how many iters the NCPA refslopes are updates with the proper optical gain. Ex: if NCPA=10 refslopes will be updates every 10 iters.

ncpa_wfs (int) : the ncpa phase as seen from the wfs array with dims = size of Mpupil

ref_slopes (int) : the reference slopes to use.

ditch_strehl (int) : resets the long exposure SR computation at the beginning of the Circular buffer (default= True)

Return

slopes (int) : the slopes CB

volts (int) : the volts applied to the DM(s) CB

ai (int) : the modal coefficient of the residual phase projected on the currently used modal Basis

psf_le (int) : Long exposure PSF over the <cb_count> iterations (I.e SR is reset at the begining of the CB if ditch_strehl=True)

sthrel_se_list (int) : The SR short exposure evolution during CB recording

sthrel_le_list (int) : The SR long exposure evolution during CB recording

g_ncpa_list (int) : the gain applied to the NCPA (PYRWFS CASE) if NCPA is set to True

cube_data (int) : the tarPhase or psfse cube data (see cube_data_type)

Definition at line 290 of file compassSupervisor.py.

            self.next()
            for t in range(len(self.config.p_targets)):
                self.target.comp_tar_image(t)
 
            srse, srle, _, _ = self.target.get_strehl(tar_index)
            sthrel_se_list.append(srse)
            sthrel_le_list.append(srle)
            if (j % sub_sample == 0):
                ai_vector = self.calibration.compute_modal_residuals(projection_matrix, selected_actus=self.basis.selected_actus)
                if (ai_data is None):
                    ai_data = np.zeros((len(ai_vector), int(cb_count / sub_sample)))
                ai_data[:, k] = ai_vector
 
                slopes_vector = self.rtc.get_slopes(controller_index)
                if (slopes_data is None):
                    slopes_data = np.zeros((len(slopes_vector),
                                            int(cb_count / sub_sample)))
                slopes_data[:, k] = slopes_vector
 
                volts_vector = self.rtc.get_command(controller_index) # get_command or get_voltages ?
                if (volts_data is None):
                    volts_data = np.zeros((len(volts_vector),
                                           int(cb_count / sub_sample)))
                volts_data[:, k] = volts_vector
 
                if (cube_data_type):
                    if (cube_data_type == "tarPhase"):
                        dataArray = self.target.get_tar_phase(tar_index, pupil=True)
                    elif (cube_data_type == "psfse"):
                        dataArray = self.target.get_tar_image(tar_index, expo_type="se")
                    else:
                        raise ValueError("unknown dataData" % cube_data_type)
                    if (cube_data is None):
                        cube_data = np.zeros((*dataArray.shape,
                                              int(cb_count / sub_sample)))
                    cube_data[:, :, k] = dataArray
                k += 1
        if (cube_data_file_path != ""):
            print("Saving tarPhase cube at: ", cube_data_file_path)
            pfits.writeto(cube_data_file_path, cube_data, overwrite=True)
 
        psf_le = self.target.get_tar_image(tar_index, expo_type="le")
        return slopes_data, volts_data, ai_data, psf_le, sthrel_se_list, sthrel_le_list, g_ncpa_list, cube_data

Here is the call graph for this function:

Member Data Documentation

atmos

shesha.supervisor.compassSupervisor.CompassSupervisor.atmos

(AtmosComponent) : An AtmosComponent instance

Definition at line 142 of file compassSupervisor.py.

basis

shesha.supervisor.compassSupervisor.CompassSupervisor.basis

Definition at line 122 of file compassSupervisor.py.

cacao

shesha.supervisor.compassSupervisor.CompassSupervisor.cacao

Instantiates a CompassSupervisor object.

(bool) : CACAO features enabled in the RTC

Parameters

config (config module) : Configuration module

cacao (bool, optional) : If True, enables CACAO features in RTC (Default is False) /!\ Requires OCTOPUS to be installed

Definition at line 120 of file compassSupervisor.py.

calibration

shesha.supervisor.compassSupervisor.CompassSupervisor.calibration

Definition at line 123 of file compassSupervisor.py.

dms

shesha.supervisor.compassSupervisor.CompassSupervisor.dms

(DmComponent) : A DmComponent instance

Definition at line 149 of file compassSupervisor.py.

rtc

shesha.supervisor.compassSupervisor.CompassSupervisor.rtc

(RtcComponent) : A Rtc component instance

Definition at line 177 of file compassSupervisor.py.

target

shesha.supervisor.compassSupervisor.CompassSupervisor.target

(targetComponent) : A TargetComponent instance

Definition at line 157 of file compassSupervisor.py.

tel

shesha.supervisor.compassSupervisor.CompassSupervisor.tel

Definition at line 135 of file compassSupervisor.py.

wfs

shesha.supervisor.compassSupervisor.CompassSupervisor.wfs

(WfsComponent) : A WfsComponent instance

Definition at line 167 of file compassSupervisor.py.

---

The documentation for this class was generated from the following file:

• compassSupervisor.py