Collaboration diagram for sutraWrap.Rtc_FFF:

Public Member Functions
None	__init__ (self)
	Initialize a void rtc object. More...

int	add_centroider (self, carmaWrap.context context, int nvalid, float offset, float scale, bool filter_TT, int device, str typec, Wfs wfs)
	Add a SutraCentroider object in the RTC. More...

int	add_centroider (self, carmaWrap.context context, int nvalid, float offset, float scale, bool filter_TT, int device, str typec)

int	add_controller (self, carmaWrap.context context, str typec, int device, float delay, int nslope, int nactu, int nslope_buffers=0, int nstates=0, int nstate_buffers=0, int nmodes=0, int niir_in=0, int niir_out=0, bool polc=False, bool is_modal=False, Dms dms=None, numpy.ndarray[numpy.int32] idx_dms=[], int ndm=0, numpy.ndarray[numpy.int32] idx_centro=[], int ncentro=0, int Nphi=0, bool wfs_direction=False)
	Add a SutraController object in the RTC. More...

None	add_controller (self, carmaWrap.context context, str typec, int device, float delay, int nslope, int nactu, int nslope_buffers=0, int nstates=0, int nstate_buffers=0, int nmodes=0, int niir_in=0, int niir_out=0, bool polc=False, bool is_modal=False)

int	apply_control (self, int ncontrol, bool compVoltage=True)
	Apply the commands on the DM and shape it. More...

None	build_cmat (self, int ncontrol, int nfilt, bool filt_tt=False)
	Computes cmat. More...

int	comp_voltage (self, int ncontrol)
	Compute the commands on the DM. More...

int	do_calibrate_img (self, int ncontrol)
	Computes the calibrated image. More...

int	do_centroids (self, int ncontrol)
	Computes the centroids. More...

int	do_centroids_geom (self, int ncontrol, int type=0)
	Computes the centroids geom. More...

int	do_centroids_ref (self, int ncontrol)
	Computes the centroids ref. More...

int	do_clipping (self, int ncontrol)
	Clip the command to apply on the DMs on a SutraController object. More...

int	do_control (self, int ncontrol)
	Computes the commands. More...

int	do_imat (self, int ncontrol, Dms dms, int kernconv)
	Computes interaction matrix. More...

int	do_imat_basis (self, int ncontrol, Dms dms, int nModes, numpy.ndarray[numpy.float32] m2v, numpy.ndarray[numpy.float32] pushAmpl, int kernconv)
	Computes a modal interaction matrix. More...

None	imat_svd (self, int ncontrol)
	Computes imat svd. More...

int	remove_centroider (self, int ncentro)
	Remove the specified centroider from the RTC. More...

int	remove_controller (self, int ncontrol)
	Remove the specified controller from the RTC. More...

int	set_centroids_ref (self, numpy.ndarray[numpy.float32] centroidsRef)
	Set the reference centroids. More...

None	set_gain (self, int ncontrol, float gain)
	Set the loop gain in the controller. More...

None	set_modal_gains (self, int ncontrol, numpy.ndarray[numpy.float32] mgain)
	Set the modal gain in the controller. More...

Properties
	d_centro = property
	Vector of centroiders. More...

	d_control = property
	Vector of controllers. More...

Detailed Description

Definition at line 6509 of file sutraWrap.py.

Constructor & Destructor Documentation

◆ init()

None sutraWrap.Rtc_FFF.__init__ ( self )

Initialize a void rtc object.

Definition at line 6513 of file sutraWrap.py.

Member Function Documentation

◆ add_centroider() [1/2]

int sutraWrap.Rtc_FFF.add_centroider	(		self,
		carmaWrap.context	context,
		int	nvalid,
		float	offset,
		float	scale,
		bool	filter_TT,
		int	device,
		str	typec
	)

Definition at line 6557 of file sutraWrap.py.

Here is the call graph for this function:

◆ add_centroider() [2/2]

