COMPASS  5.4.4
End-to-end AO simulation tool using GPU acceleration
yao.dm Namespace Reference

Functions

def init_dm (file_name)
 Initialise dm entry in yao parameter file. More...
 
def write_dm (file_name, dm, index, *sub_system=1)
 Write (append) dm parameter to file for YAO use for a single dm. More...
 
def write_dms (file_name, dms, *sub_system=1, offset=0)
 Write (append) dm parameter to file for YAO. More...
 
def finish_dm (file_name, n_dm)
 Finalize wfs section in yao parameter file. More...
 

Variables

dictionary YAO_DMTYPE
 

Function Documentation

◆ finish_dm()

def yao.dm.finish_dm (   file_name,
  n_dm 
)

Finalize wfs section in yao parameter file.

Parameters
file_name(str) : yao parameter file name
n_dm(int) : number of ngs written to yao parameter file

Definition at line 83 of file yao/dm.py.

◆ init_dm()

def yao.dm.init_dm (   file_name)

Initialise dm entry in yao parameter file.

Parameters
file_name(str) : yao parameter file name

Definition at line 9 of file yao/dm.py.

◆ write_dm()

def yao.dm.write_dm (   file_name,
  dm,
  index,
sub_system = 1 
)

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

Parameters
file_name(str) : name of the file to append the parameter to
dm(Param_dm) : compass dm parameters
index(int) : YAO index for dm
sub_system(int) : (optional), default 1 index of yao sub-system

Definition at line 28 of file yao/dm.py.

Here is the caller graph for this function:

◆ write_dms()

def yao.dm.write_dms (   file_name,
  dms,
sub_system = 1,
  offset = 0 
)

Write (append) dm parameter to file for YAO.

Parameters
file_namestr : name of the file to append the parameter to
dmslist[Param_dm] : compass dm parameters list
sub_system(int) : (optional), default 1 index of yao sub-system
offset(int) : (optional), default 0 yao dm index offset
Returns
n_dm (int) : number of dm passed to yao

Definition at line 63 of file yao/dm.py.

Here is the call graph for this function:

Variable Documentation

◆ YAO_DMTYPE

dictionary yao.dm.YAO_DMTYPE
Initial value:
1 = {"pzt":"\"stackarray\"",
2  "tt" :"\"tiptilt\""}

Definition at line 1 of file yao/dm.py.