<!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>muniphot (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="timebat (command)" href="timebat_command.html" />
<link rel="prev" title="munimatch (command)" href="munimatch_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="timebat_command.html" title="timebat (command)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="munimatch_command.html" title="munimatch (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="muniphot-command">
<span id="index-0"></span><span id="id1"></span><h1>muniphot (command)<a class="headerlink" href="#muniphot-command" title="Permalink to this headline">¶</a></h1>
<p>utility for photometry of CCD frames</p>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>muniphot [ options ] <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">muniphot</strong> command applies photometry to a single frame or a set of
CCD frames. The output is written to so-called photometry files.
Current version uses aperture photometry algorithm only. All source frames must be in the FITS
format.</p>
</div>
<div class="section" id="input-files">
<span id="muniphot-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="muniphot-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-muniphot-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-muniphot-s" title="Permalink to this definition">¶</a></dt>
<dd><p>set value of configuration parameter</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-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="#muniphot-input-files"><em>Input files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-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="#muniphot-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-o" title="Permalink to this definition">¶</a></dt>
<dd><p>set output file mask (default=:file:<cite>kout????.fts</cite>), see the <a class="reference internal" href="#muniphot-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-c" title="Permalink to this definition">¶</a></dt>
<dd><p>set initial counter value (default=1), see the <a class="reference internal" href="#muniphot-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-p" title="Permalink to this definition">¶</a></dt>
<dd><p>read parameters from given configuration file. See the <a class="reference internal" href="#muniphot-configuration-file"><em>Configuration file</em></a> section for
details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot-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-muniphot-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-muniphot-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-muniphot-q" title="Permalink to this definition">¶</a></dt>
<dd><p>quiet mode; suppress all messages</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot--version">
<tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-muniphot--version" title="Permalink to this definition">¶</a></dt>
<dd><p>print software version string</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot--licence">
<tt class="descname">--licence</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-muniphot--licence" title="Permalink to this definition">¶</a></dt>
<dd><p>print software licence</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-muniphot--verbose">
<tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-muniphot--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="muniphot-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-readns=value">
<tt class="descname">readns = value</tt><a class="headerlink" href="#confval-readns=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Readout noise</p>
</dd></dl>
<dl class="confval">
<dt id="confval-gain=value">
<tt class="descname">gain = value</tt><a class="headerlink" href="#confval-gain=value" title="Permalink to this definition">¶</a></dt>
<dd><p>ADC gain</p>
</dd></dl>
<dl class="confval">
<dt id="confval-minvalue=value">
<tt class="descname">minvalue = value</tt><a class="headerlink" href="#confval-minvalue=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Min. pixel value in ADU</p>
</dd></dl>
<dl class="confval">
<dt id="confval-maxvalue=value">
<tt class="descname">maxvalue = value</tt><a class="headerlink" href="#confval-maxvalue=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Max. pixel value in ADU</p>
</dd></dl>
<dl class="confval">
<dt id="confval-fwhm=value">
<tt class="descname">fwhm = value</tt><a class="headerlink" href="#confval-fwhm=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Expected FWHM in pixels</p>
</dd></dl>
<dl class="confval">
<dt id="confval-thresh=value">
<tt class="descname">thresh = value</tt><a class="headerlink" href="#confval-thresh=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Detection threshold</p>
</dd></dl>
<dl class="confval">
<dt id="confval-minsharp=value">
<tt class="descname">minsharp = value</tt><a class="headerlink" href="#confval-minsharp=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Low sharpness cutoff</p>
</dd></dl>
<dl class="confval">
<dt id="confval-maxsharp=value">
<tt class="descname">maxsharp = value</tt><a class="headerlink" href="#confval-maxsharp=value" title="Permalink to this definition">¶</a></dt>
<dd><p>High sharpness cutoff</p>
</dd></dl>
<dl class="confval">
<dt id="confval-minround=value">
<tt class="descname">minround = value</tt><a class="headerlink" href="#confval-minround=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Low roundness cutoff</p>
</dd></dl>
<dl class="confval">
<dt id="confval-maxround=value">
<tt class="descname">maxround = value</tt><a class="headerlink" href="#confval-maxround=value" title="Permalink to this definition">¶</a></dt>
<dd><p>High roundness cutoff</p>
</dd></dl>
<dl class="confval">
<dt id="confval-skyinner=value">
<tt class="descname">skyinner = value</tt><a class="headerlink" href="#confval-skyinner=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Inner radius of sky aperture</p>
</dd></dl>
<dl class="confval">
<dt id="confval-skyouter=value">
<tt class="descname">skyouter = value</tt><a class="headerlink" href="#confval-skyouter=value" title="Permalink to this definition">¶</a></dt>
<dd><p>Outer radius of sky aperture</p>
</dd></dl>
<dl class="confval">
<dt id="confval-apertures=value,value,...">
<tt class="descname">apertures = value,value,...</tt><a class="headerlink" href="#confval-apertures=value,value,..." title="Permalink to this definition">¶</a></dt>
<dd><p>Comma separated list of radii of star apertures</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>muniphot -oout?.pht test1.fts test2.fts test3.fts</pre>
</div>
<p>The command performs photometry to the files <tt class="file docutils literal"><span class="pre">test1.fts</span></tt>, <tt class="file docutils literal"><span class="pre">test2.fts</span></tt>
and <tt class="file docutils literal"><span class="pre">test3.st7</span></tt> and writes the output to the files: <tt class="file docutils literal"><span class="pre">out1.pht</span></tt>,
<tt class="file docutils literal"><span class="pre">out2.pht</span></tt> and <tt class="file docutils literal"><span class="pre">out3.pht</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="#">muniphot (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="#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="munimatch_command.html"
title="previous chapter">munimatch (command)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="timebat_command.html"
title="next chapter">timebat (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="timebat_command.html" title="timebat (command)"
>next</a> |</li>
<li class="right" >
<a href="munimatch_command.html" title="munimatch (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>
