yao(1) [debian man page]
YAO(1) General Commands Manual YAO(1) NAME
yao - Adaptive Optics simulation tool in yorick SYNOPSIS
Start yao with the gtk GUI: yao parfile.par yorick -i yaopy.i parfile.par Within yorick (no GUI, but same graphical output) #include yao.i aoread,"parfile.par"; aoinit; aoloop; go; DESCRIPTION
Yao is a monte-carlo simulation package for adaptive optics. It includes fast core coded in C (e.g. wavefront sensing) that are glued together by yorick interpreted code. One defines the system to evaluate using a configuration file, and then run aoread, aoinit and aoloop. Yao features: * Shack-Hartmann and Curvature WFS, on or off axis. * Stackarray (piezostack), curvature (bimorph), modal (zernike) and Tip-Tilt deformable mirrors are supported. The altitude of conjugation is adjustable. * An arbitrary number of WFSs and DMs can be selected, with the possibility of mixing types. It is therefore possible (and easy) to simu- late single DM systems, as well as single non-zero conjugate, GLAO and MCAO systems. * It supports Natural and Laser Guide Stars (or a mix), WFS with photon and read-out noise. * It uses a multi-layered atmospheric model, with geometrical propagation only. * The loop execution has been optimized for speed: the critical routines have been coded in C. Yorick is thus used as a convenient glue between lower levels optimized C calls. Overall, this is rather efficient: A simple 6x6 Shack-Hartmann system runs at up to 650 itera- tions per second on an apple dual 2GHz G5 (200 iterations/sec for a full diffraction propagation model). A 50x50 Shack-Hartmann system runs at about 3 iterations/s. A 188 curvature system runs at 25 iterations/s. * Straightforward scriptability to probe parameter domains. * GTK GUI to change some of the system parameters while the loop is running (new in v4.0). This provides an educational approach to Adap- tive Optics (newbies can play with the parameters and immediately sees how the system reacts) and can also provides a quick way to investigate the stability conditions for a newly designed system, before entering more serious Monte-carlo simulations. Options help,aoread will give you information about the syntax, parameters and keywords of aoread. See help,aoinit and help,aoloop also. AUTHOR
Francois Rigaut, Gemini Observatory FILES
Input files: parfile.par A yao parameter file. This file follows a regular yorick syntax. It is directly included by yorick to define the structures used by yao. As it might be a little bit daunting to create a parfile from scratch, example parfiles are provided. Their location depends on the installation. Search for yao/examples (e.g. shx6x.par, curvature.par) screen*.fits To simulate the atmospheric turbulence, yao needs phase screens. You can create phase screens with create_phase_screens(). They might also be included in your distribution. Output files: parfile.res After a simulation run, results are output in parfile.res in the cwd BUGS
Lots. LGS uplink propagation is not implemented Shack-Hartmann cross talk between subapertures is not implemented Many more. SEE ALSO
yorick(1) 4th Berkeley Distribution 2007 December 12 YAO(1)
Check Out this Related Man Page
SPYDR(1) General Commands Manual SPYDR(1) NAME
spydr - GUI for Image display and analysis with yorick SYNOPSIS
Spydr (pronounce spider) can be invoqued from the shell spydr [ options ] image1.fits [ image2.fits ... ] where the fits images can contain single images (not necessarily of the same size) or data cube. Widlcards are allowed in names. or within yorick #include spydr.i spydr,im1,im2,cube spydr,"image1.fits",... COMMAND LINE OPTIONS
--conf file configuration file. --hdu value Specify a fits HDU to read --dpi value Yorick dpi value (yorick default = 75, spydr default = 83). Any value between 30 and 150 make sense. --itt value Intensity Transfer Table (1=linear, 2=sqrt, 3=square, 4=log, 5=hist equalized) --pixsize value Pixel size (or plate scale) in arcsec. --boxsize value Size of box for PSF fitting and Strehl calculation (pixels) --saturation value Value above which pixels have to be considered as saturated (ADU) --wavelength value Force wavelength for all images --zeropoint value Photometric zeropoint (magnitude) --nbins value Number of bins for histograms --strehlaper value Diameter of circular mask for Strehl calculations (pixels). The flux is integrated in a circle of this diameter, while the sky is estimated from the remaining pixels within the box of size "boxsize" --batch Turn on yorick batch mode (yorick quits when encountering an error). This flag is recommended when starting spydr from a non-inter- active session (e.g. from a gnome applet). --debug Turn on the verbose mode (debugging mode). --invert Invert LUT --fullgui Show the plugin pane when the GUI is realized --compact Hide the lower part of the GUI at startup DESCRIPTION
Spydr is a GUI for image visualization and simple analysis (cuts, zoom, values, statistics, histogram, sigma filter) with changeable LUT and ITT. Spydr has a couple of plugins to measure FWHM and Strehl. Press "?" on the main display area to get a popup help: The following shortcuts are available: x/y: Plot line/column under cursor X/Y: Toggle continuous plot of line/column under cursor c: Interactive plot of cut across image h: Plot histogram of visible region r: Radial plot centered on cursor f: Fit 1d gaussian to 1d plot e: Adjust min and max cut to 10% and 99.9% of distribution E: Reset min and max cut to min and max of visible region n/p: Next/prevous image s: Sigma filter displayed image -/+: Decrease/Increase zoom factor in zoom window ?: This help EXAMPLES
From the shell: $ spydr --dpi 74 --fullgui 20070730_2*.fits $ spydr --pixsize 0.127 20070730_2[2-3]?.fits 20070730_241.fits Within yorick: > spydr,"~/ascam/2007jun26/20070625T2000*.fits" > spydr,["20070730_1[1-3].fits","20070730_23.fits"] > spydr,image > spydr,[im1,im2] > spydr,im1,im2 ENVIRONMENT VARIABLES
Y_PYTHON Force the path to spydr.py. The default path is ./:Y_USER:Y_USER/python/:Y_SITES/python/:Y_SITE/python/ Y_GLADE Force the path to spydr.glade. The default path is ./:Y_USER:Y_USER/glade/:Y_SITES/glade/:Y_SITE/glade/ Y_CONF Force the path to spydr.conf. The default path is ./:Y_USER:Y_SITE:/etc/: ./share/:Y_USER/share/:Y_SITE/share/: ./share/spydr/:Y_USER/share/spydr/:Y_SITE/share/spydr/ RESTRICTIONS AND BUGS
- only fits images handled to date - the ITT display is not very well handled AUTHOR
Francois Rigaut, Gemini Observatory FILES
Input files: spydr.conf The spydr configuration file. Needed. It should have come with your installation. The routine which_spydrconf() returns the path to the used spydr.conf. The following directories are searched for spydr.conf, in this order: Y_USER, Y_SITE, /etc, Y_USER/share, Y_SITE/share, Y_USER/share/spydr, Y_SITE/share/spydr. If you wish to modify the defaults, copy the file over to Y_USER and modify at will. Output files: none. SEE ALSO
yorick(1), yao(1) 4th Berkeley Distribution 2008 January 02 SPYDR(1)