table of contents
VMDARK(7) | vimos recipes | VMDARK(7) |
NAME¶
vmdark - Create a master dark from set of raw dark frames.
SYNOPSIS¶
esorex vmdark [OPTIONS] FILE.sof
DESCRIPTION¶
This recipe is used to create a master dark frame from a set of raw dark frames.
Input files:
DO category: Type: Explanation: Required:
DARK Raw Dark exposure Y
MASTER_BIAS Calib Master bias Y
CCD_TABLE Calib Bad pixel table .
Output files:
DO category: Data type: Explanation:
MASTER_DARK FITS image Master dark
A CCD table must be specified only if a bad pixel cleaning is requested.
For more details, please refer to the VIMOS Pipeline User´s Guide.
OPTIONS¶
- --AllowSingleFrames <bool>
- Frame combination method is ignored. (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.singleframes [default = True].
- --StackMethod <str>
- Frame combination method. (str; default: ´Median´). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.method [default = Median].
- --KSigmaLow <float>
- Low threshold for K-sigma clipping method. (float; default: 5.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.low [default = 5.0].
- --KSigmaHigh <float>
- High threshold for K-sigma clipping method. (float; default: 5.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.high [default = 5.0].
- --MinRejection <int>
- Number of lowest rejected values for rejection method. (int; default: 1). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.minimum [default = 1].
- --MaxRejection <int>
- Number of highest rejected values for rejection method. (int; default: 1). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.maximum [default = 1].
- --BiasMethod <str>
- Bias removal method. (str; default: ´Zmaster´). The full name of this option for the EsoRex configuration file is vimos.Parameters.bias.removing.method [default = Zmaster].
- --CleanBadPixel <bool>
- Bad pixel correction on master dark. (bool; default: False). The full name of this option for the EsoRex configuration file is vimos.Parameters.badpixel.clean [default = False].
- --CleanCosmic <bool>
- Cosmic ray events cleaning from raw darks. (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.clean [default = True].
- --CosmicThreshold <float>
- Threshold to identify cosmic rays candidates. (float; default: 4.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.threshold [default = 4.0].
- --CosmicRatio <float>
- Min ratio between peak and nearby pixels for a cosmic ray. (float; default: 2.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.ratio [default = 2.0].
- --ComputeQC <bool>
- Compute QC1 parameters (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.quality.enable [default = True].
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 vimos pipeline can be downloaded as a PDF file using the following URL:
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 vimos pipeline are vimos_ima_bias(7), vimos_ima_dark(7), vimos_ima_det_noise(7), vimos_ima_fringe(7), vimos_ima_science(7), vimos_ima_standard(7), vimos_ima_twilight_flat(7), vmbias(7), vmdet(7), vmifucalib(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7)
VERSION¶
vmdark 4.1.7
AUTHOR¶
ESO VIMOS Pipeline Team <https://support.eso.org>
BUG REPORTS¶
Please report any problems to https://support.eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.
LICENSE¶
This file is part of the VIMOS Instrument Pipeline Copyright (C) 2002-2005 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
4.1.7 | vmdark |