/usr/share/doc/cpl-plugin-fors-doc/html/_sources/fors_img_science.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 | The fors_img_science recipe
===============================================================
.. data:: fors_img_science
Synopsis
--------
Reduce scientific exposure
Description
-----------
Input files
^^^^^^^^^^^^
::
DO category: Type: Explanation: Number:
SCIENCE_IMG Raw Science image 1
MASTER_BIAS FITS image Master bias 1
MASTER_SKY_FLAT_IMG FITS image Master sky flat field 1
Output files
^^^^^^^^^^^^
::
DO category: Data type: Explanation:
SCIENCE_REDUCED_IMG FITS image Reduced science image
PHOT_BACKGROUND_SCI_IMG FITS image Reduced science image background
SOURCES_SCI_IMG FITS image Unfiltered SExtractor output
OBJECT_TABLE_SCI_IMG FITS table Extracted sources properties
Constructor
-----------
.. method:: cpl.Recipe("fors_img_science")
:noindex:
Create an object for the recipe fors_img_science.
::
import cpl
fors_img_science = cpl.Recipe("fors_img_science")
Parameters
----------
.. py:attribute:: fors_img_science.param.magsyserr
Systematic error in magnitude (float; default: 0.01) [default=0.01].
.. py:attribute:: fors_img_science.param.sex_exe
SExtractor executable (str; default: '/usr/bin/sex') [default="/usr/bin/sex"].
.. py:attribute:: fors_img_science.param.sex_config
SExtractor configuration file (str; default: '/usr/share/cpl- plugins/fors-4.11.12/config/fors.sex') [default="/usr/share/cpl-plugins/fors-4.11.12/config/fors.sex"].
.. py:attribute:: fors_img_science.param.sex_mag
SExtractor magnitude (str; default: 'MAG_APER') [default="MAG_APER"].
.. py:attribute:: fors_img_science.param.sex_magerr
SExtractor magnitude error (str; default: 'MAGERR_APER') [default="MAGERR_APER"].
.. py:attribute:: fors_img_science.param.sex_radius
Background error map median filter radius (unbinned pixels) (long; default: 64) [default=64].
The following code snippet shows the default settings for the available
parameters.
::
import cpl
fors_img_science = cpl.Recipe("fors_img_science")
fors_img_science.param.magsyserr = 0.01
fors_img_science.param.sex_exe = "/usr/bin/sex"
fors_img_science.param.sex_config = "/usr/share/cpl-plugins/fors-4.11.12/config/fors.sex"
fors_img_science.param.sex_mag = "MAG_APER"
fors_img_science.param.sex_magerr = "MAGERR_APER"
fors_img_science.param.sex_radius = 64
You may also set or overwrite some or all parameters by the recipe
parameter `param`, as shown in the following example:
::
import cpl
fors_img_science = cpl.Recipe("fors_img_science")
[...]
res = fors_img_science( ..., param = {"magsyserr":0.01, "sex_exe":"/usr/bin/sex"})
.. 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 `Jonas M. Larsen <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:: Jonas M. Larsen <usd-help@eso.org>
|