/usr/share/doc/cpl-plugin-xshoo-doc/html/xsh_respon_slit_nod.html is in cpl-plugin-xshoo-doc 2.6.8+dfsg-4.
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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | <!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 xsh_respon_slit_nod recipe — XSHOO pipeline 2.6.8 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.6.8',
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="XSHOO pipeline 2.6.8 documentation" href="index.html" />
<link rel="next" title="The xsh_respon_slit_offset recipe" href="xsh_respon_slit_offset.html" />
<link rel="prev" title="The xsh_flexcomp recipe" href="xsh_flexcomp.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="xsh_respon_slit_offset.html" title="The xsh_respon_slit_offset recipe"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="xsh_flexcomp.html" title="The xsh_flexcomp recipe"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XSHOO pipeline 2.6.8 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 xsh_respon_slit_nod 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="xsh_flexcomp.html"
title="previous chapter">The xsh_flexcomp recipe</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="xsh_respon_slit_offset.html"
title="next chapter">The xsh_respon_slit_offset recipe</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/xsh_respon_slit_nod.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">
<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" role="main">
<div class="section" id="the-xsh-respon-slit-nod-recipe">
<h1>The xsh_respon_slit_nod recipe<a class="headerlink" href="#the-xsh-respon-slit-nod-recipe" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="xsh_respon_slit_nod">
<code class="descname">xsh_respon_slit_nod</code><a class="headerlink" href="#xsh_respon_slit_nod" 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>Reduce STD star frames in SLIT configuration and nod mode</p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>This recipe reduces science exposure in SLIT configuration and NOD mode
Input Frames :</p>
<blockquote>
<div><ul class="simple">
<li>A set of n Science frames ( n even ), Tag = OBJECT_SLIT_NOD_arm</li>
<li>Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)</li>
<li>[UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)</li>
<li>A master flat frame (Tag = MASTER_FLAT_SLIT_arm)</li>
<li>An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm)</li>
<li>[poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm)</li>
<li>[poly mode] A wave map frame(Tag = WAVE_MAP_arm)</li>
<li>[poly mode] A disp table frame(Tag = DISP_TAB_arm)</li>
<li>[physical model mode]A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)</li>
<li>[OPTIONAL] A telluric model catalog (Tag = TELL_MOD_CAT_arm arm=VIS,NIR)</li>
<li>A standard star fluxes catalog (Tag = FLUX_STD_CATALOG_arm Type = FLX)</li>
<li>A table to set response sampling points (Tag = RESP_FIT_POINTS_CAT_arm)</li>
<li>[OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm)</li>
<li>[OPTIONAL] An master response curve table (Tag = MRESPONSE_MERGE1D_SLIT_arm)
if provided this is the one used to flux calibrate the spectra</li>
</ul>
</div></blockquote>
<dl class="docutils">
<dt>Products :</dt>
<dd><ul class="first last simple">
<li>[If STD is in catal] The response function (Tag = PREFIX_RESPONSE_ORDER1D_SLIT_arm)</li>
<li>[If STD is in catal] The response function (Tag = PREFIX_RESPONSE_MERGE1D_SLIT_arm)</li>
<li>PREFIX_ORDER2D_arm (2 dimension)</li>
<li>PREFIX_ORDER1D_arm (1 dimension)</li>
<li>PREFIX_MERGE2D_arm (2 dimension)</li>
<li>PREFIX_MERGE1D_arm (1 dimension)</li>
<li>PREFIX_WAVE_MAP_arm, wave map image</li>
<li>PREFIX_SLIT_MAP_arm, slit map image</li>
<li>[If STD is in catal] Flux calibrated order-by-order 2D spectrum (Tag = PREFIX_FLUX_ORDER2D_arm)</li>
<li>[If STD is in catal] Flux calibrated order-by-order 1D spectrum (Tag = PREFIX_FLUX_ORDER1D_arm)</li>
<li>[If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUX_MERGE2D_arm)</li>
<li>[If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUX_MERGE1D_arm)</li>
<li>[If STD is in catal] The efficiency (Tag = EFFICIENCY_SLIT_arm)</li>
<li>where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC</li>
</ul>
</dd>
</dl>
</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>"xsh_respon_slit_nod"</em><span class="sig-paren">)</span></dt>
<dd><p>Create an object for the recipe xsh_respon_slit_nod.</p>
</dd></dl>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">cpl</span>
<span class="n">xsh_respon_slit_nod</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">"xsh_respon_slit_nod"</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="xsh_respon_slit_nod.param.keep_temp">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">keep_temp</code><a class="headerlink" href="#xsh_respon_slit_nod.param.keep_temp" title="Permalink to this definition">¶</a></dt>
<dd><p>If ‘no’, temporary files are deleted. (str; default: ‘no’) [default=”no”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.debug_level">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">debug_level</code><a class="headerlink" href="#xsh_respon_slit_nod.param.debug_level" title="Permalink to this definition">¶</a></dt>
<dd><p>Additional xshooter debug level. One of ‘none’, ‘low’, ‘medium’, ‘high’ (str; default: ‘none’) [default=”none”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.time_stamp">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">time_stamp</code><a class="headerlink" href="#xsh_respon_slit_nod.param.time_stamp" title="Permalink to this definition">¶</a></dt>
<dd><p>Add timestamp to product file name. (bool; default: False) [default=False].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.decode_bp">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">decode_bp</code><a class="headerlink" href="#xsh_respon_slit_nod.param.decode_bp" title="Permalink to this definition">¶</a></dt>
<dd><p>Integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. Most frequent codes relevant for the user: 0: good pixel, 8: pick-up noise, 16: cosmic-ray removed, 32: cosmic-ray unremoved, 128: calibration file defect, 256: hot pixel, 512: dark pixel, 4096: A/D converted saturation, 32768: non linear pixel, 1048576: extrapolated flux in NIR, 4194304: Interpolated flux during extraction. (long; default: 2144337919) [default=2144337919].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.pre_overscan_corr">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">pre_overscan_corr</code><a class="headerlink" href="#xsh_respon_slit_nod.param.pre_overscan_corr" title="Permalink to this definition">¶</a></dt>
<dd><p>pre-overscan correction.0: no correction1: mean overscan correction2: mean prescan correction3: (mean pre+mean overscan)/2 correction (long; default: 1) [default=1].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.stack_method">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">stack_method</code><a class="headerlink" href="#xsh_respon_slit_nod.param.stack_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Method used to build master frame. (str; default: ‘median’) [default=”median”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.klow">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">klow</code><a class="headerlink" href="#xsh_respon_slit_nod.param.klow" title="Permalink to this definition">¶</a></dt>
<dd><p>Kappa used to clip low level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.khigh">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">khigh</code><a class="headerlink" href="#xsh_respon_slit_nod.param.khigh" title="Permalink to this definition">¶</a></dt>
<dd><p>Kappa used to clip high level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.removecrhsingle_sigmalim">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">removecrhsingle_sigmalim</code><a class="headerlink" href="#xsh_respon_slit_nod.param.removecrhsingle_sigmalim" title="Permalink to this definition">¶</a></dt>
<dd><p>Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 20.0) [default=20.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.removecrhsingle_flim">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">removecrhsingle_flim</code><a class="headerlink" href="#xsh_respon_slit_nod.param.removecrhsingle_flim" title="Permalink to this definition">¶</a></dt>
<dd><p>Minimum contrast between the Laplacian image and the fine structure image that a point must have to be flagged as CRH. (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 2.0) [default=2.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.removecrhsingle_niter">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">removecrhsingle_niter</code><a class="headerlink" href="#xsh_respon_slit_nod.param.removecrhsingle_niter" title="Permalink to this definition">¶</a></dt>
<dd><p>Max number of iterations (long; default: 4) [default=4].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.rectify_kernel">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">rectify_kernel</code><a class="headerlink" href="#xsh_respon_slit_nod.param.rectify_kernel" title="Permalink to this definition">¶</a></dt>
<dd><p>Name of the Interpolation Kernel Used. Possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: ‘tanh’) [default=”tanh”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.rectify_radius">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">rectify_radius</code><a class="headerlink" href="#xsh_respon_slit_nod.param.rectify_radius" title="Permalink to this definition">¶</a></dt>
<dd><p>Rectify Interpolation radius [bin units]. (float; default: 2.0) [default=2.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.rectify_bin_lambda">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">rectify_bin_lambda</code><a class="headerlink" href="#xsh_respon_slit_nod.param.rectify_bin_lambda" title="Permalink to this definition">¶</a></dt>
<dd><p>Wavelength step in the output spectrum [nm] (float; default: -1.0) [default=-1.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.rectify_bin_slit">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">rectify_bin_slit</code><a class="headerlink" href="#xsh_respon_slit_nod.param.rectify_bin_slit" title="Permalink to this definition">¶</a></dt>
<dd><p>Spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0) [default=-1.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.rectify_fast">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">rectify_fast</code><a class="headerlink" href="#xsh_respon_slit_nod.param.rectify_fast" title="Permalink to this definition">¶</a></dt>
<dd><p>Fast if TRUE (Rect[B-A] = -Rect[A-B]), in that case only entire pixel shifts are applied. (bool; default: True) [default=True].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_method">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_method</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: ‘MANUAL’) [default=”MANUAL”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_chunk_nb">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_chunk_nb</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_chunk_nb" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of chunks in the full spectrum to localize the object (long; default: 10) [default=10].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_thresh">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_thresh</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_thresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Threshold relative to the peak intensity below which the edges of the object are detected for MAXIMUM localization (float; default: 0.1) [default=0.1].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_deg_lambda">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_deg_lambda</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_deg_lambda" title="Permalink to this definition">¶</a></dt>
<dd><p>Degree in lambda in the localization polynomial expression slit=f(lambda), used only for MAXIMUM and GAUSSIAN (long; default: 0) [default=0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_slit_position">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_slit_position</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_slit_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0) [default=0.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_slit_hheight">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_slit_hheight</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_slit_hheight" title="Permalink to this definition">¶</a></dt>
<dd><p>Object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0) [default=2.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_kappa">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_kappa</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_kappa" title="Permalink to this definition">¶</a></dt>
<dd><p>Kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0) [default=3.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_niter">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_niter</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_niter" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of iterations for sigma clipping in the localization polynomial fit (long; default: 3) [default=3].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_use_skymask">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_use_skymask</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_use_skymask" title="Permalink to this definition">¶</a></dt>
<dd><p>TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False) [default=False].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.localize_nod_throw">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">localize_nod_throw</code><a class="headerlink" href="#xsh_respon_slit_nod.param.localize_nod_throw" title="Permalink to this definition">¶</a></dt>
<dd><p>Step (arcsec) between A and B images in nodding mode. (float; default: 0.0) [default=0.0].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.extract_method">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">extract_method</code><a class="headerlink" href="#xsh_respon_slit_nod.param.extract_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Method used for extraction (LOCALIZATION, NOD) (str; default: ‘NOD’) [default=”NOD”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.stdextract_interp_hsize">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">stdextract_interp_hsize</code><a class="headerlink" href="#xsh_respon_slit_nod.param.stdextract_interp_hsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Half size of mask used to define object cross order profile (long; default: 30) [default=30].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.combinenod_throwlist">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">combinenod_throwlist</code><a class="headerlink" href="#xsh_respon_slit_nod.param.combinenod_throwlist" title="Permalink to this definition">¶</a></dt>
<dd><p>Name of ascii file containing the list of throw shifts with respect to the first exposure (str; default: ‘throwlist.asc’) [default=”throwlist.asc”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.combinenod_method">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">combinenod_method</code><a class="headerlink" href="#xsh_respon_slit_nod.param.combinenod_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Combination method for nodded frames (MEDIAN, MEAN) (str; default: ‘MEAN’) [default=”MEAN”].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.max_slit">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">max_slit</code><a class="headerlink" href="#xsh_respon_slit_nod.param.max_slit" title="Permalink to this definition">¶</a></dt>
<dd><p>Lower Slit Limit (localize and extract (float; default: 5.7) [default=5.7].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.min_slit">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">min_slit</code><a class="headerlink" href="#xsh_respon_slit_nod.param.min_slit" title="Permalink to this definition">¶</a></dt>
<dd><p>Upper Slit Limit (localize and extract (float; default: -5.3) [default=-5.3].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.correct_tellurics">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">correct_tellurics</code><a class="headerlink" href="#xsh_respon_slit_nod.param.correct_tellurics" title="Permalink to this definition">¶</a></dt>
<dd><p>TRUE if during response computation we apply telluric correction (bool; default: True) [default=True].</p>
</dd></dl>
<dl class="attribute">
<dt id="xsh_respon_slit_nod.param.correct_sky_by_median">
<code class="descclassname">xsh_respon_slit_nod.param.</code><code class="descname">correct_sky_by_median</code><a class="headerlink" href="#xsh_respon_slit_nod.param.correct_sky_by_median" title="Permalink to this definition">¶</a></dt>
<dd><p>TRUE if the resampled spectrum at each wavelength is median subtracted to remove sky lines (bool; default: True) [default=True].</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">xsh_respon_slit_nod</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">"xsh_respon_slit_nod"</span><span class="p">)</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">keep_temp</span> <span class="o">=</span> <span class="s">"no"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">debug_level</span> <span class="o">=</span> <span class="s">"none"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">time_stamp</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">decode_bp</span> <span class="o">=</span> <span class="mi">2144337919</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">pre_overscan_corr</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">stack_method</span> <span class="o">=</span> <span class="s">"median"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">klow</span> <span class="o">=</span> <span class="mf">5.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">khigh</span> <span class="o">=</span> <span class="mf">5.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">removecrhsingle_sigmalim</span> <span class="o">=</span> <span class="mf">20.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">removecrhsingle_flim</span> <span class="o">=</span> <span class="mf">2.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">removecrhsingle_niter</span> <span class="o">=</span> <span class="mi">4</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">rectify_kernel</span> <span class="o">=</span> <span class="s">"tanh"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">rectify_radius</span> <span class="o">=</span> <span class="mf">2.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">rectify_bin_lambda</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">rectify_bin_slit</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">rectify_fast</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_method</span> <span class="o">=</span> <span class="s">"MANUAL"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_chunk_nb</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_thresh</span> <span class="o">=</span> <span class="mf">0.1</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_deg_lambda</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_slit_position</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_slit_hheight</span> <span class="o">=</span> <span class="mf">2.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_kappa</span> <span class="o">=</span> <span class="mf">3.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_niter</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_use_skymask</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">localize_nod_throw</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">extract_method</span> <span class="o">=</span> <span class="s">"NOD"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">stdextract_interp_hsize</span> <span class="o">=</span> <span class="mi">30</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">combinenod_throwlist</span> <span class="o">=</span> <span class="s">"throwlist.asc"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">combinenod_method</span> <span class="o">=</span> <span class="s">"MEAN"</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">max_slit</span> <span class="o">=</span> <span class="mf">5.7</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">min_slit</span> <span class="o">=</span> <span class="o">-</span><span class="mf">5.3</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">correct_tellurics</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">xsh_respon_slit_nod</span><span class="o">.</span><span class="n">param</span><span class="o">.</span><span class="n">correct_sky_by_median</span> <span class="o">=</span> <span class="bp">True</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">xsh_respon_slit_nod</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">"xsh_respon_slit_nod"</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">xsh_respon_slit_nod</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">"keep_temp"</span><span class="p">:</span><span class="s">"no"</span><span class="p">,</span> <span class="s">"debug_level"</span><span class="p">:</span><span class="s">"none"</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:amodigli%40eso.org">P<span>.</span>Goldoni, L<span>.</span>Guglielmi, R<span>.</span> Haigron, F<span>.</span> Royer, D<span>.</span> Bramich A<span>.</span> 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 X-shooter Instrument Pipeline
Copyright (C) 2006 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: P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich A. Modigliani <<a class="reference external" href="mailto:amodigli%40eso.org">amodigli<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="xsh_respon_slit_offset.html" title="The xsh_respon_slit_offset recipe"
>next</a> |</li>
<li class="right" >
<a href="xsh_flexcomp.html" title="The xsh_flexcomp recipe"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">XSHOO pipeline 2.6.8 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.3.
</div>
</body>
</html>
|