int sutraWrap.Rtc_FFF.add_centroider	(		self,
		carmaWrap.context	context,
		int	nvalid,
		float	offset,
		float	scale,
		bool	filter_TT,
		int	device,
		str	typec,
		Wfs	wfs
	)

Add a SutraCentroider object in the RTC.

Parameters

context	(CarmaContext): carma context
nvalid	Number of WFS valid ssp
offset	(float): offset for centroiding computation
scale	(float): scale factor to get the right unit, ie. arcsec
filt_TT	(bool): flag to control TT filtering
device	(int): GPU device index
typec	(str): Centroider type
wfs	(SutraWfs): SutraWfs handled by the centroider

     Add a SutraCentroider object in the RTC

Parameters

context	(CarmaContext): carma context
nvalid	Number of WFS valid ssp
offset	(float): offset for centroiding computation
scale	(float): scale factor to get the right unit, ie. arcsec
filt_TT	(bool): flag to control TT filtering
device	(int): GPU device index
typec	(str): Centroider type

Definition at line 6555 of file sutraWrap.py.

Here is the caller graph for this function:

◆ add_controller() [1/2]

None sutraWrap.Rtc_FFF.add_controller	(		self,
		carmaWrap.context	context,
		str	typec,
		int	device,
		float	delay,
		int	nslope,
		int	nactu,
		int	nslope_buffers = `0`,
		int	nstates = `0`,
		int	nstate_buffers = `0`,
		int	nmodes = `0`,
		int	niir_in = `0`,
		int	niir_out = `0`,
		bool	polc = `False`,
		bool	is_modal = `False`
	)

Definition at line 6660 of file sutraWrap.py.

Here is the call graph for this function:

◆ add_controller() [2/2]

int sutraWrap.Rtc_FFF.add_controller	(		self,
		carmaWrap.context	context,
		str	typec,
		int	device,
		float	delay,
		int	nslope,
		int	nactu,
		int	nslope_buffers = `0`,
		int	nstates = `0`,
		int	nstate_buffers = `0`,
		int	nmodes = `0`,
		int	niir_in = `0`,
		int	niir_out = `0`,
		bool	polc = `False`,
		bool	is_modal = `False`,
		Dms	dms = `None`,
		numpy.ndarray[numpy.int32]	idx_dms = `[]`,
		int	ndm = `0`,
		numpy.ndarray[numpy.int32]	idx_centro = `[]`,
		int	ncentro = `0`,
		int	Nphi = `0`,
		bool	wfs_direction = `False`
	)

Add a SutraController object in the RTC.

Parameters

context	(CarmaContext): carma context
typec	(str): Controller type
device	(int): GPU device index
delay	(float): Loop delay [frames]
nslope	(int): Number of slopes
nactu	Number of actuators to command
nslope_buffers	(int) : Number of historic slopes vectors to use
nstates	(int) : Number of states in state vector
nstate_buffers	(int) : Number of historic state vectors to use
nmodes	(int) : Number of modes in mode vector
niir_in	(int) : Number of input mode vectors for iir filter
niir_out	(int) : Number of output mode vectors for iir filter
polc	(bool) : Activate the Pseudo Open Loop Control if available
is_modal	(bool) : Activate projection from modes to actu if available
dms	(SutraDms) : SutraDms object
idx_dms	(np.array[ndim=1,dtype=np.int64]) : index of DM in SutraDms to command
ndm	(int) : Number of DM to command
idx_centro	(np.array[ndim=1,dtype=np.int64]): (optional) Index of centoiders in sutra_rtc.d_centro to handle
ncentro	(int) : Number of centroiders handled
Nphi	(int) : umber of pixels in the pupil
wfs_direction	(bool) : Flag for ROKET

     Add a SutraController object in the RTC

Parameters

