Inheritance diagram for sutraWrap.Wfs:

Collaboration diagram for sutraWrap.Wfs:

Public Member Functions
int	comp_image (self, bool noise=True)
	Computes the WFS image from the WFS phase. More...

int	fill_binimage (self, int arg0)
	Fill d_binimg from d_bincube. More...

int	set_binimg (self, numpy.ndarray[numpy.float32] binimg, int nElem)
	Set the binimg of the SH WFS. More...

int	set_dark (self, numpy.ndarray[numpy.float32] dark, int nElem)
	Set the dark of the SH WFS. More...

int	set_fakecam (self, bool fakecam)
	Enable or disable uint16 computation for the WFS. More...

int	set_flat (self, numpy.ndarray[numpy.float32] flat, int nElem)
	Set the flat of the SH WFS. More...

int	set_max_flux_per_pix (self, int max_flux_per_pix)
	Set the maximum number of photons allowed before pixel saturation. More...

int	set_max_pix_value (self, int max_pix_value)
	Set the maximum number of ADU allowed in the uint16 image. More...

int	set_noise (self, float noise, int seed)
	Set the noise of the WFS. More...

None	set_pupil (self, numpy.ndarray[numpy.float32] pupil)
	Set the pupil seen by the WFS. More...

int	slopes_geom (self, int type=0)
	Computes theoretical slopes in wfs.d_slopes. More...

int	slopes_geom (self, numpy.ndarray[numpy.float32] slopes, int type=0)

Properties
	d_bincube = property
	WFS spots as a 3D array. More...

	d_binimg = property
	WFS image. More...

	d_binimg_notnoisy = property
	WFS image without noise (ROKET only) More...

	d_camimg = property
	uint16 WFS image More...

	d_camplifoc = property
	Complex amplitude in the focal plane. More...

	d_camplipup = property
	Complex amplitude in the pupil. More...

	d_dark = property
	Dark WFS frame. More...

	d_flat = property
	Flat WFS frame. More...

	d_fluxPerSub = property
	Normalized flux per ssp. More...

	d_fttotim = property
	Buffer for FFT computation. More...

	d_gs = property
	WGS GS (SutraSource object) More...

	d_hrmap = property
	TODO docstring. More...

	d_intensities = property
	Sum of intensities in each ssp. More...

	d_offsets = property
	TODO docstring. More...

	d_phasemap = property
	TODO docstring. More...

	d_pupil = property
	Pupil. More...

	d_sincar = property
	TODO docstring. More...

	d_slopes = property
	Slopes vector. More...

	d_submask = property
	TODO docstring. More...

	d_ttprojmat = property
	TT projection matrix from subap phase to slopes (geom wfs type 2) More...

	d_ttprojvec = property
	Input vector for TT projection from subap phase to slopes (geom wfs type 2) More...

	d_validsubsx = property
	X-position of valid ssp. More...

	d_validsubsy = property
	Y-position of valid ssp. More...

	device = property
	GPU device index. More...

	fakecam = property
	Flag for uint16 image. More...

	is_low_order = property
	Flag for low order WFS. More...

	kernconv = property
	Convolution kernel for spot computation. More...

	lgs = property
	Is the WFS a LGS one ? More...

	max_flux_per_pix = property
	Maximum number of photons allowed before pixel saturation. More...

	max_pix_value = property
	Maximum number of ADU allowed in the uint16 image. More...

	nfft = property
	FFT support size. More...

	nffthr = property
	TODO docstring. More...

	nmaxhr = property
	TODO docstring. More...

	noise = property
	WFS noise [e-]. More...

	nphase = property
	Number of phase point per ssp. More...

	nphot = property
	Number of photons/ssp/iter. More...

	nphot4imat = property
	Number of photons/ssp/iter used for imat computation. More...

	npix = property
	Pixels per ssp. More...

	npup = property
	Pupil support size. More...

	nrebin = property
	Rebin factor. More...

	ntot = property
	HR support size. More...

	nvalid = property
	Number of valid ssp. More...

	nxsub = property
	Number of ssp in the diameter. More...

	roket = property
	Is the WFS a LGS one ? More...

	subapd = property
	ssp diameter in pixels More...

	type = property
	WFS type. More...

Detailed Description

Definition at line 5930 of file sutraWrap.py.

Member Function Documentation

◆ comp_image()

int sutraWrap.Wfs.comp_image	(		self,
		bool	noise = `True`
	)

Computes the WFS image from the WFS phase.

Parameters

noise (bool): take noise into account or not

Definition at line 5937 of file sutraWrap.py.

◆ fill_binimage()

int sutraWrap.Wfs.fill_binimage	(		self,
		int	arg0
	)

