Initialization of a Rtc object. More...

Functions
def	rtc_init (carmaWrap_context context, Telescope tel, Sensors wfs, Dms dms, Atmos atmos, list p_wfss, conf.Param_tel p_tel, conf.Param_geom p_geom, conf.Param_atmos p_atmos, float ittime, p_centroiders=None, p_controllers=None, p_dms=None, do_refslp=False, brahma=False, cacao=False, tar=None, dataBase={}, use_DB=False)
	Initialize all the SutraRtc objects : centroiders and controllers. More...

Rtc	rtc_standalone (carmaWrap_context context, int nwfs, list nvalid, int nactu, list centroider_type, list delay, list offset, list scale, bool brahma=False, bool fp16=False, bool cacao=False)
	Initialize all the SutraRtc objects : centroiders and controllers. More...

def	init_centroider (context, int nwfs, conf.Param_wfs p_wfs, conf.Param_centroider p_centroider, conf.Param_tel p_tel, conf.Param_atmos p_atmos, Sensors wfs, Rtc rtc)
	Initialize a centroider object in Rtc. More...

def	comp_weights (conf.Param_centroider p_centroider, conf.Param_wfs p_wfs, int npix)
	Compute the weights used by centroider wcog and corr. More...

def	init_controller (context, int i, conf.Param_controller p_controller, list p_wfss, conf.Param_geom p_geom, list p_dms, conf.Param_atmos p_atmos, float ittime, conf.Param_tel p_tel, Rtc rtc, Dms dms, Sensors wfs, Telescope tel, Atmos atmos, List[conf.Param_centroider] p_centroiders, do_refslp=False, dataBase={}, use_DB=False)
	Initialize the controller part of rtc. More...

def	init_controller_geo (int i, Rtc rtc, Dms dms, conf.Param_geom p_geom, conf.Param_controller p_controller, list p_dms, roket=False)
	Initialize geometric controller. More...

def	init_controller_ls (int i, conf.Param_controller p_controller, list p_wfss, conf.Param_geom p_geom, list p_dms, conf.Param_atmos p_atmos, float ittime, conf.Param_tel p_tel, Rtc rtc, Dms dms, Sensors wfs, Telescope tel, Atmos atmos, dict dataBase={}, bool use_DB=False)
	Initialize the least square controller. More...

def	init_controller_cured (int i, Rtc rtc, conf.Param_controller p_controller, list p_dms, list p_wfss)
	Initialize the CURED controller. More...

def	init_controller_mv (int i, conf.Param_controller p_controller, list p_wfss, conf.Param_geom p_geom, list p_dms, conf.Param_atmos p_atmos, conf.Param_tel p_tel, Rtc rtc, Dms dms, Sensors wfs, Atmos atmos)
	Initialize the MV controller. More...

def	init_controller_generic (int i, conf.Param_controller p_controller, list p_dms, Rtc rtc)
	Initialize the generic controller. More...

def	configure_generic_linear (conf.Param_controller p_controller)
	Configures the generic controller based on set parameters. More...

Detailed Description

Initialization of a Rtc object.

Author: COMPASS Team https://github.com/ANR-COMPASS

Version: 5.4.4

Date: 2022/01/24

Copyright: GNU Lesser General Public License

This file is part of COMPASS https://anr-compass.github.io/compass/

COMPASS is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

COMPASS: End-to-end AO simulation tool using GPU acceleration The COMPASS platform was designed to meet the need of high-performance for the simulation of AO systems.

The final product includes a software package for simulating all the critical subcomponents of AO, particularly in the context of the ELT and a real-time core based on several control approaches, with performances consistent with its integration into an instrument. Taking advantage of the specific hardware architecture of the GPU, the COMPASS tool allows to achieve adequate execution speeds to conduct large simulation campaigns called to the ELT.

The COMPASS platform can be used to carry a wide variety of simulations to both testspecific components of AO of the E-ELT (such as wavefront analysis device with a pyramid or elongated Laser star), and various systems configurations such as multi-conjugate AO.

COMPASS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with COMPASS. If not, see https://www.gnu.org/licenses/lgpl-3.0.txt.

Function Documentation

◆ comp_weights()

def shesha.init.rtc_init.comp_weights	(	conf.Param_centroider	p_centroider,
		conf.Param_wfs	p_wfs,
		int	npix
	)

Compute the weights used by centroider wcog and corr.

Parameters

p_centroider	(Param_centroider) : centroider settings
p_wfs	(Param_wfs) : wfs settings
npix	(int):

Definition at line 331 of file rtc_init.py.

Here is the caller graph for this function:

◆ configure_generic_linear()

def shesha.init.rtc_init.configure_generic_linear ( conf.Param_controller p_controller )

Configures the generic controller based on set parameters.

Parameters

