The vmdark recipe¶
-
vmdark
¶
Synopsis¶
Create a master dark from set of raw dark frames.
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.
Constructor¶
-
cpl.
Recipe
("vmdark") Create an object for the recipe vmdark.
import cpl
vmdark = cpl.Recipe("vmdark")
Parameters¶
-
vmdark.param.
AllowSingleFrames
¶ Frame combination method is ignored. (bool; default: True) [default=True].
-
vmdark.param.
StackMethod
¶ Frame combination method. (str; default: ‘Median’) [default=”Median”].
-
vmdark.param.
KSigmaLow
¶ Low threshold for K-sigma clipping method. (float; default: 5.0) [default=5.0].
-
vmdark.param.
KSigmaHigh
¶ High threshold for K-sigma clipping method. (float; default: 5.0) [default=5.0].
-
vmdark.param.
MinRejection
¶ Number of lowest rejected values for rejection method. (int; default: 1) [default=1].
-
vmdark.param.
MaxRejection
¶ Number of highest rejected values for rejection method. (int; default: 1) [default=1].
-
vmdark.param.
BiasMethod
¶ Bias removal method. (str; default: ‘Zmaster’) [default=”Zmaster”].
-
vmdark.param.
CleanBadPixel
¶ Bad pixel correction on master dark. (bool; default: False) [default=False].
-
vmdark.param.
CleanCosmic
¶ Cosmic ray events cleaning from raw darks. (bool; default: True) [default=True].
-
vmdark.param.
CosmicThreshold
¶ Threshold to identify cosmic rays candidates. (float; default: 4.0) [default=4.0].
-
vmdark.param.
CosmicRatio
¶ Min ratio between peak and nearby pixels for a cosmic ray. (float; default: 2.0) [default=2.0].
-
vmdark.param.
ComputeQC
¶ Compute QC1 parameters (bool; default: True) [default=True].
The following code snippet shows the default settings for the available parameters.
import cpl
vmdark = cpl.Recipe("vmdark")
vmdark.param.AllowSingleFrames = True
vmdark.param.StackMethod = "Median"
vmdark.param.KSigmaLow = 5.0
vmdark.param.KSigmaHigh = 5.0
vmdark.param.MinRejection = 1
vmdark.param.MaxRejection = 1
vmdark.param.BiasMethod = "Zmaster"
vmdark.param.CleanBadPixel = False
vmdark.param.CleanCosmic = True
vmdark.param.CosmicThreshold = 4.0
vmdark.param.CosmicRatio = 2.0
vmdark.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
vmdark = cpl.Recipe("vmdark")
[...]
res = vmdark( ..., 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 <usd-help@eso.org>