sutraWrap.PerfectCoronagraph Class Reference

Inheritance diagram for sutraWrap.PerfectCoronagraph:

Collaboration diagram for sutraWrap.PerfectCoronagraph:

Public Member Functions
None	__init__ (self, carmaWrap.context context, Source d_source, int im_dimx, int im_dimy, numpy.ndarray[numpy.float32] wavelength, int nWavelength, int device)
	Instantiates a PerfectCoronagraph object. 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 matrix. More...
	BB = property
	B MFT matrix. 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 6448 of file sutraWrap.py.

Constructor & Destructor Documentation

__init__()

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

Instantiates a PerfectCoronagraph 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
wavelength	(np.ndarray[ndim=1, dtype=np.float32]): vector of wavelengths
nWavelength	(int): number of wavelength
device	(int): GPU device index

Definition at line 6467 of file sutraWrap.py.

Member Function Documentation

set_mft()

int sutraWrap.PerfectCoronagraph.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 6480 of file sutraWrap.py.

Property Documentation

AA

sutraWrap.PerfectCoronagraph.AA = property

static

A MFT matrix.

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

Definition at line 6487 of file sutraWrap.py.

BB

sutraWrap.PerfectCoronagraph.BB = property

static

B MFT matrix.

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

Definition at line 6496 of file sutraWrap.py.

norm

sutraWrap.PerfectCoronagraph.norm = property

static

MFT normalization.

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

Definition at line 6505 of file sutraWrap.py.

---

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

• sutraWrap.py