The naco_img_checkfocus recipe¶
- naco_img_checkfocus¶
Synopsis¶
Focus check recipe
Description¶
naco_img_checkfocus – The focus checking recipe The Set Of Frames (sof-file) must specify at least four files and they must be tagged NACO-raw-file.fits TECH_FOCUS The first of the files is used as a dark frame.
Constructor¶
- cpl.Recipe("naco_img_checkfocus")
Create an object for the recipe naco_img_checkfocus.
import cpl
naco_img_checkfocus = cpl.Recipe("naco_img_checkfocus")
Parameters¶
- naco_img_checkfocus.param.plot¶
The recipe can produce a number of predefined plots. Zero means that none of the plots are produced, while increasing values (e.g. 1 or 2) increases the number of plots produced. If the plotting fails a warning is produced, and the recipe continues. The default behaviour of the plotting is to use gnuplot (with option -persist). The recipe currently produces 1D-plots using gnuplot commands. The recipe user can control the actual plotting-command used by the recipe to create the plot by setting the environment variable CPL_PLOTTER. Currently, if CPL_PLOTTER is set it must contain the string ‘gnuplot’. Setting it to ‘cat > my_gnuplot_$$.txt’ causes a number of ASCII-files to be created, which each produce a plot when given as standard input to gnuplot (e.g. later or on a different computer). A finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color) and then setting CPL_PLOTTER to my_gnuplot.pl. The predefined plots include plotting of images. Images can be plotted not only with gnuplot, but also using the pnm format. This is controlled with the environment variable CPL_IMAGER. If CPL_IMAGER is set to a string that does not contain the word gnuplot, the recipe will generate the plot in pnm format. E.g. setting CPL_IMAGER to ‘display - &’ will produce a gray-scale image using the image viewer display. (int; default: 0) [default=0].
- naco_img_checkfocus.param.star_r¶
The star radius [arcsecond] (float; default: 2.0) [default=2.0].
- naco_img_checkfocus.param.bg_r1¶
The internal radius of the background [arcsecond] (float; default: 2.0) [default=2.0].
- naco_img_checkfocus.param.bg_r2¶
The external radius of the background [arcsecond] (float; default: 3.0) [default=3.0].
The following code snippet shows the default settings for the available parameters.
import cpl
naco_img_checkfocus = cpl.Recipe("naco_img_checkfocus")
naco_img_checkfocus.param.plot = 0
naco_img_checkfocus.param.star_r = 2.0
naco_img_checkfocus.param.bg_r1 = 2.0
naco_img_checkfocus.param.bg_r2 = 3.0
You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:
import cpl
naco_img_checkfocus = cpl.Recipe("naco_img_checkfocus")
[...]
res = naco_img_checkfocus( ..., param = {"plot":0, "star_r":2.0})
See also
cpl.Recipe for more information about the recipe object.
Bug reports¶
Please report any problems to Lars Lundin. Alternatively, you may send a report to the ESO User Support Department.
Copyright¶
This file is part of the NACO Instrument Pipeline Copyright (C) 2002, 2003, 2005, 2008 European Southern Observatory
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA
Code author: Lars Lundin <usd-help@eso.org>