Fill d_binimg from d_bincube.

Definition at line 5941 of file sutraWrap.py.

◆ set_binimg()

int sutraWrap.Wfs.set_binimg	(		self,
		numpy.ndarray[numpy.float32]	binimg,
		int	nElem
	)

Set the binimg of the SH WFS.

Parameters

binimg	(np.array[ndim=3, dtype=np.float32]) : cube of subap. images
nElem	(int): Number of elements in binimg

Definition at line 5951 of file sutraWrap.py.

◆ set_dark()

int sutraWrap.Wfs.set_dark	(		self,
		numpy.ndarray[numpy.float32]	dark,
		int	nElem
	)

Set the dark of the SH WFS.

Parameters

dark	(np.array[ndim=2, dtype=np.float32]) : dark image
nElem	(int): Number of elements in dark

Definition at line 5961 of file sutraWrap.py.

◆ set_fakecam()

int sutraWrap.Wfs.set_fakecam	(		self,
		bool	fakecam
	)

Enable or disable uint16 computation for the WFS.

Parameters

fakecam (bool): fakecam flag

Definition at line 5969 of file sutraWrap.py.

◆ set_flat()

int sutraWrap.Wfs.set_flat	(		self,
		numpy.ndarray[numpy.float32]	flat,
		int	nElem
	)

Set the flat of the SH WFS.

Parameters

flat	(np.array[ndim=2, dtype=np.float32]) : flat image
nElem	(int): Number of elements in flat

Definition at line 5979 of file sutraWrap.py.

◆ set_max_flux_per_pix()

int sutraWrap.Wfs.set_max_flux_per_pix	(		self,
		int	max_flux_per_pix
	)

Set the maximum number of photons allowed before pixel saturation.

Parameters

max_flux_per_pix (int): maximum number of photons allowed before pixel saturation

Definition at line 5987 of file sutraWrap.py.

◆ set_max_pix_value()

int sutraWrap.Wfs.set_max_pix_value	(		self,
		int	max_pix_value
	)

Set the maximum number of ADU allowed in the uint16 image.

Parameters

max_pix_value (int): maximum number of ADU allowed in the uint16 image

Definition at line 5995 of file sutraWrap.py.

◆ set_noise()

int sutraWrap.Wfs.set_noise	(		self,
		float	noise,
		int	seed
	)

Set the noise of the WFS.

Parameters

noise	(float): desired noise (< 0 = no noise 0 = photon only > 0 = photon + ron in e-)
seed	(int): seed for the RNG

Definition at line 6006 of file sutraWrap.py.

◆ set_pupil()

None sutraWrap.Wfs.set_pupil	(		self,
		numpy.ndarray[numpy.float32]	pupil
	)

Set the pupil seen by the WFS.

Parameters

pupil (np.array(ndim=2,dtype=np.float32)): pupil to set

Definition at line 6013 of file sutraWrap.py.

◆ slopes_geom() [1/2]

int sutraWrap.Wfs.slopes_geom	(		self,
		int	type = `0`
	)

Computes theoretical slopes in wfs.d_slopes.

Parameters

type	(int): method to use (0: reduce, 1: derive)

    Computes theoretical slopes in given array

Parameters

slopes	(np.array(ndim=1, dtype=np.float32)):
type	(int): method to use (0: reduce, 1: derive)

Definition at line 6030 of file sutraWrap.py.

Here is the caller graph for this function:

◆ slopes_geom() [2/2]

int sutraWrap.Wfs.slopes_geom	(		self,
		numpy.ndarray[numpy.float32]	slopes,
		int	type = `0`
	)

Definition at line 6032 of file sutraWrap.py.

Here is the call graph for this function:

Property Documentation

◆ d_bincube

sutraWrap.Wfs.d_bincube = property

static

WFS spots as a 3D array.

   @n type of :  carmaWrap.obj_float

Definition at line 6039 of file sutraWrap.py.

◆ d_binimg

sutraWrap.Wfs.d_binimg = property

static

WFS image.

   @n type of :  carmaWrap.obj_float

Definition at line 6048 of file sutraWrap.py.

◆ d_binimg_notnoisy

sutraWrap.Wfs.d_binimg_notnoisy = property

static

WFS image without noise (ROKET only)

   @n type of :  carmaWrap.obj_float

Definition at line 6057 of file sutraWrap.py.

◆ d_camimg

sutraWrap.Wfs.d_camimg = property

static

uint16 WFS image

   @n type of :  carmaWrap.obj_uint16

Definition at line 6066 of file sutraWrap.py.

◆ d_camplifoc

sutraWrap.Wfs.d_camplifoc = property

static

Complex amplitude in the focal plane.

   @n type of :  carmaWrap.obj_float_complex

