The vmbias recipe¶
- vmbias¶
Synopsis¶
Create a master bias from set of raw bias frames.
Description¶
This recipe is used to create a master bias frame from a set of raw bias frames.
Input files¶
DO category: Type: Explanation: Required:
BIAS Raw Bias exposure Y
CCD_TABLE Calib Bad pixel table .
Output files¶
DO category: Data type: Explanation:
MASTER_BIAS FITS image Master bias
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.
Constructor¶
- cpl.Recipe("vmbias")
Create an object for the recipe vmbias.
import cpl
vmbias = cpl.Recipe("vmbias")
Parameters¶
- vmbias.param.AllowSingleFrames¶
Frame combination method is ignored. (bool; default: True) [default=True].
- vmbias.param.StackMethod¶
Frame combination method (str; default: ‘Median’) [default=”Median”].
- vmbias.param.KSigmaLow¶
Low threshold for K-sigma clipping method (float; default: 5.0) [default=5.0].
- vmbias.param.KSigmaHigh¶
High threshold for K-sigma clipping method (float; default: 5.0) [default=5.0].
- vmbias.param.MinRejection¶
Number of lowest rejected values for rejection method (int; default: 1) [default=1].
- vmbias.param.MaxRejection¶
Number of highest rejected values for rejection method (int; default: 1) [default=1].
- vmbias.param.RemoveOverscan¶
Remove overscan regions from master bias (bool; default: True) [default=True].
- vmbias.param.CleanBadPixel¶
Bad pixel correction on master bias (bool; default: False) [default=False].
- vmbias.param.CleanCosmic¶
Cosmic ray removal from each raw bias (bool; default: False) [default=False].
- vmbias.param.ComputeQC¶
Compute QC1 parameters (bool; default: True) [default=True].
The following code snippet shows the default settings for the available parameters.
import cpl
vmbias = cpl.Recipe("vmbias")
vmbias.param.AllowSingleFrames = True
vmbias.param.StackMethod = "Median"
vmbias.param.KSigmaLow = 5.0
vmbias.param.KSigmaHigh = 5.0
vmbias.param.MinRejection = 1
vmbias.param.MaxRejection = 1
vmbias.param.RemoveOverscan = True
vmbias.param.CleanBadPixel = False
vmbias.param.CleanCosmic = False
vmbias.param.ComputeQC = True
You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:
import cpl
vmbias = cpl.Recipe("vmbias")
[...]
res = vmbias( ..., param = {"AllowSingleFrames":True, "StackMethod":"Median"})
See also
cpl.Recipe for more information about the recipe object.
Bug reports¶
Please report any problems to ESO VIMOS Pipeline Team. Alternatively, you may send a report to the ESO User Support Department.
Copyright¶
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
Code author: ESO VIMOS Pipeline Team <https://support.eso.org>