COMPASS  5.4.4
End-to-end AO simulation tool using GPU acceleration
common.wfs Namespace Reference

Functions

def get_subap_pos_pixel (wfs)
 Return the coordinates of the valid subapertures of a given WFS. More...
 
def get_subap_pos_meter (sup, wfs_id)
 Return the coordinates of the valid subapertures of a given WFS. More...
 
def wfs_to_json (wfs, geom, type, *x_pos=None, y_pos=None)
 return a json description of a wfs More...
 
def wfs_json_notice (type)
 Return the notice of the wfs json representation. More...
 

Function Documentation

◆ get_subap_pos_meter()

def common.wfs.get_subap_pos_meter (   sup,
  wfs_id 
)

Return the coordinates of the valid subapertures of a given WFS.

these coordinates are given in meters and centered

Parameters
sup(compassSupervisor) : supervisor
wfs_id(int) : index of the WFS
Return
valid_X (np.ndarray[ndim=1, dtype=np.float64]) : subapertures positions along axis x
valid_Y (np.ndarray[ndim=1, dtype=np.float64]) : subapertures positions along axis y

Definition at line 35 of file util/writers/common/wfs.py.

Here is the call graph for this function:

◆ get_subap_pos_pixel()

def common.wfs.get_subap_pos_pixel (   wfs)

Return the coordinates of the valid subapertures of a given WFS.

these coordinates are given in pixels

Parameters
wfsParam_wfs : wfs to get the subapertures position from
Return
valid_X (np.ndarray[ndim=1, dtype=np.float64]) : subapertures positions along axis x
valid_Y (np.ndarray[ndim=1, dtype=np.float64]) : subapertures positions along axis y

Definition at line 16 of file util/writers/common/wfs.py.

Here is the caller graph for this function:

◆ wfs_json_notice()

def common.wfs.wfs_json_notice (   type)

Return the notice of the wfs json representation.

Parameters
type(string) : wfs type ("lgs", "ngs" or "target")

Definition at line 127 of file util/writers/common/wfs.py.

◆ wfs_to_json()

def common.wfs.wfs_to_json (   wfs,
  geom,
  type,
x_pos = None,
  y_pos = None 
)

return a json description of a wfs

Parameters
wfs(Param_wfs) : wfs to represent as json
geom(Param_geom) : geom settings
type(string) : wfs type ("lgs", "ngs" "target" or "ts")
Kargs
x_pos (list(float)) : x coordinates of the targets ()
y_pos (list(float)) : y coordinates of the targets ()

Definition at line 61 of file util/writers/common/wfs.py.