Collaboration diagram for sutraWrap.Telescope:

Public Member Functions
None	__init__ (self, carmaWrap.context context, int n_pup, int npos, numpy.ndarray[numpy.float32] pupil, int n_pup_m, numpy.ndarray[numpy.float32] pupil_m)
	Create and initialise a Telescope object. More...

int	reset_input_phase (self)
	Reset circular buffer d_input_phase. More...

int	set_input_phase (self, numpy.ndarray[numpy.float32] phase_ab)
	Set a 3D cube of phase screens to be played. More...

int	set_phase_ab_M1 (self, numpy.ndarray[numpy.float32] phase_ab)
	Set the M1 phase aberration in the small pupil. More...

int	set_phase_ab_M1_m (self, numpy.ndarray[numpy.float32] phase_ab)
	Set the M1 phase aberration in the medium pupil. More...

None	set_pupil (self, numpy.ndarray[numpy.float32] pup)
	Set the small pupil. More...

None	set_pupil_m (self, numpy.ndarray[numpy.float32] pup)
	Set the medium pupil. More...

int	update_input_phase (self)
	Update input_phase_counter to take the next phase screen in the circular buffer d_input_phase. More...

Properties
	d_input_phase = property
	Cube of user-defined input phase screens. More...

	d_phase_ab_M1 = property
	M1 aberrations on the small pupil. More...

	d_phase_ab_M1_m = property
	M1 aberrations on the medium pupil. More...

	d_pupil = property
	Small pupil of the Telescope. More...

	d_pupil_m = property
	Medium pupil of the Telescope. More...

	device = property
	Device number. More...

	input_phase_counter = property
	Index of the current phase screen in the cube d_input_phase. More...

	num_eleme_pup = property
	number of points in the pupil More...

	pup_size = property
	Small Pupil size. More...

	pup_size_m = property
	Medium Pupil size. More...

Detailed Description

Definition at line 8685 of file sutraWrap.py.

Constructor & Destructor Documentation

◆ init()

None sutraWrap.Telescope.__init__	(		self,
		carmaWrap.context	context,
		int	n_pup,
		int	npos,
		numpy.ndarray[numpy.float32]	pupil,
		int	n_pup_m,
		numpy.ndarray[numpy.float32]	pupil_m
	)

Create and initialise a Telescope object.

Parameters

context	(CarmaContext) : current carma context
n_pup	(long) : spupil size
npos	(long): number of points in the pupil
pupil	(np.ndarray[ndim=2, dtype=np.float32_t]) : spupil
n_pup_m	(long) : mpupil size
pupil_m	(np.ndarray[ndim=2, dtype=np.float32_t]) : mpupil

Definition at line 8703 of file sutraWrap.py.

Member Function Documentation

◆ reset_input_phase()

int sutraWrap.Telescope.reset_input_phase ( self )

Reset circular buffer d_input_phase.

Definition at line 8707 of file sutraWrap.py.

◆ set_input_phase()

int sutraWrap.Telescope.set_input_phase	(		self,
		numpy.ndarray[numpy.float32]	phase_ab
	)

Set a 3D cube of phase screens to be played.

Each phase screen is shown to sources as an additional layer to be raytraced. Each phase screen must have the same dimensions as m_pupil

Parameters

input_hase (np.ndarray[ndim=3,dtype=np.float32_t]) : Cube of input phase screens

Definition at line 8715 of file sutraWrap.py.

◆ set_phase_ab_M1()

int sutraWrap.Telescope.set_phase_ab_M1	(		self,
		numpy.ndarray[numpy.float32]	phase_ab
	)

Set the M1 phase aberration in the small pupil.

Parameters

phase_ab (np.ndarray[ndim=2,dtype=np.float32_t]) : M1 phase aberration in the small pupil

Definition at line 8723 of file sutraWrap.py.

◆ set_phase_ab_M1_m()

int sutraWrap.Telescope.set_phase_ab_M1_m	(		self,
		numpy.ndarray[numpy.float32]	phase_ab
	)

Set the M1 phase aberration in the medium pupil.

Parameters

phase_ab (np.ndarray[ndim=2,dtype=np.float32_t]) : M1 phase aberration in the medium pupil

Definition at line 8731 of file sutraWrap.py.

◆ set_pupil()

None sutraWrap.Telescope.set_pupil	(		self,
		numpy.ndarray[numpy.float32]	pup
	)

Set the small pupil.

Parameters

pup	(np.ndarray[ndim=2,dtype=np.float32_t]) : small pupil

Definition at line 8739 of file sutraWrap.py.

◆ set_pupil_m()

None sutraWrap.Telescope.set_pupil_m	(		self,
		numpy.ndarray[numpy.float32]	pup
	)

Set the medium pupil.

Parameters

pup	(np.ndarray[ndim=2,dtype=np.float32_t]) : medium pupil

Definition at line 8747 of file sutraWrap.py.

◆ update_input_phase()

int sutraWrap.Telescope.update_input_phase ( self )

Update input_phase_counter to take the next phase screen in the circular buffer d_input_phase.

Definition at line 8751 of file sutraWrap.py.

Property Documentation

◆ d_input_phase

sutraWrap.Telescope.d_input_phase = property

static

Cube of user-defined input phase screens.

   @n type of :  carmaWrap.obj_float

Definition at line 8758 of file sutraWrap.py.

◆ d_phase_ab_M1

sutraWrap.Telescope.d_phase_ab_M1 = property

static

M1 aberrations on the small pupil.

   @n type of :  carmaWrap.obj_float

Definition at line 8767 of file sutraWrap.py.

◆ d_phase_ab_M1_m

sutraWrap.Telescope.d_phase_ab_M1_m = property

static

M1 aberrations on the medium pupil.

   @n type of :  carmaWrap.obj_float

Definition at line 8776 of file sutraWrap.py.

◆ d_pupil

sutraWrap.Telescope.d_pupil = property

static

Small pupil of the Telescope.

   @n type of :  carmaWrap.obj_float

Definition at line 8785 of file sutraWrap.py.

◆ d_pupil_m

sutraWrap.Telescope.d_pupil_m = property

static

Medium pupil of the Telescope.

   @n type of :  carmaWrap.obj_float

Definition at line 8794 of file sutraWrap.py.

◆ device

sutraWrap.Telescope.device = property

static

Device number.

   @n type of :  int

Definition at line 8803 of file sutraWrap.py.

◆ input_phase_counter

sutraWrap.Telescope.input_phase_counter = property

static

Index of the current phase screen in the cube d_input_phase.

   @n type of :  int

Definition at line 8812 of file sutraWrap.py.

◆ num_eleme_pup

sutraWrap.Telescope.num_eleme_pup = property

static

number of points in the pupil

   @n type of :  int

Definition at line 8821 of file sutraWrap.py.

◆ pup_size

sutraWrap.Telescope.pup_size = property

static

Small Pupil size.

   @n type of :  int

Definition at line 8830 of file sutraWrap.py.

◆ pup_size_m

sutraWrap.Telescope.pup_size_m = property

static

Medium Pupil size.

   @n type of :  int

Definition at line 8839 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

◆ reset_input_phase()

◆ set_input_phase()

◆ set_phase_ab_M1()

◆ set_phase_ab_M1_m()

◆ set_pupil()

◆ set_pupil_m()

◆ update_input_phase()

Property Documentation

◆ d_input_phase

◆ d_phase_ab_M1

◆ d_phase_ab_M1_m

◆ d_pupil

◆ d_pupil_m

◆ device

◆ input_phase_counter

◆ num_eleme_pup

◆ pup_size

◆ pup_size_m

◆ init()