Gateau User Manual
Atmospheric simulation of astronomical signals
atmosphere_utils.py File Reference

Utilities for preparing atmosphere screens that can be called by users. Also contains a function for generating atmospheric transmission curves. More...

Functions

Tuple[float, float] gateau.atmosphere_utils.prep_atm_ARIS_pool (Tuple[np.ndarray, int] args, str path_to_aris, float radius_tel, float sigma)
 Function that does the work of 'prep_atm_ARIS'. More...
 
None gateau.atmosphere_utils.prep_atm_ARIS (str path_to_aris, float radius_tel, float edge_taper=-10, int num_threads=NCPU)
 Prepare ARIS atmospheric screens for usage in gateau. More...
 
np.ndarray gateau.atmosphere_utils.get_eta_atm (np.ndarray f_src, float pwv0, float el0)
 Get atmospheric transmission curve for a range of frequencies. More...
 

Variables

 gateau.atmosphere_utils.NCPU = multiprocessing.cpu_count()
 

Detailed Description

Utilities for preparing atmosphere screens that can be called by users. Also contains a function for generating atmospheric transmission curves.

Function Documentation

◆ get_eta_atm()

np.ndarray gateau.atmosphere_utils.get_eta_atm ( np.ndarray  f_src,
float  pwv0,
float  el0 
)

Get atmospheric transmission curve for a range of frequencies.

Parameters
f_srcArray of frequencies at which to evaluate atmospheric transmission, in Hz.
pwv0PWV at which to evaluate transmission, in mm.
el0Elevation at which to evaluate transmission in degrees.
Returns
Array of atmospheric transmission values.

◆ prep_atm_ARIS_pool()

Tuple[float, float] gateau.atmosphere_utils.prep_atm_ARIS_pool ( Tuple[np.ndarray, int]  args,
str  path_to_aris,
float  radius_tel,
float  sigma 
)

Function that does the work of 'prep_atm_ARIS'.

It is not supposed to be used as-is, but rather to be passed to 'multiprocessing.Pool'.

Parameters
argsArguments over which parallelisation occurs. In this case, these are a list of ARIS screen names, and the thread index.
path_to_arisPath to folder containing ARIS screens.
radius_telRadius of primary aperture of telescope, in meters.
sigmaStandard deviation of Gaussian power pattern of primary aperture.
Returns
Number of cells along x-direction, per screen.
Number of cells along y-direction, per screen.
Minimum PWV fluctuation for all screens.
Maximum PWV fluctuation for all screens.