i	(int): controller index
p_controller	(Param_controller): controller settings
p_dms	(list of Param_dm): dms settings
rtc	(Rtc): Rtc object

Definition at line 726 of file rtc_init.py.

Here is the caller graph for this function:

◆ init_centroider()

def shesha.init.rtc_init.init_centroider	(		context,
		int	nwfs,
		conf.Param_wfs	p_wfs,
		conf.Param_centroider	p_centroider,
		conf.Param_tel	p_tel,
		conf.Param_atmos	p_atmos,
		Sensors	wfs,
		Rtc	rtc
	)

Initialize a centroider object in Rtc.

Parameters

context	(carmaWrap_context): context
nwfs	(int) : index of wfs
p_wfs	(Param_wfs): wfs settings
p_centroider	(Param_centroider) : centroider settings
wfs	(Sensors): Sensor object
rtc	(Rtc) : Rtc object

Definition at line 253 of file rtc_init.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_controller()

def shesha.init.rtc_init.init_controller	(		context,
		int	i,
		conf.Param_controller	p_controller,
		list	p_wfss,
		conf.Param_geom	p_geom,
		list	p_dms,
		conf.Param_atmos	p_atmos,
		float	ittime,
		conf.Param_tel	p_tel,
		Rtc	rtc,
		Dms	dms,
		Sensors	wfs,
		Telescope	tel,
		Atmos	atmos,
		List[conf.Param_centroider]	p_centroiders,
			do_refslp = `False`,
			dataBase = `{}`,
			use_DB = `False`
	)

Initialize the controller part of rtc.

Parameters

context	(carmaWrap_context): context
i	(int) : controller index
p_controller	(Param_controller) : controller settings
p_wfss	(list of Param_wfs) : wfs settings
p_geom	(Param_geom) : geom settings
p_dms	(list of Param_dms) : dms settings
p_atmos	(Param_atmos) : atmos settings
ittime	(float) : iteration time [s]
p_tel	(Param_tel) : telescope settings
rtc	(Rtc) : Rtc objet
dms	(Dms) : Dms object
wfs	(Sensors) : Sensors object
tel	(Telescope) : Telescope object
atmos	(Atmos) : Atmos object
p_centroiders	(list of Param_centroider): centroiders settings
do_refslp	(bool): do the reference slopes at startup,
dataBase	(dict): database used
use_DB	(bool): use database or not

Definition at line 418 of file rtc_init.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_controller_cured()

def shesha.init.rtc_init.init_controller_cured	(	int	i,
		Rtc	rtc,
		conf.Param_controller	p_controller,
		list	p_dms,
		list	p_wfss
	)

Initialize the CURED controller.

Parameters

i	(int) : controller index
rtc	(Rtc) : Rtc objet
p_controller	(Param_controller) : controller settings
p_dms	(list of Param_dms) : dms settings
p_wfss	(list of Param_wfs) : wfs settings

Definition at line 634 of file rtc_init.py.

Here is the caller graph for this function:

◆ init_controller_generic()

def shesha.init.rtc_init.init_controller_generic	(	int	i,
		conf.Param_controller	p_controller,
		list	p_dms,
		Rtc	rtc
	)

Initialize the generic controller.

Parameters

i	(int): controller index
p_controller	(Param_controller): controller settings
p_dms	(list of Param_dm): dms settings
rtc	(Rtc): Rtc object

Definition at line 699 of file rtc_init.py.

Here is the caller graph for this function:

◆ init_controller_geo()

def shesha.init.rtc_init.init_controller_geo	(	int	i,
		Rtc	rtc,
		Dms	dms,
		conf.Param_geom	p_geom,
		conf.Param_controller	p_controller,
		list	p_dms,
			roket = `False`
	)

Initialize geometric controller.

Parameters

i	(int): controller index
rtc	(Rtc): rtc object
dms	(Dms): Dms object
p_geom	(Param_geom): geometry settings
p_controller	(Param_controller): controller settings
p_dms	(list of Param_dms): dms settings
Kwargs
roket	(bool): Flag to initialize ROKET

Definition at line 517 of file rtc_init.py.

Here is the caller graph for this function:

◆ init_controller_ls()

def shesha.init.rtc_init.init_controller_ls	(	int	i,
		conf.Param_controller	p_controller,
		list	p_wfss,
		conf.Param_geom	p_geom,
		list	p_dms,
		conf.Param_atmos	p_atmos,
		float	ittime,
		conf.Param_tel	p_tel,
		Rtc	rtc,
		Dms	dms,
		Sensors	wfs,
		Telescope	tel,
		Atmos	atmos,
		dict	dataBase = `{}`,
		bool	use_DB = `False`
	)

Initialize the least square controller.

Parameters