Definition at line 6075 of file sutraWrap.py.

◆ d_camplipup

sutraWrap.Wfs.d_camplipup = property

static

Complex amplitude in the pupil.

   @n type of :  carmaWrap.obj_float_complex

Definition at line 6084 of file sutraWrap.py.

◆ d_dark

sutraWrap.Wfs.d_dark = property

static

Dark WFS frame.

   @n type of :  carmaWrap.obj_float

Definition at line 6093 of file sutraWrap.py.

◆ d_flat

sutraWrap.Wfs.d_flat = property

static

Flat WFS frame.

   @n type of :  carmaWrap.obj_float

Definition at line 6102 of file sutraWrap.py.

◆ d_fluxPerSub

sutraWrap.Wfs.d_fluxPerSub = property

static

Normalized flux per ssp.

   @n type of :  carmaWrap.obj_float

Definition at line 6111 of file sutraWrap.py.

◆ d_fttotim

sutraWrap.Wfs.d_fttotim = property

static

Buffer for FFT computation.

   @n type of :  carmaWrap.obj_float_complex

Definition at line 6120 of file sutraWrap.py.

◆ d_gs

sutraWrap.Wfs.d_gs = property

static

WGS GS (SutraSource object)

   @n type of :  Source

Definition at line 6129 of file sutraWrap.py.

◆ d_hrmap

sutraWrap.Wfs.d_hrmap = property

static

TODO docstring.

   @n type of :  carmaWrap.obj_int

Definition at line 6138 of file sutraWrap.py.

◆ d_intensities

sutraWrap.Wfs.d_intensities = property

static

Sum of intensities in each ssp.

   @n type of :  carmaWrap.obj_float

Definition at line 6147 of file sutraWrap.py.

◆ d_offsets

sutraWrap.Wfs.d_offsets = property

static

TODO docstring.

   @n type of :  carmaWrap.obj_float

Definition at line 6156 of file sutraWrap.py.

◆ d_phasemap

sutraWrap.Wfs.d_phasemap = property

static

TODO docstring.

   @n type of :  carmaWrap.obj_int

Definition at line 6165 of file sutraWrap.py.

◆ d_pupil

sutraWrap.Wfs.d_pupil = property

static

Pupil.

   @n type of :  carmaWrap.obj_float

Definition at line 6174 of file sutraWrap.py.

◆ d_sincar

sutraWrap.Wfs.d_sincar = property

static

TODO docstring.

   @n type of :  carmaWrap.obj_float

Definition at line 6183 of file sutraWrap.py.

◆ d_slopes

sutraWrap.Wfs.d_slopes = property

static

Slopes vector.

   @n type of :  carmaWrap.obj_float

Definition at line 6192 of file sutraWrap.py.

◆ d_submask

sutraWrap.Wfs.d_submask = property

static

TODO docstring.

   @n type of :  carmaWrap.obj_float

Definition at line 6201 of file sutraWrap.py.

◆ d_ttprojmat

sutraWrap.Wfs.d_ttprojmat = property

static

TT projection matrix from subap phase to slopes (geom wfs type 2)

   @n type of :  carmaWrap.obj_float

Definition at line 6210 of file sutraWrap.py.

◆ d_ttprojvec

sutraWrap.Wfs.d_ttprojvec = property

static

Input vector for TT projection from subap phase to slopes (geom wfs type 2)

   @n type of :  carmaWrap.obj_float

Definition at line 6219 of file sutraWrap.py.

◆ d_validsubsx

sutraWrap.Wfs.d_validsubsx = property

static

X-position of valid ssp.

   @n type of :  carmaWrap.obj_int

Definition at line 6228 of file sutraWrap.py.

◆ d_validsubsy

sutraWrap.Wfs.d_validsubsy = property

static

Y-position of valid ssp.

   @n type of :  carmaWrap.obj_int

Definition at line 6237 of file sutraWrap.py.

◆ device

sutraWrap.Wfs.device = property

static

GPU device index.

   @n type of :  int

Definition at line 6246 of file sutraWrap.py.

◆ fakecam

sutraWrap.Wfs.fakecam = property

static

Flag for uint16 image.

   @n type of :  bool

Definition at line 6255 of file sutraWrap.py.

◆ is_low_order

sutraWrap.Wfs.is_low_order = property

static

Flag for low order WFS.

   @n type of :  bool

Definition at line 6264 of file sutraWrap.py.

◆ kernconv

sutraWrap.Wfs.kernconv = property

static

Convolution kernel for spot computation.

   @n type of :  bool

Definition at line 6273 of file sutraWrap.py.

◆ lgs

sutraWrap.Wfs.lgs = property

static