context	(CarmaContext): carma context
typec	(str): Controller type
device	(int): GPU device index
delay	(float): Loop delay [frames]
nslope	(int): Number of slopes
nactu	Number of actuators to command
nslope_buffers	(int) : Number of historic slopes vectors to use
nstates	(int) : Number of states in state vector
nstate_buffers	(int) : Number of historic state vectors to use
nmodes	(int) : Number of modes in mode vector
niir_in	(int) : Number of input mode vectors for iir filter
niir_out	(int) : Number of output mode vectors for iir filter
polc	(bool) : Activate the Pseudo Open Loop Control if available
is_modal	(bool) : Activate projection from modes to actu if available
dms	(SutraDms) : SutraDms object
idx_dms	(np.array[ndim=1,dtype=np.int64]) : index of DM in SutraDms to command
ndm	(int) : Number of DM to command
idx_centro	(np.array[ndim=1,dtype=np.int64]): (optional) Index of centoiders in sutra_rtc.d_centro to handle
ncentro	(int) : Number of centroiders handled
Nphi	(int) : umber of pixels in the pupil
wfs_direction	(bool) : Flag for ROKET

Definition at line 6658 of file sutraWrap.py.

Here is the caller graph for this function:

◆ apply_control()

int sutraWrap.Rtc_FFF.apply_control	(		self,
		int	ncontrol,
		bool	compVoltage = `True`
	)

Apply the commands on the DM and shape it.

Parameters

ncontrol	(int): Index of the controller
compVoltage	(bool): if True (default), computes delay and perturb voltages. Else, applies just the vector command

Definition at line 6669 of file sutraWrap.py.

◆ build_cmat()

None sutraWrap.Rtc_FFF.build_cmat	(		self,
		int	ncontrol,
		int	nfilt,
		bool	filt_tt = `False`
	)

Computes cmat.

Parameters

ncontrol	(int): controller index
nfilt	(int): number of modes to filter
filt_tt	(bool): Flag for TT filter

Definition at line 6680 of file sutraWrap.py.

◆ comp_voltage()

int sutraWrap.Rtc_FFF.comp_voltage	(		self,
		int	ncontrol
	)

Compute the commands on the DM.

Parameters

ncontrol (int): Index of the controller

Definition at line 6687 of file sutraWrap.py.

◆ do_calibrate_img()

int sutraWrap.Rtc_FFF.do_calibrate_img	(		self,
		int	ncontrol
	)

Computes the calibrated image.

Parameters

ncontrol (int): Index of the controller

Definition at line 6694 of file sutraWrap.py.

◆ do_centroids()

int sutraWrap.Rtc_FFF.do_centroids	(		self,
		int	ncontrol
	)

Computes the centroids.

Parameters

ncontrol (int): Index of the controller

Definition at line 6701 of file sutraWrap.py.

◆ do_centroids_geom()

int sutraWrap.Rtc_FFF.do_centroids_geom	(		self,
		int	ncontrol,
		int	type = `0`
	)

Computes the centroids geom.

Parameters

ncontrol	(int): Index of the controller
type	(int): Centroiding method of geom wfs

Definition at line 6709 of file sutraWrap.py.

Here is the caller graph for this function:

◆ do_centroids_ref()

int sutraWrap.Rtc_FFF.do_centroids_ref	(		self,
		int	ncontrol
	)

Computes the centroids ref.

Parameters

ncontrol (int): Index of the controller

Definition at line 6716 of file sutraWrap.py.

◆ do_clipping()

int sutraWrap.Rtc_FFF.do_clipping	(		self,
		int	ncontrol
	)

Clip the command to apply on the DMs on a SutraController object.

Parameters

ncontrol (int) : controller index

Definition at line 6723 of file sutraWrap.py.

◆ do_control()

int sutraWrap.Rtc_FFF.do_control	(		self,
		int	ncontrol
	)

Computes the commands.

Parameters

ncontrol (int): Index of the controller

Definition at line 6730 of file sutraWrap.py.

◆ do_imat()

int sutraWrap.Rtc_FFF.do_imat	(		self,
		int	ncontrol,
		Dms	dms,
		int	kernconv
	)

Computes interaction matrix.

Parameters

