<!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>autoflat (command) — C-Munipack 2.0.8 documentation</title>
<link rel="stylesheet" href="_static/default.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.0.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="C-Munipack 2.0.8 documentation" href="index.html" />
<link rel="up" title="Toolkit reference" href="toolkit_reference.html" />
<link rel="next" title="biasbat (command)" href="biasbat_command.html" />
<link rel="prev" title="airmass (command)" href="airmass_command.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="biasbat_command.html" title="biasbat (command)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="airmass_command.html" title="airmass (command)"
accesskey="P">previous</a> |</li>
<li><a href="index.html">C-Munipack 2.0.8 documentation</a> »</li>
<li><a href="command_line_tools.html" >Command line tools</a> »</li>
<li><a href="toolkit_reference.html" accesskey="U">Toolkit reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="autoflat-command">
<span id="index-0"></span><span id="id1"></span><h1>autoflat (command)<a class="headerlink" href="#autoflat-command" title="Permalink to this headline">¶</a></h1>
<p>utility for making master-flat frames</p>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>autoflat [ options ] <em>output-file</em> <em>input-files</em> ...</p>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The <strong class="command">autoflat</strong> command compose a set of flat frames and makes one
flat frame called ‘master-flat’. Applying this function, you can achieve high quality correction frame
and thus reducing the noise of a result.</p>
<p>All source frames must be in the FITS format and of same dimensions. Frames of the same exposition
duration and color filter should be used, avoid eventual camera rotation on its mount. The output file is
written in the FITS format too.</p>
</div>
<div class="section" id="input-files">
<span id="autoflat-input-files"></span><h2>Input files<a class="headerlink" href="#input-files" title="Permalink to this headline">¶</a></h2>
<p>Names of input files can be specified directly on a command-line as command arguments; it is allowed to use the
usual wild-card notation. In case the input files are placed outside the working directory, you have to specify
the proper path relative to the current working directory.</p>
<p>Alternatively, you can also prepare a list of input file names in a text file, each input file on a separate line.
It is not allowed to use the wild-card notation here. Use the -i option to instruct the program to read the file.</p>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p>Options are used to provide extra information to customize the execution of a command. They are specified as command
arguments.</p>
<p>Each option has a full form starting with two dashes and an optional short form starting with one dash only. Options
are case-sensitive. It is allowed to merge two or more successive short options together. Some options require a value;
in this case a value is taken from a subsequent argument. When a full form is used, an option and its value can also
be separated by an equal sign. When a short form is used, its value can immediately follow the option.</p>
<p>Whenever there is a conflict between a configuration file parameter and an option of the same meaning, the option
always take precedence.</p>
<dl class="option">
<dt id="cmdoption-autoflat-s">
<tt class="descname">-s</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--set</tt><tt class="descclassname"> <name=value></tt><a class="headerlink" href="#cmdoption-autoflat-s" title="Permalink to this definition">¶</a></dt>
<dd><p>set value of configuration parameter</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat-i">
<tt class="descname">-i</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--read-dirfile</tt><tt class="descclassname"> <filepath></tt><a class="headerlink" href="#cmdoption-autoflat-i" title="Permalink to this definition">¶</a></dt>
<dd><p>read list of input files from specified file; see the <a class="reference internal" href="#autoflat-input-files"><em>Input files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat-p">
<tt class="descname">-p</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--configuration-file</tt><tt class="descclassname"> <filepath></tt><a class="headerlink" href="#cmdoption-autoflat-p" title="Permalink to this definition">¶</a></dt>
<dd><p>read parameters from given configuration file. See the <a class="reference internal" href="#autoflat-configuration-file"><em>Configuration file</em></a> section for
details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat-h">
<tt class="descname">-h</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--help</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autoflat-h" title="Permalink to this definition">¶</a></dt>
<dd><p>print list of command-line parameters</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat-q">
<tt class="descname">-q</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--quiet</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autoflat-q" title="Permalink to this definition">¶</a></dt>
<dd><p>quiet mode; suppress all messages</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat--version">
<tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autoflat--version" title="Permalink to this definition">¶</a></dt>
<dd><p>print software version string</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat--licence">
<tt class="descname">--licence</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autoflat--licence" title="Permalink to this definition">¶</a></dt>
<dd><p>print software licence</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-autoflat--verbose">
<tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autoflat--verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>verbose mode; print debug messages</p>
</dd></dl>
</div>
<div class="section" id="configuration-file">
<span id="autoflat-configuration-file"></span><h2>Configuration file<a class="headerlink" href="#configuration-file" title="Permalink to this headline">¶</a></h2>
<p>Configuration files are used to set the input parameters to the process that is going to be executed by a command.
Use the -p option to instruct the program to read the file before other command-line options are processed.</p>
<p>The configuration file consists of a set of parameters stored in a text file. Each parameter is stored on a separate
line in the following form: name = value, all other lines are silently ignored. Parameter names are case-sensitive.</p>
<dl class="confval">
<dt id="confval-bitpix=value">
<tt class="descname">bitpix = value</tt><a class="headerlink" href="#confval-bitpix=value" title="Permalink to this definition">¶</a></dt>
<dd><p>output data format (0=Auto)</p>
</dd></dl>
<dl class="confval">
<dt id="confval-level=value">
<tt class="descname">level = value</tt><a class="headerlink" href="#confval-level=value" title="Permalink to this definition">¶</a></dt>
<dd><p>average level of output frame in ADU</p>
</dd></dl>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><pre>autoflat out.fts in1.fts in2.fts in3.fts</pre>
</div>
<p>The command computes the master-flat frame from the input files <tt class="file docutils literal"><span class="pre">in1.fts</span></tt>,
<tt class="file docutils literal"><span class="pre">in2.fts</span></tt> a <tt class="file docutils literal"><span class="pre">in3.fts</span></tt>; the resulting frame is stored to
output file <tt class="file docutils literal"><span class="pre">out.fts</span></tt>.</p>
</div>
<div class="section" id="exit-status">
<h2>Exit status<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2>
<p>The command returns a zero exit status if it succeeds to process all specified files. Otherwise, it will stop
immediately when an error occurs and a nonzero error code is returned.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">autoflat (command)</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="#input-files">Input files</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#configuration-file">Configuration file</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#exit-status">Exit status</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="airmass_command.html"
title="previous chapter">airmass (command)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="biasbat_command.html"
title="next chapter">biasbat (command)</a></p>
<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="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="biasbat_command.html" title="biasbat (command)"
>next</a> |</li>
<li class="right" >
<a href="airmass_command.html" title="airmass (command)"
>previous</a> |</li>
<li><a href="index.html">C-Munipack 2.0.8 documentation</a> »</li>
<li><a href="command_line_tools.html" >Command line tools</a> »</li>
<li><a href="toolkit_reference.html" >Toolkit reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, David Motl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