Is the WFS a LGS one ?

   @n type of :  bool

Definition at line 6282 of file sutraWrap.py.

◆ max_flux_per_pix

sutraWrap.Wfs.max_flux_per_pix = property

static

Maximum number of photons allowed before pixel saturation.

   @n type of :  int

Definition at line 6291 of file sutraWrap.py.

◆ max_pix_value

sutraWrap.Wfs.max_pix_value = property

static

Maximum number of ADU allowed in the uint16 image.

   @n type of :  int

Definition at line 6300 of file sutraWrap.py.

◆ nfft

sutraWrap.Wfs.nfft = property

static

FFT support size.

   @n type of :  int

Definition at line 6309 of file sutraWrap.py.

◆ nffthr

sutraWrap.Wfs.nffthr = property

static

TODO docstring.

   @n type of :  int

Definition at line 6318 of file sutraWrap.py.

◆ nmaxhr

sutraWrap.Wfs.nmaxhr = property

static

TODO docstring.

   @n type of :  int

Definition at line 6327 of file sutraWrap.py.

◆ noise

sutraWrap.Wfs.noise = property

static

WFS noise [e-].

   @n type of :  float

Definition at line 6336 of file sutraWrap.py.

◆ nphase

sutraWrap.Wfs.nphase = property

static

Number of phase point per ssp.

   @n type of :  int

Definition at line 6345 of file sutraWrap.py.

◆ nphot

sutraWrap.Wfs.nphot = property

static

Number of photons/ssp/iter.

   @n type of :  float

Definition at line 6354 of file sutraWrap.py.

◆ nphot4imat

sutraWrap.Wfs.nphot4imat = property

static

Number of photons/ssp/iter used for imat computation.

   @n type of :  float

Definition at line 6363 of file sutraWrap.py.

◆ npix

sutraWrap.Wfs.npix = property

static

Pixels per ssp.

   @n type of :  int

Definition at line 6372 of file sutraWrap.py.

◆ npup

sutraWrap.Wfs.npup = property

static

Pupil support size.

   @n type of :  int

Definition at line 6381 of file sutraWrap.py.

◆ nrebin

sutraWrap.Wfs.nrebin = property

static

Rebin factor.

   @n type of :  int

Definition at line 6390 of file sutraWrap.py.

◆ ntot

sutraWrap.Wfs.ntot = property

static

HR support size.

   @n type of :  int

Definition at line 6399 of file sutraWrap.py.

◆ nvalid

sutraWrap.Wfs.nvalid = property

static

Number of valid ssp.

   @n type of :  int

Definition at line 6408 of file sutraWrap.py.

◆ nxsub

sutraWrap.Wfs.nxsub = property

static

Number of ssp in the diameter.

   @n type of :  int

Definition at line 6417 of file sutraWrap.py.

◆ roket

sutraWrap.Wfs.roket = property

static

Is the WFS a LGS one ?

   @n type of :  bool

Definition at line 6426 of file sutraWrap.py.

◆ subapd

sutraWrap.Wfs.subapd = property

static

ssp diameter in pixels

   @n type of :  float

Definition at line 6435 of file sutraWrap.py.

◆ type

sutraWrap.Wfs.type = property

static

WFS type.

   @n type of :  str

Definition at line 6444 of file sutraWrap.py.

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

sutraWrap.py

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ comp_image()

◆ fill_binimage()

◆ set_binimg()

◆ set_dark()

◆ set_fakecam()

◆ set_flat()

◆ set_max_flux_per_pix()

◆ set_max_pix_value()

◆ set_noise()

◆ set_pupil()

◆ slopes_geom() [1/2]

◆ slopes_geom() [2/2]

Property Documentation

◆ d_bincube

◆ d_binimg

◆ d_binimg_notnoisy

◆ d_camimg

◆ d_camplifoc

◆ d_camplipup

◆ d_dark

◆ d_flat

◆ d_fluxPerSub

◆ d_fttotim

◆ d_gs

◆ d_hrmap

◆ d_intensities

◆ d_offsets

◆ d_phasemap

◆ d_pupil

◆ d_sincar

◆ d_slopes

◆ d_submask

◆ d_ttprojmat

◆ d_ttprojvec

◆ d_validsubsx

◆ d_validsubsy

◆ device

◆ fakecam

◆ is_low_order

◆ kernconv

◆ lgs

◆ max_flux_per_pix

◆ max_pix_value

◆ nfft

◆ nffthr

◆ nmaxhr

◆ noise

◆ nphase

◆ nphot

◆ nphot4imat

◆ npix

◆ npup

◆ nrebin

◆ ntot

◆ nvalid

◆ nxsub

◆ roket

◆ subapd

◆ type