i	(int) : controller index
p_controller	(Param_controller) : controller settings
p_wfss	(list of Param_wfs) : wfs settings
p_geom	(Param_geom) : geom settings
p_dms	(list of Param_dms) : dms settings
p_atmos	(Param_atmos) : atmos settings
ittime	(float) : iteration time [s]
p_tel	(Param_tel) : telescope settings
rtc	(Rtc) : Rtc objet
dms	(Dms) : Dms object
wfs	(Sensors) : Sensors object
tel	(Telescope) : Telescope object
atmos	(Atmos) : Atmos object
dataBase	(dict): database used
use_DB	(bool): use database or not

Definition at line 572 of file rtc_init.py.

Here is the caller graph for this function:

◆ init_controller_mv()

def shesha.init.rtc_init.init_controller_mv	(	int	i,
		conf.Param_controller	p_controller,
		list	p_wfss,
		conf.Param_geom	p_geom,
		list	p_dms,
		conf.Param_atmos	p_atmos,
		conf.Param_tel	p_tel,
		Rtc	rtc,
		Dms	dms,
		Sensors	wfs,
		Atmos	atmos
	)

Initialize the MV controller.

Parameters

i	(int) : controller index
p_controller	(Param_controller) : controller settings
p_wfss	(list of Param_wfs) : wfs settings
p_geom	(Param_geom) : geom settings
p_dms	(list of Param_dms) : dms settings
p_atmos	(Param_atmos) : atmos settings
p_tel	(Param_tel) : telescope settings
rtc	(Rtc) : Rtc objet
dms	(Dms) : Dms object
wfs	(Sensors) : Sensors object
atmos	(Atmos) : Atmos object

Definition at line 672 of file rtc_init.py.

Here is the caller graph for this function:

◆ rtc_init()

def shesha.init.rtc_init.rtc_init	(	carmaWrap_context	context,
		Telescope	tel,
		Sensors	wfs,
		Dms	dms,
		Atmos	atmos,
		list	p_wfss,
		conf.Param_tel	p_tel,
		conf.Param_geom	p_geom,
		conf.Param_atmos	p_atmos,
		float	ittime,
			p_centroiders = `None`,
			p_controllers = `None`,
			p_dms = `None`,
			do_refslp = `False`,
			brahma = `False`,
			cacao = `False`,
			tar = `None`,
			dataBase = `{}`,
			use_DB = `False`
	)

Initialize all the SutraRtc objects : centroiders and controllers.

Parameters

context	(carmaWrap_context): context
tel	(Telescope) : Telescope object
wfs	(Sensors) : Sensors object
dms	(Dms) : Dms object
atmos	(Atmos) : Atmos object
p_wfss	(list of Param_wfs) : wfs settings
p_tel	(Param_tel) : telescope settings
p_geom	(Param_geom) : geom settings
p_atmos	(Param_atmos) : atmos settings
ittime	(float) : iteration time [s]
p_centroiders	(list of Param_centroider): centroiders settings
p_controllers	(list of Param_controller): controllers settings
p_dms	(list of Param_dms) : dms settings
do_refslp	(bool): do ref slopes flag, default=False
brahma	(bool) : brahma flag
cacao	(bool) : cacao flag
tar	(Target) : Target object
dataBase	(dict): dict containig paths to files to load
use_DB	(bool): use dataBase flag

Returns: Rtc (Rtc) : Rtc object

Definition at line 99 of file rtc_init.py.

Here is the call graph for this function:

◆ rtc_standalone()

Rtc shesha.init.rtc_init.rtc_standalone	(	carmaWrap_context	context,
		int	nwfs,
		list	nvalid,
		int	nactu,
		list	centroider_type,
		list	delay,
		list	offset,
		list	scale,
		bool	brahma = `False`,
		bool	fp16 = `False`,
		bool	cacao = `False`
	)

Initialize all the SutraRtc objects : centroiders and controllers.

Parameters

context	(carmaWrap_context): context
nwfs	(int): number of wavefront sensors
nvalid	(int): number of valid measures as input
nactu	(int): number of actuators as output
centroider_type	(list): type of centroiders
delay	(list): delay of each controller
offset	(list): offset added in the cog computation of each WFS
scale	(list): scale factor used in the cog computation of each WFS
brahma	(bool) : brahma flag (default=False)
fp16	(bool) : fp16 flag (default=False)
cacao	(bool) : cacao flag (default=False)

Returns: Rtc (Rtc) : Rtc object

Definition at line 204 of file rtc_init.py.

Functions

Detailed Description

Function Documentation

◆ comp_weights()

◆ configure_generic_linear()

◆ init_centroider()

◆ init_controller()

◆ init_controller_cured()

◆ init_controller_generic()

◆ init_controller_geo()

◆ init_controller_ls()

◆ init_controller_mv()

◆ rtc_init()

◆ rtc_standalone()