Provided by: cpl-plugin-fors-doc_5.5.7+dfsg-2build1_all
NAME
fors_config - Creation of FORS recipes configuration tables
SYNOPSIS
esorex fors_config [OPTIONS] FILE.sof
DESCRIPTION
This recipe is used to create the so-called GRISM_TABLE, containing all the FORS spectral pipeline configuration parameters related to a specific grism. This is a way to provide for each specific instrument mode a set of appropriate defaults for the recipe parameters. The values assigned to each input parameter of fors_config are simply copied to a FITS table consisting of one row, and as many columns as the input parameter: each column will have the same name and type of each parameter. Only the three parameters "instrument", "grism", and "id" are not written to the table columns, but to the descriptor header keywords INSTRUME, ESO INS GRIS1 NAME, and ESO INS GRIS1 ID, that will be used by the automatic pipeline for appropriate data association. Input files: none DO category: Type: Explanation: Required: Output files: DO category: Data type: Explanation: GRISM_TABLE FITS table Recipe configuration parameters
OPTIONS
--dispersion <float> Expected spectral dispersion (Angstrom/pixel) (float; default: 0.0). The full name of this option for the EsoRex configuration file is fors.fors_config.dispersion [default = 0.0]. --peakdetection <float> Peak detection threshold (ADU) (float; default: 250.0). The full name of this option for the EsoRex configuration file is fors.fors_config.peakdetection [default = 250.0]. --wdegree <int> Degree of wavelength calibration polynomial (int; default: 4). The full name of this option for the EsoRex configuration file is fors.fors_config.wdegree [default = 4]. --cdegree <int> Degree of spectral curvature polynomial (int; default: 4). The full name of this option for the EsoRex configuration file is fors.fors_config.cdegree [default = 4]. --startwavelength <float> Start wavelength in spectral extraction (float; default: 0.0). The full name of this option for the EsoRex configuration file is fors.fors_config.startwavelength [default = 0.0]. --endwavelength <float> End wavelength in spectral extraction (float; default: 0.0). The full name of this option for the EsoRex configuration file is fors.fors_config.endwavelength [default = 0.0]. --instrument <str> Name of instrument (str; default: ´0´). The full name of this option for the EsoRex configuration file is fors.fors_config.instrument [default = 0]. --grism <str> Name of grism (str; default: ´0´). The full name of this option for the EsoRex configuration file is fors.fors_config.grism [default = 0]. --grism_id <str> Grism ID (str; default: ´0´). The full name of this option for the EsoRex configuration file is fors.fors_config.grism_id [default = 0]. --filter <str> Name of filter (str; default: ´0´). The full name of this option for the EsoRex configuration file is fors.fors_config.filter [default = 0]. --filter_id <str> Filter ID (str; default: ´0´). The full name of this option for the EsoRex configuration file is fors.fors_config.filter_id [default = 0]. Note that it is possible to create a configuration file containing these options, along with suitable default values. Please refer to the details provided by the 'esorex --help' command.
SEE ALSO
The full documentation for the fors pipeline can be downloaded as a PDF file using the following URL: ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf An overview over the existing ESO pipelines can be found on the web page https://www.eso.org/sci/software/pipelines/. Basic documentation about the EsoRex program can be found at the esorex (1) man page. It is possible to call the pipelines from python using the python-cpl package. See https://packages.python.org/python-cpl/index.html for further information. The other recipes of the fors pipeline are fors_align_sky(7), fors_align_sky_lss(7), fors_bias(7), fors_calib(7), fors_dark(7), fors_detect_objects(7), fors_detect_spectra(7), fors_extract(7), fors_extract_objects(7), fors_extract_slits(7), fors_flatfield(7), fors_img_science(7), fors_img_screen_flat(7), fors_img_sky_flat(7), fors_normalise_flat(7), fors_photometry(7), fors_pmos_calib(7), fors_pmos_extract(7), fors_pmos_science(7), fors_remove_bias(7), fors_resample(7), fors_science(7), fors_spec_mflat(7), fors_subtract_sky(7), fors_subtract_sky_lss(7), fors_sumflux(7), fors_trace_flat(7), fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7)
VERSION
fors_config 5.5.7
AUTHOR
Carlo Izzo <usd-help@eso.org>
BUG REPORTS
Please report any problems to usd-help@eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.
LICENSE
This file is currently part of the FORS Instrument Pipeline Copyright (C) 2002-2010 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 02110-1301 USA