<!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>flatbat (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="helcor (command)" href="helcor_command.html" />
<link rel="prev" title="darkbat (command)" href="darkbat_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="helcor_command.html" title="helcor (command)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="darkbat_command.html" title="darkbat (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="flatbat-command">
<span id="index-0"></span><span id="id1"></span><h1>flatbat (command)<a class="headerlink" href="#flatbat-command" title="Permalink to this headline">¶</a></h1>
<p>utility for flat-frame correction</p>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>flatbat [ options ] <em>flat-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">flatbat</strong> command applies flat-field correction to a set of source frames.
It means, that it divides the source frames by the flat frame pixel-by-pixel and the result is multiplied by
median value of the flat frame. The resulting image is written to output file.
The source frames and also flat frame must be in FITS format and of same dimensions. The output
file is in FITS format too.</p>
</div>
<div class="section" id="input-files">
<span id="flatbat-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="output-files">
<span id="flatbat-output-files"></span><h2>Output files<a class="headerlink" href="#output-files" title="Permalink to this headline">¶</a></h2>
<p>By default, output files are stored to the current working directory. Their names
are derived from the command name followed by a sequential number starting by 1.
Command options allows a caller to modify the default naming of output files.</p>
<p>The -o option sets the format string; it may contain a path where
the files shall be stored to. Special meaning has a sequence of question marks, it
is replaced by the ordinal number of a file indented by leading zeros to the same
number of decimal places as the number of the question marks.</p>
<p>By means of the -i option, you can modify the initial value of a counter.</p>
<p>On request, the program can write a list of output files to a text file, use the -g option
to specify a file name.</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-flatbat-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-flatbat-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="#flatbat-input-files"><em>Input files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat-g">
<tt class="descname">-g</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--make-dirfile</tt><tt class="descclassname"> <filepath></tt><a class="headerlink" href="#cmdoption-flatbat-g" title="Permalink to this definition">¶</a></dt>
<dd><p>save list of output files to specified file, existing content of the file will be overwritten;
see the <a class="reference internal" href="#flatbat-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat-o">
<tt class="descname">-o</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--output-mask</tt><tt class="descclassname"> <mask></tt><a class="headerlink" href="#cmdoption-flatbat-o" title="Permalink to this definition">¶</a></dt>
<dd><p>set output file mask (default=:file:<cite>fout????.fts</cite>), see the <a class="reference internal" href="#flatbat-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat-c">
<tt class="descname">-c</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--counter</tt><tt class="descclassname"> <value></tt><a class="headerlink" href="#cmdoption-flatbat-c" title="Permalink to this definition">¶</a></dt>
<dd><p>set initial counter value (default=1), see the <a class="reference internal" href="#flatbat-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat-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-flatbat-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-flatbat-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-flatbat-q" title="Permalink to this definition">¶</a></dt>
<dd><p>quiet mode; suppress all messages</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat--version">
<tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-flatbat--version" title="Permalink to this definition">¶</a></dt>
<dd><p>print software version string</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat--licence">
<tt class="descname">--licence</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-flatbat--licence" title="Permalink to this definition">¶</a></dt>
<dd><p>print software licence</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-flatbat--verbose">
<tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-flatbat--verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>verbose mode; print debug messages</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>flatbat -oout.fts flat.fts in.fts</pre>
</div>
<p>The command applies flat correction to <tt class="file docutils literal"><span class="pre">in.fts</span></tt> using <tt class="file docutils literal"><span class="pre">flat.fts</span></tt>
as a correction frame. The output is written to <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="#">flatbat (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="#output-files">Output files</a></li>
<li><a class="reference internal" href="#options">Options</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="darkbat_command.html"
title="previous chapter">darkbat (command)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="helcor_command.html"
title="next chapter">helcor (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="helcor_command.html" title="helcor (command)"
>next</a> |</li>
<li class="right" >
<a href="darkbat_command.html" title="darkbat (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>
