/usr/share/doc/cpl-plugin-fors-doc/html/_sources/fors_photometry.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_photometry recipe
===============================================================
.. data:: fors_photometry
Synopsis
--------
Compute corrected flatfield
Description
-----------
Input files
^^^^^^^^^^^^
::
DO category: Type: Explanation: Number:
PHOT_TABLE FITS table Expected extinction params 1
ALIGNED_PHOT FITS table Photometry 1+
MASTER_SKY_FLAT_IMG FITS image Master flat field 1
Output files
^^^^^^^^^^^^
::
DO category: Data type: Explanation:
PHOT_COEFF_TABLE FITS image Observed extinction coefficients
CORRECTION_MAP FITS image Correction map (magnitude)
CORRECTION_FACTOR FITS image Correction map (flux)
MASTER_FLAT_IMG FITS image Corrected master flat field
Constructor
-----------
.. method:: cpl.Recipe("fors_photometry")
:noindex:
Create an object for the recipe fors_photometry.
::
import cpl
fors_photometry = cpl.Recipe("fors_photometry")
Parameters
----------
.. py:attribute:: fors_photometry.param.fitz
Fit zeropoint (bool; default: True) [default=True].
.. py:attribute:: fors_photometry.param.fit_all_mag
Always fit star magnitudes (bool; default: False) [default=False].
.. py:attribute:: fors_photometry.param.fite
Fit atmospheric extinctions (str; default: 'pernight') [default="pernight"].
.. py:attribute:: fors_photometry.param.fitc
Fit color correction term (bool; default: False) [default=False].
.. py:attribute:: fors_photometry.param.use_all_stars
Use also non-standard stars to fit polynomial f (bool; default: False) [default=False].
.. py:attribute:: fors_photometry.param.degreef1
FLatfield correction map polynomial degree (x) (long; default: 0) [default=0].
.. py:attribute:: fors_photometry.param.degreef2
Flatfield correction map polynomial degree (y), or negative for triangular coefficient matrix (long; default: -1) [default=-1].
.. py:attribute:: fors_photometry.param.degreep
Extinction/color coupling degree (long; default: 0) [default=0].
The following code snippet shows the default settings for the available
parameters.
::
import cpl
fors_photometry = cpl.Recipe("fors_photometry")
fors_photometry.param.fitz = True
fors_photometry.param.fit_all_mag = False
fors_photometry.param.fite = "pernight"
fors_photometry.param.fitc = False
fors_photometry.param.use_all_stars = False
fors_photometry.param.degreef1 = 0
fors_photometry.param.degreef2 = -1
fors_photometry.param.degreep = 0
You may also set or overwrite some or all parameters by the recipe
parameter `param`, as shown in the following example:
::
import cpl
fors_photometry = cpl.Recipe("fors_photometry")
[...]
res = fors_photometry( ..., param = {"fitz":True, "fit_all_mag":False})
.. 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>
|