/usr/share/doc/cpl-plugin-fors-doc/html/fors_sumflux.html 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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The fors_sumflux recipe — FORS pipeline 4.11.12 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.11.12',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="FORS pipeline 4.11.12 documentation" href="index.html" />
<link rel="next" title="The fors_calib recipe" href="fors_calib.html" />
<link rel="prev" title="The fors_zeropoint recipe" href="fors_zeropoint.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="fors_calib.html" title="The fors_calib recipe"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="fors_zeropoint.html" title="The fors_zeropoint recipe"
accesskey="P">previous</a> |</li>
<li><a href="index.html">FORS pipeline 4.11.12 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The fors_sumflux recipe</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#input-files">Input files</a></li>
<li><a class="reference internal" href="#output-files">Output files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#constructor">Constructor</a></li>
<li><a class="reference internal" href="#parameters">Parameters</a></li>
<li><a class="reference internal" href="#bug-reports">Bug reports</a></li>
<li><a class="reference internal" href="#copyright">Copyright</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="fors_zeropoint.html"
title="previous chapter">The fors_zeropoint recipe</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="fors_calib.html"
title="next chapter">The fors_calib recipe</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/fors_sumflux.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-fors-sumflux-recipe">
<h1>The fors_sumflux recipe<a class="headerlink" href="#the-fors-sumflux-recipe" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="fors_sumflux">
<tt class="descname">fors_sumflux</tt><a class="headerlink" href="#fors_sumflux" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>Integrate flux from all or part of the input frame</p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>This recipe is used to monitor any lamp flux on the CCD. The input raw
image should be either a FLUX_ARC_LSS or a FLUX_FLAT_LSS frame. After the
background subtraction the total signal is integrated and divided by the
exposure time and by the total number of CCD original pixels (keeping
into account a possible rebinned readout). In the case of FORS2 frames
the background is the median level evaluated from the available overscan
regions. In the case of FORS1 data, where overscan regions are missing,
the background is evaluated as the median level of the first 200 CCD columns
for flat field data, while for arc lamp data a background map evaluated
from the regions without spectral lines is computed and subtracted. The
background subtracted frame is written to output in all cases, and the QC
parameters QC LAMP FLUX and QC LAMP FLUXERR are computed.</p>
<div class="section" id="input-files">
<h3>Input files<a class="headerlink" href="#input-files" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>DO category: Type: Explanation: Required:
FLUX_FLAT_LSS Raw Flat field exposure Y
or FLUX_ARC_LSS Raw Arc lamp exposure Y</pre>
</div>
</div>
<div class="section" id="output-files">
<h3>Output files<a class="headerlink" href="#output-files" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>DO category: Data type: Explanation:
FLUX_LAMP_LSS FITS image Background subtracted integration region</pre>
</div>
</div>
</div>
<div class="section" id="constructor">
<h2>Constructor<a class="headerlink" href="#constructor" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt>
<tt class="descclassname">cpl.</tt><tt class="descname">Recipe</tt><big>(</big><em>"fors_sumflux"</em><big>)</big></dt>
<dd><p>Create an object for the recipe fors_sumflux.</p>
</dd></dl>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">fors_sumflux</span> <span class="o">=</span> <span class="n">cpl</span><span class="o">.</span><span class="n">Recipe</span><span class="p">(</span><span class="s">"fors_sumflux"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<dl class="attribute">
<dt id="fors_sumflux.param.xlow">
<tt class="descclassname">fors_sumflux.param.</tt><tt class="descname">xlow</tt><a class="headerlink" href="#fors_sumflux.param.xlow" title="Permalink to this definition">¶</a></dt>
<dd><p>X coordinate of lower left corner of integration region (pixel) (long; default: 0) [default=0].</p>
</dd></dl>
<dl class="attribute">
<dt id="fors_sumflux.param.ylow">
<tt class="descclassname">fors_sumflux.param.</tt><tt class="descname">ylow</tt><a class="headerlink" href="#fors_sumflux.param.ylow" title="Permalink to this definition">¶</a></dt>
<dd><p>Y coordinate of lower left corner of integration region (pixel) (long; default: 0) [default=0].</p>
</dd></dl>
<dl class="attribute">
<dt id="fors_sumflux.param.xhigh">
<tt class="descclassname">fors_sumflux.param.</tt><tt class="descname">xhigh</tt><a class="headerlink" href="#fors_sumflux.param.xhigh" title="Permalink to this definition">¶</a></dt>
<dd><p>X coordinate of upper right corner of integration region (pixel) (0 = CCD size) (long; default: 0) [default=0].</p>
</dd></dl>
<dl class="attribute">
<dt id="fors_sumflux.param.yhigh">
<tt class="descclassname">fors_sumflux.param.</tt><tt class="descname">yhigh</tt><a class="headerlink" href="#fors_sumflux.param.yhigh" title="Permalink to this definition">¶</a></dt>
<dd><p>Y coordinate of upper right corner of integration region (pixel) (0 = CCD size) (long; default: 0) [default=0].</p>
</dd></dl>
<p>The following code snippet shows the default settings for the available
parameters.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">fors_sumflux</span> <span class="o">=</span> <span class="n">cpl</span><span class="o">.</span><span class="n">Recipe</span><span class="p">(</span><span class="s">"fors_sumflux"</span><span class="p">)</span>
<span class="n">fors_sumflux</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">xlow</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">fors_sumflux</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">ylow</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">fors_sumflux</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">xhigh</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">fors_sumflux</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">yhigh</span> <span class="o">=</span> <span class="mi">0</span>
</pre></div>
</div>
<p>You may also set or overwrite some or all parameters by the recipe
parameter <cite>param</cite>, as shown in the following example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">fors_sumflux</span> <span class="o">=</span> <span class="n">cpl</span><span class="o">.</span><span class="n">Recipe</span><span class="p">(</span><span class="s">"fors_sumflux"</span><span class="p">)</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">fors_sumflux</span><span class="p">(</span> <span class="o">...</span><span class="p">,</span> <span class="n">param</span> <span class="o">=</span> <span class="p">{</span><span class="s">"xlow"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s">"ylow"</span><span class="p">:</span><span class="mi">0</span><span class="p">})</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference external" href="http://packages.python.org/python-cpl/recipe.html">cpl.Recipe</a>
for more information about the recipe object.</p>
</div>
</div>
<div class="section" id="bug-reports">
<h2>Bug reports<a class="headerlink" href="#bug-reports" title="Permalink to this headline">¶</a></h2>
<p>Please report any problems to <a class="reference external" href="mailto:usd-help%40eso.org">Carlo Izzo</a>. Alternatively, you may
send a report to the <a class="reference external" href="mailto:usd-help%40eso.org">ESO User Support Department</a>.</p>
</div>
<div class="section" id="copyright">
<h2>Copyright<a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h2>
<p>This file is currently part of the FORS Instrument Pipeline
Copyright (C) 2002-2010 European Southern Observatory</p>
<p>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.</p>
<p>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.</p>
<p>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</p>
<p><em>Code author: Carlo Izzo <<a class="reference external" href="mailto:usd-help%40eso.org">usd-help<span>@</span>eso<span>.</span>org</a>></em></p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="fors_calib.html" title="The fors_calib recipe"
>next</a> |</li>
<li class="right" >
<a href="fors_zeropoint.html" title="The fors_zeropoint recipe"
>previous</a> |</li>
<li><a href="index.html">FORS pipeline 4.11.12 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
</div>
</body>
</html>
|