nfssim

Overview

Simulate the results of the Next-Field-Selector and Guider-Focus-Alignment systems, plus the Fiber-View-Camera image itself.

Input

Arguments

instrument

a string designating the instrument to be used (desi or proto)

Configuration

TODO

Output

seqid

the sequence id of the simulated sequence

nfs_data

miscellaneous parameters associated with the sequence

targets

the target catalog used to dial the positioners

gfa_images

image data from the GFA system

fvc_image

image data from the FVC camera

Return value

Either SUCCESS if the the caluculation is successful, or an error message othewise.

Use

First, a PML connection must be established:

>>> from DOSlib.PML import dos_connection
>>> pm = dos_connection('PLATEMAKER')
>>> pm.execute('configure')
'SUCCESS'

Actually execute nfssim:

>>> pm.execute('set', instrument='desi')
'SUCCESS'
>>> pm.execute('nfssim') 
52...

The results of the calculations can then be retrieved:

>>> seqid = pm.execute('get', 'seqid')
>>> nfs_data = pm.execute('get', 'nfs_data')
>>> targets = pm.execute('get', 'targets')
>>> gfa_images = pm.execute('get', 'gfa_images')
>>> fvc_image = pm.execute('get', 'fvc_image')