/usr/share/doc/cpl-plugin-visir-doc/html/visir_util_undistort.html is in cpl-plugin-visir-doc 4.3.0+dfsg1-1.
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 | <!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 visir_util_undistort recipe — VISIR pipeline 4.3.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: '4.3.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="VISIR pipeline 4.3.0 documentation" href="index.html" />
<link rel="prev" title="The visir_util_spc_txt2fits recipe" href="visir_util_spc_txt2fits.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<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="visir_util_spc_txt2fits.html" title="The visir_util_spc_txt2fits recipe"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">VISIR pipeline 4.3.0 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The visir_util_undistort 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="visir_util_spc_txt2fits.html"
title="previous chapter">The visir_util_spc_txt2fits recipe</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/visir_util_undistort.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="the-visir-util-undistort-recipe">
<h1>The visir_util_undistort recipe<a class="headerlink" href="#the-visir-util-undistort-recipe" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="visir_util_undistort">
<code class="descname">visir_util_undistort</code><a class="headerlink" href="#visir_util_undistort" 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>Correct the distortion in spectral data</p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The files listed in the Set Of Frames (sof-file) must be tagged:
VISIR-chopnod-corrected-file.fits CHOPNOD_CORRECTED
Optionally, a bad pixel map may be provided:
VISIR-bpm-file.fits STATIC_MASK</p>
<p>The product(s) will have a FITS card
‘HIERARCH ESO PRO CATG’ with a value of:
UNDISTORTED
The recipe default values for the transformation are only valid for spectral data taken in Low resolution mode</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>
<code class="descclassname">cpl.</code><code class="descname">Recipe</code><span class="sig-paren">(</span><em>"visir_util_undistort"</em><span class="sig-paren">)</span></dt>
<dd><p>Create an object for the recipe visir_util_undistort.</p>
</dd></dl>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">visir_util_undistort</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="s2">"visir_util_undistort"</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="visir_util_undistort.param.bkgcorrect">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">bkgcorrect</code><a class="headerlink" href="#visir_util_undistort.param.bkgcorrect" title="Permalink to this definition">¶</a></dt>
<dd><p>Cho-nod correct the data (bool; default: True) [default=True].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.xl">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">xl</code><a class="headerlink" href="#visir_util_undistort.param.xl" title="Permalink to this definition">¶</a></dt>
<dd><p>Coordinate in spatial direction. Together with yl it defines the lower point of a rectangle containing only skylines for the wavelength shift detection (long; default: 117) [default=117].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.yl">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">yl</code><a class="headerlink" href="#visir_util_undistort.param.yl" title="Permalink to this definition">¶</a></dt>
<dd><p>Coordinate in wavelength direction. See xl (long; default: 110) [default=110].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.xh">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">xh</code><a class="headerlink" href="#visir_util_undistort.param.xh" title="Permalink to this definition">¶</a></dt>
<dd><p>Coordinate in spatial direction. Together with yl it defines the higher point of a rectangle containing only skylines for the wavelength shift detection (long; default: 125) [default=125].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.yh">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">yh</code><a class="headerlink" href="#visir_util_undistort.param.yh" title="Permalink to this definition">¶</a></dt>
<dd><p>Coordinate in wavelength direction. See xh (long; default: 150) [default=150].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.slit_skew">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">slit_skew</code><a class="headerlink" href="#visir_util_undistort.param.slit_skew" title="Permalink to this definition">¶</a></dt>
<dd><p>Distortion correction: Skew of slit (degrees) (clockwise) (float; default: 0.52) [default=0.52].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.spectrum_skew">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">spectrum_skew</code><a class="headerlink" href="#visir_util_undistort.param.spectrum_skew" title="Permalink to this definition">¶</a></dt>
<dd><p>Distortion correction: LMR Skew of spectrum (degrees) (counter- clockwise). Not used in High Resolution (float; default: 1.73) [default=1.73].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.vert_arc">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">vert_arc</code><a class="headerlink" href="#visir_util_undistort.param.vert_arc" title="Permalink to this definition">¶</a></dt>
<dd><p>Distortion correction: LR Detector vertical curvature (pixel). Reduced by a factor 4 in MR. Not used in HR A-side. Increased by a factor 115/52 in HR B-side (float; default: -0.8) [default=-0.8].</p>
</dd></dl>
<dl class="attribute">
<dt id="visir_util_undistort.param.hori_arc">
<code class="descclassname">visir_util_undistort.param.</code><code class="descname">hori_arc</code><a class="headerlink" href="#visir_util_undistort.param.hori_arc" title="Permalink to this definition">¶</a></dt>
<dd><p>Distortion correction: LMR Detector horizontal curvature (pixel). Increased by a factor 1.5 in HR A-side. Reduced by a factor 2 in HR B-side (float; default: 0.0) [default=0.0].</p>
</dd></dl>
<p>The following code snippet shows the default settings for the available
parameters.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">visir_util_undistort</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="s2">"visir_util_undistort"</span><span class="p">)</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">bkgcorrect</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">xl</span> <span class="o">=</span> <span class="mi">117</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">yl</span> <span class="o">=</span> <span class="mi">110</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">xh</span> <span class="o">=</span> <span class="mi">125</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">yh</span> <span class="o">=</span> <span class="mi">150</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">slit_skew</span> <span class="o">=</span> <span class="mf">0.52</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">spectrum_skew</span> <span class="o">=</span> <span class="mf">1.73</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">vert_arc</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.8</span>
<span class="n">visir_util_undistort</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">hori_arc</span> <span class="o">=</span> <span class="mf">0.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-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">visir_util_undistort</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="s2">"visir_util_undistort"</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">visir_util_undistort</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="s2">"bkgcorrect"</span><span class="p">:</span><span class="kc">True</span><span class="p">,</span> <span class="s2">"xl"</span><span class="p">:</span><span class="mi">117</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:llundin%40eso.org">Lars Lundin</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 VISIR Instrument Pipeline
Copyright (C) 2011 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 02111-1307 USA</p>
<p><em>Code author: Lars Lundin <<a class="reference external" href="mailto:llundin%40eso.org">llundin<span>@</span>eso<span>.</span>org</a>></em></p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="visir_util_spc_txt2fits.html" title="The visir_util_spc_txt2fits recipe"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">VISIR pipeline 4.3.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.5.
</div>
</body>
</html>
|