yao.wfs Namespace Reference

Functions
def	init_wfs (file_name)
	Initialise wfs entry in yao parameter file. More...
def	write_wfs (file_name, wfs, index, *sub_system=1)
	Write (append) wfs parameter to file for YAO use for a single wfs. More...
def	write_wfss (file_name, wfss, *n_wfs=-1, sub_system=1, offset=0)
	Write (append) wfs parameter to file for YAO use for a wfs list. More...
def	finish_wfs (file_name, n_ngs, n_lgs)
	Finalize wfs section in yao parameter file. More...

Variables
dictionary	YAO_WFSTYPE = {"sh":"\"hartmann\"", "pyrhr":"\"pyramid\""}

Function Documentation

finish_wfs()

def yao.wfs.finish_wfs	(		file_name,
			n_ngs,
			n_lgs
	)

Finalize wfs section in yao parameter file.

Parameters

file_name	(str) : yao parameter file name
n_ngs	(int) : number of ngs written to yao parameter file
n_lgs	(int) : number of lgs written to yao parameter file

Definition at line 122 of file util/writers/yao/wfs.py.

init_wfs()

def yao.wfs.init_wfs

(

file_name

)

Initialise wfs entry in yao parameter file.

Parameters

file_name

(str) : yao parameter file name

Definition at line 10 of file util/writers/yao/wfs.py.

write_wfs()

def yao.wfs.write_wfs	(		file_name,
			wfs,
			index,
		*	sub_system = 1
	)

Write (append) wfs parameter to file for YAO use for a single wfs.

Parameters

file_name	(str) : name of the file to append the parameter to
wfs	(Param_wfs) : compass wfs parameters
index	wfs index in ayo parameter file
sub_system	(int) : (optional), default 1 sub_system in yao

Definition at line 29 of file util/writers/yao/wfs.py.

Here is the caller graph for this function:

write_wfss()

def yao.wfs.write_wfss	(		file_name,
			wfss,
		*	n_wfs = -1,
			sub_system = 1,
			offset = 0
	)

Write (append) wfs parameter to file for YAO use for a wfs list.

Parameters

file_name	(str) : name of the file to append the parameter to
wfss	(list[ Param_wfs]) : compass wfs parameters list
n_wfs	(int) : (optional), default -1 number of wfs passed to yao (-1 : all wfs)
sub_system	(int) : (optional), default 1 yao sub system index
offset	(int) : (optional), default 0 yao wfs index offset

Returns

n_ngs (int) : number of ngs passed to yao

n_lgs (int) : number of lgs passed to yao

Definition at line 87 of file util/writers/yao/wfs.py.

Here is the call graph for this function:

Variable Documentation

YAO_WFSTYPE

dictionary yao.wfs.YAO_WFSTYPE = {"sh":"\"hartmann\"", "pyrhr":"\"pyramid\""}

Definition at line 3 of file util/writers/yao/wfs.py.