The giframestack recipe¶
- giframestack¶
Synopsis¶
Creates a stacked image from a set of raw images.
Description¶
TBD
Constructor¶
- cpl.Recipe("giframestack")
Create an object for the recipe giframestack.
import cpl
giframestack = cpl.Recipe("giframestack")
Parameters¶
- giframestack.param.stack_method¶
Stacking method: average, median, minmax or ksigma (str; default: ‘average’) [default=”average”].
- giframestack.param.stack_ksigmalow¶
Lower threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].
- giframestack.param.stack_ksigmahigh¶
Upper threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].
- giframestack.param.stack_minreject¶
Minimum rejection level for method minmax (int; default: 1) [default=1].
- giframestack.param.stack_maxreject¶
Maximum rejection level for method minmax (int; default: 1) [default=1].
The following code snippet shows the default settings for the available parameters.
import cpl
giframestack = cpl.Recipe("giframestack")
giframestack.param.stack_method = "average"
giframestack.param.stack_ksigmalow = 5.0
giframestack.param.stack_ksigmahigh = 5.0
giframestack.param.stack_minreject = 1
giframestack.param.stack_maxreject = 1
You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:
import cpl
giframestack = cpl.Recipe("giframestack")
[...]
res = giframestack( ..., param = {"stack_method":"average", "stack_ksigmalow":5.0})
See also
cpl.Recipe for more information about the recipe object.
Bug reports¶
Please report any problems to Giraffe Pipeline. Alternatively, you may send a report to the ESO User Support Department.
Copyright¶
This file is part of the GIRAFFE Instrument Pipeline Copyright (C) 2002-2014 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: Giraffe Pipeline <https://support.eso.org/>