ncontrol	(int): Index of the controller
dms	(SutraDms): SutraDms object
kernconv	(bool) : Flag for WFS spot convolution

Definition at line 6741 of file sutraWrap.py.

◆ do_imat_basis()

int sutraWrap.Rtc_FFF.do_imat_basis	(		self,
		int	ncontrol,
		Dms	dms,
		int	nModes,
		numpy.ndarray[numpy.float32]	m2v,
		numpy.ndarray[numpy.float32]	pushAmpl,
		int	kernconv
	)

Computes a modal interaction matrix.

Parameters

ncontrol	(int): Index of the controller
dms	(SutraDms): SutraDms object
nModes	(int): number of modes in the basis
m2v	(np.array[ndim=2,dtype=np.float32]): modeToActu matrix
pushAmpl	(np.array[ndim=1,dtype=np.float32]): pushpull strength in mode units
kernconv	(bool) : Flag for WFS spot convolution

Definition at line 6759 of file sutraWrap.py.

◆ imat_svd()

None sutraWrap.Rtc_FFF.imat_svd	(		self,
		int	ncontrol
	)

Computes imat svd.

Parameters

ncontrol (int): controller index

Definition at line 6766 of file sutraWrap.py.

◆ remove_centroider()

int sutraWrap.Rtc_FFF.remove_centroider	(		self,
		int	ncentro
	)

Remove the specified centroider from the RTC.

Parameters

ncentro (int): index of the centroider to remove

Definition at line 6773 of file sutraWrap.py.

◆ remove_controller()

int sutraWrap.Rtc_FFF.remove_controller	(		self,
		int	ncontrol
	)

Remove the specified controller from the RTC.

Parameters

ncontrol (int): index of the controller to remove

Definition at line 6780 of file sutraWrap.py.

◆ set_centroids_ref()

int sutraWrap.Rtc_FFF.set_centroids_ref	(		self,
		numpy.ndarray[numpy.float32]	centroidsRef
	)

Set the reference centroids.

Parameters

centroids_ref (np.array(ndim=1, dtype=np.float32)): ref centroids

Definition at line 6787 of file sutraWrap.py.

◆ set_gain()

None sutraWrap.Rtc_FFF.set_gain	(		self,
		int	ncontrol,
		float	gain
	)

Set the loop gain in the controller.

Parameters

ncontrol	(int): controller index
gain	(float): gain to set

Definition at line 6796 of file sutraWrap.py.

◆ set_modal_gains()

None sutraWrap.Rtc_FFF.set_modal_gains	(		self,
		int	ncontrol,
		numpy.ndarray[numpy.float32]	mgain
	)

Set the modal gain in the controller.

Parameters

ncontrol	(int): controller index
mgain	(np.array[ndim=1,dtype=np.float32]): modal gains to set

Definition at line 6805 of file sutraWrap.py.

Property Documentation

◆ d_centro

sutraWrap.Rtc_FFF.d_centro = property

static

Vector of centroiders.

   @n type of :  typing.List[Centroider_FF]

Definition at line 6812 of file sutraWrap.py.

◆ d_control

sutraWrap.Rtc_FFF.d_control = property

static

Vector of controllers.

   @n type of :  typing.List[Controller_FF]

Definition at line 6821 of file sutraWrap.py.

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

sutraWrap.py

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ add_centroider() [1/2]

◆ add_centroider() [2/2]

◆ add_controller() [1/2]

◆ add_controller() [2/2]

◆ apply_control()

◆ build_cmat()

◆ comp_voltage()

◆ do_calibrate_img()

◆ do_centroids()

◆ do_centroids_geom()

◆ do_centroids_ref()

◆ do_clipping()

◆ do_control()

◆ do_imat()

◆ do_imat_basis()

◆ imat_svd()

◆ remove_centroider()

◆ remove_controller()

◆ set_centroids_ref()

◆ set_gain()

◆ set_modal_gains()

Property Documentation

◆ d_centro

◆ d_control

◆ init()