Inheritance diagram for sutraWrap.StellarCoronagraph:

Collaboration diagram for sutraWrap.StellarCoronagraph:

Public Member Functions
None	__init__ (self, carmaWrap.context context, Source d_source, int im_dimx, int im_dimy, int fpm_dimx, int fpm_dimy, numpy.ndarray[numpy.float32] wavelength, int nWavelength, int babinet, int device)
	Instantiates a StellarCoronagraph object. More...

int	compute_image_normalization (self)
	Compute image for normalization. More...

int	set_apodizer (self, numpy.ndarray[numpy.float32] mask)
	Set apodizer for coronagraphic image computation. More...

int	set_focal_plane_mask (self, numpy.ndarray[numpy.float32] mask)
	Set focal plane mask for coronagraphic image computation. More...

int	set_lyot_stop (self, numpy.ndarray[numpy.float32] mask)
	Set lyot_stop for coronagraphic image computation. More...

int	set_mft (self, numpy.ndarray[numpy.complex64] A, numpy.ndarray[numpy.complex64] B, numpy.ndarray[numpy.float32] norm, str mft_type)
	Set MFT matrices for coronagraphic image computation. More...

Public Member Functions inherited from sutraWrap.Coronagraph
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
	AA = property
	A MFT matrices. More...

	BB = property
	B MFT matrices. More...

	babinet = property
	Babinet trick flag. More...

	d_apodizer = property
	Apodizer. More...

	d_lyot_stop = property
	Lyot stop. More...

	focal_plane_mask = property
	Focal plane mask. More...

	fpmDimx = property
	Focal plane dimension. More...

	fpmDimy = property
	Focal plane dimension. More...

	norm = property
	MFT normalization. More...

Properties inherited from sutraWrap.Coronagraph
	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 8489 of file sutraWrap.py.

Constructor & Destructor Documentation

◆ init()

None sutraWrap.StellarCoronagraph.__init__	(		self,
		carmaWrap.context	context,
		Source	d_source,
		int	im_dimx,
		int	im_dimy,
		int	fpm_dimx,
		int	fpm_dimy,
		numpy.ndarray[numpy.float32]	wavelength,
		int	nWavelength,
		int	babinet,
		int	device
	)

Instantiates a StellarCoronagraph object.

Parameters

context	(CarmaContext): context
d_source	(SutraSource): Coronagraph source input
im_dimx	(int): Coronagraphic image dimension along x axis
im_dimy	(int): Coronagraphic image dimension along y axis
fpm_dimx	(int): Focal plane dimension along x axis
fpm_dimy	(int): Focal plane dimension along y axis
wavelength	(np.ndarray[ndim=1, dtype=np.float32]): vector of wavelengths
nWavelength	(int): number of wavelength
babinet	(bool): Flag to enable Babinet trick
device	(int): GPU device index

Definition at line 8514 of file sutraWrap.py.

Member Function Documentation

◆ compute_image_normalization()

int sutraWrap.StellarCoronagraph.compute_image_normalization ( self )

Compute image for normalization.

Definition at line 8519 of file sutraWrap.py.

◆ set_apodizer()

int sutraWrap.StellarCoronagraph.set_apodizer	(		self,
		numpy.ndarray[numpy.float32]	mask
	)

Set apodizer for coronagraphic image computation.

Parameters

mask	(np.ndarray[ndim=2, dtype=np.float32]): apodizer

Definition at line 8526 of file sutraWrap.py.

◆ set_focal_plane_mask()

int sutraWrap.StellarCoronagraph.set_focal_plane_mask	(		self,
		numpy.ndarray[numpy.float32]	mask
	)

Set focal plane mask for coronagraphic image computation.

Parameters

mask	(np.ndarray[ndim=3, dtype=np.float32]): Focal plane mask for each wavelength

Definition at line 8533 of file sutraWrap.py.

◆ set_lyot_stop()

int sutraWrap.StellarCoronagraph.set_lyot_stop	(		self,
		numpy.ndarray[numpy.float32]	mask
	)

Set lyot_stop for coronagraphic image computation.

Parameters

mask	(np.ndarray[ndim=2, dtype=np.float32]): lyot_stop

Definition at line 8540 of file sutraWrap.py.

◆ set_mft()

int sutraWrap.StellarCoronagraph.set_mft	(		self,
		numpy.ndarray[numpy.complex64]	A,
		numpy.ndarray[numpy.complex64]	B,
		numpy.ndarray[numpy.float32]	norm,
		str	mft_type
	)

Set MFT matrices for coronagraphic image computation.

Parameters

A	(np.ndarray[dtype=np.complex32, ndims=3]): A MFT matrix for each wavelength
B	(np.ndarray[dtype=np.complex32, ndims=3]): B MFT matrix for each wavelength
norm	(np.ndarray[dtype=np.complex32, ndims=3]): MFT normalization for each wavelength
mft_type	(str): MFT matrices to set, i.e. "img" or "psf"

Definition at line 8553 of file sutraWrap.py.

Property Documentation

◆ AA

sutraWrap.StellarCoronagraph.AA = property

static

A MFT matrices.

   @n type of :  typing.Dict[str, typing.Tuple[typing.List[carmaWrap.obj_float_complex], typing.List[int]]]

Definition at line 8560 of file sutraWrap.py.

◆ babinet

sutraWrap.StellarCoronagraph.babinet = property

static

Babinet trick flag.

   @n type of :  bool

Definition at line 8578 of file sutraWrap.py.

◆ BB

sutraWrap.StellarCoronagraph.BB = property

static

B MFT matrices.

   @n type of :  typing.Dict[str, typing.Tuple[typing.List[carmaWrap.obj_float_complex], typing.List[int]]]

Definition at line 8569 of file sutraWrap.py.

◆ d_apodizer

sutraWrap.StellarCoronagraph.d_apodizer = property

static

Apodizer.

   @n type of :  carmaWrap.obj_float

Definition at line 8587 of file sutraWrap.py.

◆ d_lyot_stop

sutraWrap.StellarCoronagraph.d_lyot_stop = property

static

Lyot stop.

   @n type of :  carmaWrap.obj_float

Definition at line 8596 of file sutraWrap.py.

◆ focal_plane_mask

sutraWrap.StellarCoronagraph.focal_plane_mask = property

static

Focal plane mask.

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

Definition at line 8605 of file sutraWrap.py.

◆ fpmDimx

sutraWrap.StellarCoronagraph.fpmDimx = property

static

Focal plane dimension.

   @n type of :  int

Definition at line 8614 of file sutraWrap.py.

◆ fpmDimy

sutraWrap.StellarCoronagraph.fpmDimy = property

static

Focal plane dimension.

   @n type of :  int

Definition at line 8623 of file sutraWrap.py.

◆ norm

sutraWrap.StellarCoronagraph.norm = property

static

MFT normalization.

   @n type of :  typing.Dict[str, typing.List[float]]

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

◆ compute_image_normalization()

◆ set_apodizer()

◆ set_focal_plane_mask()

◆ set_lyot_stop()

◆ set_mft()

Property Documentation

◆ AA

◆ babinet

◆ BB

◆ d_apodizer

◆ d_lyot_stop

◆ focal_plane_mask

◆ fpmDimx

◆ fpmDimy

◆ norm

◆ init()