shesha.init.coronagraph_init Namespace Reference

Initialization of a Coronagraph object. More...

Functions
def	init_coronagraph (conf.Param_corono p_corono, pupdiam)
	Initialize the coronagraph. More...
def	init_sphere_aplc (conf.Param_corono p_corono, pupdiam)
	Dedicated function for SPHERE APLC coronagraph init. More...
def	init_perfect_coronagraph (conf.Param_corono p_corono, pupdiam)
	Dedicated function for perfect coronagraph init. More...
def	init_apodizer (conf.Param_corono p_corono, pupdiam)
	Apodizer init. More...
def	init_focal_plane_mask (conf.Param_corono p_corono)
	Focal plane mask init. More...
def	init_lyot_stop (conf.Param_corono p_corono, pupdiam)
	Lyot stop init. More...
def	init_mft (conf.Param_corono p_corono, pupdiam, planes, center_on_pixel=False)
	Initialize mft matrices. More...
def	mft_matrices (dim_input, dim_output, nbres, real_dim_input=None, inverse=False, norm='ortho', X_offset_input=0, Y_offset_input=0, X_offset_output=0, Y_offset_output=0)
	docstring More...
def	mft_multiplication (image, AA, BB, norm)
	Computes matrix multiplication for MFT. More...

Detailed Description

Initialization of a Coronagraph object.

Author

COMPASS Team https://github.com/ANR-COMPASS

Version

5.4.4

Date

2023/03/02

Copyright

GNU Lesser General Public License

This file is part of COMPASS https://anr-compass.github.io/compass/

Copyright (C) 2011-2023 COMPASS Team https://github.com/ANR-COMPASS All rights reserved. Distributed under GNU - LGPL

COMPASS is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

COMPASS: End-to-end AO simulation tool using GPU acceleration The COMPASS platform was designed to meet the need of high-performance for the simulation of AO systems.

The final product includes a software package for simulating all the critical subcomponents of AO, particularly in the context of the ELT and a real-time core based on several control approaches, with performances consistent with its integration into an instrument. Taking advantage of the specific hardware architecture of the GPU, the COMPASS tool allows to achieve adequate execution speeds to conduct large simulation campaigns called to the ELT.

The COMPASS platform can be used to carry a wide variety of simulations to both testspecific components of AO of the E-ELT (such as wavefront analysis device with a pyramid or elongated Laser star), and various systems configurations such as multi-conjugate AO.

COMPASS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with COMPASS. If not, see https://www.gnu.org/licenses/lgpl-3.0.txt.

Function Documentation

init_apodizer()

def shesha.init.coronagraph_init.init_apodizer	(	conf.Param_corono	p_corono,
			pupdiam
	)

Apodizer init.

Definition at line 121 of file coronagraph_init.py.

Here is the caller graph for this function:

init_coronagraph()

def shesha.init.coronagraph_init.init_coronagraph	(	conf.Param_corono	p_corono,
			pupdiam
	)

Initialize the coronagraph.

Definition at line 53 of file coronagraph_init.py.

Here is the call graph for this function:

init_focal_plane_mask()

def shesha.init.coronagraph_init.init_focal_plane_mask

(

conf.Param_corono

p_corono

)

Focal plane mask init.

Definition at line 138 of file coronagraph_init.py.

Here is the caller graph for this function:

init_lyot_stop()

def shesha.init.coronagraph_init.init_lyot_stop	(	conf.Param_corono	p_corono,
			pupdiam
	)

Lyot stop init.

Definition at line 190 of file coronagraph_init.py.

Here is the caller graph for this function:

init_mft()

def shesha.init.coronagraph_init.init_mft	(	conf.Param_corono	p_corono,
			pupdiam,
			planes,
			center_on_pixel = False
	)

Initialize mft matrices.

Definition at line 207 of file coronagraph_init.py.

Here is the call graph for this function:

init_perfect_coronagraph()

def shesha.init.coronagraph_init.init_perfect_coronagraph	(	conf.Param_corono	p_corono,
			pupdiam
	)

Dedicated function for perfect coronagraph init.

Definition at line 116 of file coronagraph_init.py.

Here is the caller graph for this function:

init_sphere_aplc()

def shesha.init.coronagraph_init.init_sphere_aplc	(	conf.Param_corono	p_corono,
			pupdiam
	)

Dedicated function for SPHERE APLC coronagraph init.

References

APLC SPHERE user manual, appendix A6 'NIR coronagraphs' https://www.eso.org/sci/facilities/paranal/instruments/sphere/doc.html IRDIS ESO instrument description https://www.eso.org/sci/facilities/paranal/instruments/sphere/inst.html

Definition at line 90 of file coronagraph_init.py.

Here is the call graph for this function:

Here is the caller graph for this function:

mft_matrices()

def shesha.init.coronagraph_init.mft_matrices	(		dim_input,
			dim_output,
			nbres,
			real_dim_input = None,
			inverse = False,
			norm = 'ortho',
			X_offset_input = 0,
			Y_offset_input = 0,
			X_offset_output = 0,
			Y_offset_output = 0
	)

docstring

Definition at line 271 of file coronagraph_init.py.

Here is the caller graph for this function:

mft_multiplication()

def shesha.init.coronagraph_init.mft_multiplication	(		image,
			AA,
			BB,
			norm
	)

Computes matrix multiplication for MFT.

Definition at line 391 of file coronagraph_init.py.