COMPASS  5.4.4
End-to-end AO simulation tool using GPU acceleration
shesha.supervisor.optimizers.calibration.Calibration Class Reference

This optimizer class handles all the modal basis and DM Influence functions related operations. More...

Collaboration diagram for shesha.supervisor.optimizers.calibration.Calibration:

Public Member Functions

def __init__ (self, config, tel, atmos, dms, target, rtc, wfs)
 
def apply_volts_and_get_slopes (self, int controller_index, *bool noise=False, bool turbu=False, bool reset=True)
 Apply voltages, raytrace, compute WFS image, compute slopes and returns it. More...
 
np.ndarray do_imat_modal (self, int controller_index, np.ndarray ampli, np.ndarray modal_basis, *bool noise=False, int nmodes_max=0, bool with_turbu=False, bool push_pull=False)
 Computes an interaction matrix from provided modal basis. More...
 
np.ndarray do_imat_phase (self, int controller_index, np.ndarray cube_phase, *bool noise=False, int nmodes_max=0, bool with_turbu=False, bool push_pull=False, int wfs_index=0)
 Computes an interaction matrix with the provided cube phase. More...
 
np.ndarray compute_modal_residuals (self, np.ndarray projection_matrix, *np.ndarray selected_actus=None)
 Computes the modal residual coefficients of the residual phase. More...
 

Detailed Description

This optimizer class handles all the modal basis and DM Influence functions related operations.

Definition at line 45 of file calibration.py.

Constructor & Destructor Documentation

◆ __init__()

def shesha.supervisor.optimizers.calibration.Calibration.__init__ (   self,
  config,
  tel,
  atmos,
  dms,
  target,
  rtc,
  wfs 
)

Definition at line 96 of file calibration.py.

Member Function Documentation

◆ apply_volts_and_get_slopes()

def shesha.supervisor.optimizers.calibration.Calibration.apply_volts_and_get_slopes (   self,
int  controller_index,
*bool   noise = False,
bool   turbu = False,
bool   reset = True 
)

Apply voltages, raytrace, compute WFS image, compute slopes and returns it.

Parameters
controller_index(int) : Controller index
noise(bool) : Flag to enable noise for WFS image computation. Default is False
turbu(bool) : Flag to enable atmosphere for WFS phase screen raytracing.
Default is False
reset : (bool) : Flag to reset previous phase screen before raytracing.
Default is True

Definition at line 123 of file calibration.py.

Here is the caller graph for this function:

◆ compute_modal_residuals()

np.ndarray shesha.supervisor.optimizers.calibration.Calibration.compute_modal_residuals (   self,
np.ndarray  projection_matrix,
*np.ndarray  selected_actus = None 
)

Computes the modal residual coefficients of the residual phase.

   It supposed that roket is enabled, and the associated GEO controller is index 1.

   Uses the projection matrix computed from compute_modes_to_volts_basis (modalBasis module)
Parameters
projection_matrix(np.ndarray) : Modal projection matrix
selected_actus(np.ndarray) : TODO : description
Returns
ai (np.ndarray) : Modal coefficients

Definition at line 257 of file calibration.py.

◆ do_imat_modal()

np.ndarray shesha.supervisor.optimizers.calibration.Calibration.do_imat_modal (   self,
int  controller_index,
np.ndarray  ampli,
np.ndarray  modal_basis,
*bool  noise = False,
int  nmodes_max = 0,
bool  with_turbu = False,
bool  push_pull = False 
)

Computes an interaction matrix from provided modal basis.

Parameters
controller_index(int) : Controller index
ampli(np.ndarray) : amplitude to apply on each mode
modal_basis(np.ndarray) : modal basis matrix
noise(bool) : Flag to enable noise for WFS image compuation. Default is False
nmodes_max(int) : Default is 0. TODO : description
with_turbu(bool) : Flag to enable atmosphere for WFS phase screen raytracing.
Default is False
push_pull : (bool) : If True, imat is computed as an average of push and pull ampli on each mode
Returns
modal_imat (np.ndarray) : Modal interaction matrix

Definition at line 159 of file calibration.py.

Here is the call graph for this function:

◆ do_imat_phase()

np.ndarray shesha.supervisor.optimizers.calibration.Calibration.do_imat_phase (   self,
int  controller_index,
np.ndarray  cube_phase,
*bool  noise = False,
int  nmodes_max = 0,
bool  with_turbu = False,
bool  push_pull = False,
int  wfs_index = 0 
)

Computes an interaction matrix with the provided cube phase.

Parameters
controller_index(int) : Controller index
cube_phase(np.ndarray) : Cube of phase to insert as NCPA
noise(bool) : Flag to enable noise for WFS image compuation. Default is False
nmodes_max(int) : Default is 0. TODO : description
with_turbu(bool) : Flag to enable atmosphere for WFS phase screen raytracing.
Default is False
push_pull : (bool) : If True, imat is computed as an average of push and pull ampli on each mode
wfs_index(int) : WFS index. Default is 0
Returns
phase_imat (np.ndarray) : Phase interaction matrix

Definition at line 214 of file calibration.py.

Here is the call graph for this function:

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