sutraWrap.Coronagraph Class Reference

Inheritance diagram for sutraWrap.Coronagraph:

Collaboration diagram for sutraWrap.Coronagraph:

Public Member Functions
int	compute_electric_field (self, int arg0)
	Computes the electric field from the specified wavelength. More...
int	compute_image (self, bool accumulate=True)
	Computes the coronagraphic image from the source phase screen. More...
int	compute_psf (self, bool accumulate=True)
	Computes the psf from the source phase screen. More...
int	reset (self)
	Reset long exposure image and counter. More...
int	set_amplitude (self, numpy.ndarray[numpy.float32] arg0)
	Set the electric field amplitude. More...

Properties
	amplitude = property
	Electric field amplitude in the pupil. More...
	cntImg = property
	Accumulation counter of coronagraphic images. More...
	cntPsf = property
	Accumulation counter of psf. More...
	d_complex_image = property
	Complex coronagraphic image. More...
	d_electric_field = property
	Electric field in the pupil. More...
	d_image_le = property
	Long exposure coronagraphic image. More...
	d_image_se = property
	Short exposure coronagraphic image. More...
	d_psf_le = property
	Long exposure coronagraphic psf. More...
	d_psf_se = property
	Short exposure coronagraphic psf. More...
	d_pupil = property
	Telescope pupil. More...
	d_source = property
	SutraSource used as OPD input. More...
	device = property
	GPU device index. More...
	imageDimx = property
	Coronagraphic image dimension along X-axis. More...
	imageDimy = property
	Coronagraphic image dimension along Y-axis. More...
	pupDimx = property
	Pupil dimension along X-axis. More...
	pupDimy = property
	Pupil dimension along Y-axis. More...
	type = property
	Coronagraph type. More...
	wavelength = property
	Vector of wavelength used to compute coronagraphic image. More...

Detailed Description

Definition at line 4528 of file sutraWrap.py.

Member Function Documentation

compute_electric_field()

int sutraWrap.Coronagraph.compute_electric_field	(		self,
		int	arg0
	)

Computes the electric field from the specified wavelength.

Parameters

wavelengthIndex

(int): Index of the wavelength to use

Definition at line 4535 of file sutraWrap.py.

compute_image()

int sutraWrap.Coronagraph.compute_image	(		self,
		bool	accumulate = True
	)

Computes the coronagraphic image from the source phase screen.

Parameters

accumulate

(bool, optionnal): If True (default), accumulate the short exposure image in the long exposure one

Definition at line 4542 of file sutraWrap.py.

compute_psf()

int sutraWrap.Coronagraph.compute_psf	(		self,
		bool	accumulate = True
	)

Computes the psf from the source phase screen.

Parameters

accumulate

(bool, optionnal): If True (default), accumulate the short exposure psf in the long exposure one

Definition at line 4549 of file sutraWrap.py.

Here is the caller graph for this function:

reset()

int sutraWrap.Coronagraph.reset

(

self

)

Reset long exposure image and counter.

Definition at line 4553 of file sutraWrap.py.

set_amplitude()

int sutraWrap.Coronagraph.set_amplitude	(		self,
		numpy.ndarray[numpy.float32]	arg0
	)

Set the electric field amplitude.

Parameters

amplitude

(np.ndarray[ndim=3, dtype=np.float32]): electric field amplitude

Definition at line 4560 of file sutraWrap.py.

Property Documentation

amplitude

sutraWrap.Coronagraph.amplitude = property

static

Electric field amplitude in the pupil.

   @n type of :  typing.List[carmaWrap.obj_float]

Definition at line 4567 of file sutraWrap.py.

cntImg

sutraWrap.Coronagraph.cntImg = property

static

Accumulation counter of coronagraphic images.

   @n type of :  int

Definition at line 4576 of file sutraWrap.py.

cntPsf

sutraWrap.Coronagraph.cntPsf = property

static

Accumulation counter of psf.

   @n type of :  int

Definition at line 4585 of file sutraWrap.py.

d_complex_image

sutraWrap.Coronagraph.d_complex_image = property

static

Complex coronagraphic image.

   @n type of :  carmaWrap.obj_float_complex

Definition at line 4594 of file sutraWrap.py.

d_electric_field

sutraWrap.Coronagraph.d_electric_field = property

static

Electric field in the pupil.

   @n type of :  carmaWrap.obj_float_complex

Definition at line 4603 of file sutraWrap.py.

d_image_le

sutraWrap.Coronagraph.d_image_le = property

static

Long exposure coronagraphic image.

   @n type of :  carmaWrap.obj_float

Definition at line 4612 of file sutraWrap.py.

d_image_se

sutraWrap.Coronagraph.d_image_se = property

static

Short exposure coronagraphic image.

   @n type of :  carmaWrap.obj_float

Definition at line 4621 of file sutraWrap.py.

d_psf_le

sutraWrap.Coronagraph.d_psf_le = property

static

Long exposure coronagraphic psf.

   @n type of :  carmaWrap.obj_float

Definition at line 4630 of file sutraWrap.py.

d_psf_se

sutraWrap.Coronagraph.d_psf_se = property

static

Short exposure coronagraphic psf.

   @n type of :  carmaWrap.obj_float

Definition at line 4639 of file sutraWrap.py.

d_pupil

sutraWrap.Coronagraph.d_pupil = property

static

Telescope pupil.

   @n type of :  carmaWrap.obj_float

Definition at line 4648 of file sutraWrap.py.

d_source

sutraWrap.Coronagraph.d_source = property

static

SutraSource used as OPD input.

   @n type of :  Source

Definition at line 4657 of file sutraWrap.py.

device

sutraWrap.Coronagraph.device = property

static

GPU device index.

   @n type of :  int

Definition at line 4666 of file sutraWrap.py.

imageDimx

sutraWrap.Coronagraph.imageDimx = property

static

Coronagraphic image dimension along X-axis.

   @n type of :  int

Definition at line 4675 of file sutraWrap.py.

imageDimy

sutraWrap.Coronagraph.imageDimy = property

static

Coronagraphic image dimension along Y-axis.

   @n type of :  int

Definition at line 4684 of file sutraWrap.py.

pupDimx

sutraWrap.Coronagraph.pupDimx = property

static

Pupil dimension along X-axis.

   @n type of :  int

Definition at line 4693 of file sutraWrap.py.

pupDimy

sutraWrap.Coronagraph.pupDimy = property

static

Pupil dimension along Y-axis.

   @n type of :  int

Definition at line 4702 of file sutraWrap.py.

type

sutraWrap.Coronagraph.type = property

static

Coronagraph type.

   @n type of :  str

Definition at line 4711 of file sutraWrap.py.

wavelength

sutraWrap.Coronagraph.wavelength = property

static

Vector of wavelength used to compute coronagraphic image.

   @n type of :  typing.List[float]

Definition at line 4720 of file sutraWrap.py.

---

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

• sutraWrap.py