Shesha parameters configuration class. More...

Collaboration diagram for shesha.config.pconfig.ParamConfig:

Public Member Functions
def	__init__ (self, str param_file)

np.ndarray	get_pupil (self, pupil_type)
	Returns the specified pupil of COMPASS. More...

[Dict, Dict]	export_config (self)
	Extract and convert compass supervisor configuration parameters into 2 dictionnaries containing relevant AO parameters. More...

Public Attributes
	simul_name
	(str) : Simulation run name More...

	p_atmos
	(Param_atmos) : A Param_atmos instance More...

	p_tel
	(Param_tel) : A Param_tel instance More...

	p_geom
	(Param_geom) : A Param_geom instance More...

	p_wfss
	(List of Param_wfs) : List of Param_wfs instance More...

	p_dms
	(List of Param_dm) : List of Param_dm instance More...

	p_targets
	(List of Param_target) : List of Param_target instance More...

	p_loop
	(Param_loop) : A Param_loop instance More...

	p_centroiders
	(List of Param_centroider) : List of Param_centroider instance More...

	p_controllers
	(List of Param_controller) : List of Param controller instance More...

	p_coronos

Detailed Description

Shesha parameters configuration class.

It embeds all the parameters classes instances needed for the simulation run.

This class also exposes most useful getters from its components to allow an easier access and exposition through Pyro

Definition at line 51 of file pconfig.py.

Constructor & Destructor Documentation

◆ init()

def shesha.config.pconfig.ParamConfig.__init__	(		self,
		str	param_file
	)

Definition at line 105 of file pconfig.py.

Here is the call graph for this function:

Member Function Documentation

◆ export_config()

[Dict, Dict] shesha.config.pconfig.ParamConfig.export_config ( self )

Extract and convert compass supervisor configuration parameters into 2 dictionnaries containing relevant AO parameters.

Returns 2 dictionnaries

Definition at line 216 of file pconfig.py.

◆ get_pupil()

np.ndarray shesha.config.pconfig.ParamConfig.get_pupil	(	self,
		pupil_type
	)

Returns the specified pupil of COMPASS.

   Possible args value are :
       - "i" or "ipupil" : returns the biggest pupil of size (Nfft x Nfft)
       - "m" or "mpupil" : returns the medium pupil, used for WFS computation
       - "s" or "spupil" : returns the smallest pupil of size (p_geom.pupdiam x p_geom.pupdiam)

Returns: pupil (np.ndarray) : pupil

Definition at line 202 of file pconfig.py.

Member Data Documentation

◆ p_atmos

shesha.config.pconfig.ParamConfig.p_atmos

(Param_atmos) : A Param_atmos instance

Definition at line 108 of file pconfig.py.

◆ p_centroiders

shesha.config.pconfig.ParamConfig.p_centroiders

(List of Param_centroider) : List of Param_centroider instance

Definition at line 115 of file pconfig.py.

◆ p_controllers

shesha.config.pconfig.ParamConfig.p_controllers

(List of Param_controller) : List of Param controller instance

Definition at line 116 of file pconfig.py.

◆ p_coronos

shesha.config.pconfig.ParamConfig.p_coronos

Definition at line 117 of file pconfig.py.

◆ p_dms

shesha.config.pconfig.ParamConfig.p_dms

(List of Param_dm) : List of Param_dm instance

Definition at line 112 of file pconfig.py.

◆ p_geom

shesha.config.pconfig.ParamConfig.p_geom

(Param_geom) : A Param_geom instance

Definition at line 110 of file pconfig.py.

◆ p_loop

shesha.config.pconfig.ParamConfig.p_loop

(Param_loop) : A Param_loop instance

Definition at line 114 of file pconfig.py.

◆ p_targets

shesha.config.pconfig.ParamConfig.p_targets

(List of Param_target) : List of Param_target instance

Definition at line 113 of file pconfig.py.

◆ p_tel

shesha.config.pconfig.ParamConfig.p_tel

(Param_tel) : A Param_tel instance

Definition at line 109 of file pconfig.py.

◆ p_wfss

shesha.config.pconfig.ParamConfig.p_wfss

(List of Param_wfs) : List of Param_wfs instance

Definition at line 111 of file pconfig.py.

◆ simul_name

shesha.config.pconfig.ParamConfig.simul_name

(str) : Simulation run name

Definition at line 107 of file pconfig.py.

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

pconfig.py

Public Member Functions

Public Attributes