/usr/share/doc/cpl-plugin-sinfo-doc/html/sinfo_utl_skycor.html is in cpl-plugin-sinfo-doc 2.4.0+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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | <!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 sinfo_utl_skycor recipe — SINFO pipeline 2.4.0 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: '2.4.0',
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="SINFO pipeline 2.4.0 documentation" href="index.html" />
<link rel="next" title="The sinfo_utl_spectrum_wavelength_shift recipe" href="sinfo_utl_spectrum_wavelength_shift.html" />
<link rel="prev" title="The sinfo_utl_ima_arith recipe" href="sinfo_utl_ima_arith.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="sinfo_utl_spectrum_wavelength_shift.html" title="The sinfo_utl_spectrum_wavelength_shift recipe"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="sinfo_utl_ima_arith.html" title="The sinfo_utl_ima_arith recipe"
accesskey="P">previous</a> |</li>
<li><a href="index.html">SINFO pipeline 2.4.0 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 sinfo_utl_skycor recipe</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></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="sinfo_utl_ima_arith.html"
title="previous chapter">The sinfo_utl_ima_arith recipe</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="sinfo_utl_spectrum_wavelength_shift.html"
title="next chapter">The sinfo_utl_spectrum_wavelength_shift recipe</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/sinfo_utl_skycor.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-sinfo-utl-skycor-recipe">
<h1>The sinfo_utl_skycor recipe<a class="headerlink" href="#the-sinfo-utl-skycor-recipe" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="sinfo_utl_skycor">
<tt class="descname">sinfo_utl_skycor</tt><a class="headerlink" href="#sinfo_utl_skycor" 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>Sky lines residuals correction</p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>This recipe perform a correction of possible sky line residuals in the
object cube after standard data reduction.</p>
<p>Input frames are cubes with target and sky observations.</p>
<p>Their tags can be respectively OBS_OBJ (or OBS_PSF or OBS_STD) and OBS_SKY.</p>
<p>The output is a cube with same tag as the corresponding input target frame.</p>
</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>"sinfo_utl_skycor"</em><big>)</big></dt>
<dd><p>Create an object for the recipe sinfo_utl_skycor.</p>
</dd></dl>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">sinfo_utl_skycor</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">"sinfo_utl_skycor"</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="sinfo_utl_skycor.param.skycor_mask_ws">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_mask_ws</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_mask_ws" title="Permalink to this definition">¶</a></dt>
<dd><p>Starting wavelength for object-sky cross correlation (float; default: 1.4) [default=1.4].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_mask_we">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_mask_we</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_mask_we" title="Permalink to this definition">¶</a></dt>
<dd><p>End wavelength for object-sky cross correlation (float; default: 2.5) [default=2.5].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_min_frac">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_min_frac</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_min_frac" title="Permalink to this definition">¶</a></dt>
<dd><p>Threshold value for fraction of spatial pixels to be sky (float; default: 0.8) [default=0.8].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_sky_bkg_filter_width">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_sky_bkg_filter_width</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_sky_bkg_filter_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Width of sky-thermal background pre filter (to remove emission lines before fitting a Black Body). (long; default: 12) [default=12].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_line_hw">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_line_hw</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_line_hw" title="Permalink to this definition">¶</a></dt>
<dd><p>Threshold value for full width in pixels of unresolved emission line. Lines with FWHM smaller than this value are not considered in the object-sky cross correlation and in computation of the optimal sky lines scaling factor (float; default: 4.0) [default=4.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_scale_method">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_scale_method</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_scale_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Optimal sky lines scaling factor computation method: amoeba fit (0), maximum likelihood (1) (long; default: 1) [default=1].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_rot_cor">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_rot_cor</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_rot_cor" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes scaling factor correction due to rotational levels transitions (bool; default: False) [default=False].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_fit_obj_noise">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_fit_obj_noise</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_fit_obj_noise" title="Permalink to this definition">¶</a></dt>
<dd><p>Do Gaussian fit of object noise (bool; default: False) [default=False].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_niter">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_niter</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_niter" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of iterations of background fit (long; default: 10) [default=10].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_pshift">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_pshift</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_pshift" title="Permalink to this definition">¶</a></dt>
<dd><p>Sky spectrum shift towar object (float; default: 0.0) [default=0.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_llx">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_llx</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_llx" title="Permalink to this definition">¶</a></dt>
<dd><p>Lower left X defining object spectrum location (long; default: 1) [default=1].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_lly">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_lly</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_lly" title="Permalink to this definition">¶</a></dt>
<dd><p>Lower left Y defining object spectrum location (long; default: 1) [default=1].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_urx">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_urx</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_urx" title="Permalink to this definition">¶</a></dt>
<dd><p>Upper right X defining object spectrum location (long; default: 64) [default=64].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_ury">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_ury</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_ury" title="Permalink to this definition">¶</a></dt>
<dd><p>Upper right Y defining object spectrum location (long; default: 64) [default=64].</p>
</dd></dl>
<dl class="attribute">
<dt id="sinfo_utl_skycor.param.skycor_sub_thr_bkg_from_obj">
<tt class="descclassname">sinfo_utl_skycor.param.</tt><tt class="descname">skycor_sub_thr_bkg_from_obj</tt><a class="headerlink" href="#sinfo_utl_skycor.param.skycor_sub_thr_bkg_from_obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Subtract thermal background contribute from object spectra. Set it to TRUE if stack-sub_raw_sky is set to FALSE (bool; default: False) [default=False].</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">sinfo_utl_skycor</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">"sinfo_utl_skycor"</span><span class="p">)</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_mask_ws</span> <span class="o">=</span> <span class="mf">1.4</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_mask_we</span> <span class="o">=</span> <span class="mf">2.5</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_min_frac</span> <span class="o">=</span> <span class="mf">0.8</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_sky_bkg_filter_width</span> <span class="o">=</span> <span class="mi">12</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_line_hw</span> <span class="o">=</span> <span class="mf">4.0</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_scale_method</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_rot_cor</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_fit_obj_noise</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_niter</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_pshift</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_llx</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_lly</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_urx</span> <span class="o">=</span> <span class="mi">64</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_ury</span> <span class="o">=</span> <span class="mi">64</span>
<span class="n">sinfo_utl_skycor</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">skycor_sub_thr_bkg_from_obj</span> <span class="o">=</span> <span class="bp">False</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">sinfo_utl_skycor</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">"sinfo_utl_skycor"</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">sinfo_utl_skycor</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">"skycor_mask_ws"</span><span class="p">:</span><span class="mf">1.4</span><span class="p">,</span> <span class="s">"skycor_mask_we"</span><span class="p">:</span><span class="mf">2.5</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:Andrea.Modigliani%40eso.org">Andrea Modigliani</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 part of the SINFONI Instrument Pipeline
Copyright (C) 2002,2003 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., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA</p>
<p><em>Code author: Andrea Modigliani <<a class="reference external" href="mailto:Andrea.Modigliani%40eso.org">Andrea<span>.</span>Modigliani<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="sinfo_utl_spectrum_wavelength_shift.html" title="The sinfo_utl_spectrum_wavelength_shift recipe"
>next</a> |</li>
<li class="right" >
<a href="sinfo_utl_ima_arith.html" title="The sinfo_utl_ima_arith recipe"
>previous</a> |</li>
<li><a href="index.html">SINFO pipeline 2.4.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
</div>
</body>
</html>
|