/usr/share/doc/cpl-plugin-fors-doc/html/_sources/fors_spec_mflat.txt is in cpl-plugin-fors-doc 4.11.12+dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | The fors_spec_mflat recipe
===============================================================
.. data:: fors_spec_mflat
Synopsis
--------
Computes master spectroscopic flat, removing bias first
Description
-----------
This recipe is used to subtract the master bias, produced by the recipe
fors_bias, from a set of raw flat field frames. The input raw frames are
summed, the master bias frame is rescaled accordingly, and subtracted
from the result. The overscan regions, if present, are used to compensate
for variations of the bias level between master bias and input raw frames.
The overscan regions are then trimmed from the result.
In the table below the MXU acronym can be alternatively read as MOS and
LSS.
Input files
^^^^^^^^^^^^
::
DO category: Type: Explanation: Required:
SCREEN_FLAT_MXU Raw Raw data frame Y
SLIT_LOCATION_MXU Calib Slits positions on CCD Y
CURV_COEFF_MXU Calib Slits tracing fits Y
DISP_COEFF_MXU Calib Wavelength calibration Y
MASTER_BIAS Calib Master bias frame Y
Output files
^^^^^^^^^^^^
::
DO category: Data type: Explanation:
MASTER_SCREEN_FLAT_MXU FITS image Bias subtracted sum frame
Constructor
-----------
.. method:: cpl.Recipe("fors_spec_mflat")
:noindex:
Create an object for the recipe fors_spec_mflat.
::
import cpl
fors_spec_mflat = cpl.Recipe("fors_spec_mflat")
Parameters
----------
.. py:attribute:: fors_spec_mflat.param.smooth_sed
Smoothing size for each flat sed (float; default: 0.0) [default=0.0].
.. py:attribute:: fors_spec_mflat.param.stack_method
Frames combination method (str; default: 'sum') [default="sum"].
.. py:attribute:: fors_spec_mflat.param.klow
Low threshold in ksigma method (float; default: 3.0) [default=3.0].
.. py:attribute:: fors_spec_mflat.param.khigh
High threshold in ksigma method (float; default: 3.0) [default=3.0].
.. py:attribute:: fors_spec_mflat.param.kiter
Max number of iterations in ksigma method (long; default: 999) [default=999].
The following code snippet shows the default settings for the available
parameters.
::
import cpl
fors_spec_mflat = cpl.Recipe("fors_spec_mflat")
fors_spec_mflat.param.smooth_sed = 0.0
fors_spec_mflat.param.stack_method = "sum"
fors_spec_mflat.param.klow = 3.0
fors_spec_mflat.param.khigh = 3.0
fors_spec_mflat.param.kiter = 999
You may also set or overwrite some or all parameters by the recipe
parameter `param`, as shown in the following example:
::
import cpl
fors_spec_mflat = cpl.Recipe("fors_spec_mflat")
[...]
res = fors_spec_mflat( ..., param = {"smooth_sed":0.0, "stack_method":"sum"})
.. seealso:: `cpl.Recipe <http://packages.python.org/python-cpl/recipe.html>`_
for more information about the recipe object.
Bug reports
-----------
Please report any problems to `Carlo Izzo <usd-help@eso.org>`_. Alternatively, you may
send a report to the `ESO User Support Department <usd-help@eso.org>`_.
Copyright
---------
This file is currently part of the FORS Instrument Pipeline
Copyright (C) 2002-2011 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
.. codeauthor:: Carlo Izzo <usd-help@eso.org>
|