<!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>helcor (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="kombine (command)" href="kombine_command.html" />
<link rel="prev" title="flatbat (command)" href="flatbat_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="kombine_command.html" title="kombine (command)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="flatbat_command.html" title="flatbat (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="helcor-command">
<span id="index-0"></span><span id="id1"></span><h1>helcor (command)<a class="headerlink" href="#helcor-command" title="Permalink to this headline">¶</a></h1>
<p>utility for computing heliocentric correction</p>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>helcor [ options ] <em>input-files</em></p>
<p>helcor [ options ] -j <em>julian-date</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">helcor</strong> command computes value of heliocentric correction for given Julian date
and object’s coordinates. It may also append the values to a set of measurements stored in a text file.
When the -j option is present on the command line, the value of heliocentric correction is
printed to the standard output stream.</p>
<p>If one or more file names are present on the command line, each source file given is processed line by line,
the program expects the JD value in the first column, which must be divided at least one of common used dividers
(semicolon, comma, space, tab char, ...). The JD value can be in full (2453xxx.x) or short (53xxx.x) form. Decimal
places must be separated by point, not comma. The Julian date is replaced by a corrected date and the value of
correction may be optionally appended to the end of the line. If the line starts with the text <tt class="docutils literal"><span class="pre">JD</span></tt>,
it is considered to be a table header and it is changed to <tt class="docutils literal"><span class="pre">JDHEL</span></tt> or <tt class="docutils literal"><span class="pre">JDGEO</span></tt>.
The text <tt class="docutils literal"><span class="pre">HELCOR</span></tt> is optionally appended to the end of the line. All other lines which do not fit
to any of previous rules are copied to the output file without modification.</p>
</div>
<div class="section" id="input-files">
<span id="helcor-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="helcor-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-helcor-j">
<tt class="descname">-j</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--julian-date</tt><tt class="descclassname"> <jd></tt><a class="headerlink" href="#cmdoption-helcor-j" title="Permalink to this definition">¶</a></dt>
<dd><p>compute and print air-mass coefficient for given Julian date. Do not combine this option
with input file names.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-a">
<tt class="descname">-a</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--right-ascension</tt><tt class="descclassname"> <hhmmss></tt><a class="headerlink" href="#cmdoption-helcor-a" title="Permalink to this definition">¶</a></dt>
<dd><p>right ascension of object in hours, minutes and seconds</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-d">
<tt class="descname">-d</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--declination</tt><tt class="descclassname"> <ddmmss></tt><a class="headerlink" href="#cmdoption-helcor-d" title="Permalink to this definition">¶</a></dt>
<dd><p>declination of object in degrees, minutes and seconds</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-s" title="Permalink to this definition">¶</a></dt>
<dd><p>set value of configuration parameter</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-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="#helcor-input-files"><em>Input files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-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="#helcor-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-o" title="Permalink to this definition">¶</a></dt>
<dd><p>set output file mask (default=:file:<cite>hcor????.dat</cite>), see the <a class="reference internal" href="#helcor-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-c" title="Permalink to this definition">¶</a></dt>
<dd><p>set initial counter value (default=1), see the <a class="reference internal" href="#helcor-output-files"><em>Output files</em></a> section for details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-p" title="Permalink to this definition">¶</a></dt>
<dd><p>read parameters from given configuration file. See the <a class="reference internal" href="#helcor-configuration-file"><em>Configuration file</em></a> section for
details.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor-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-helcor-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-helcor-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-helcor-q" title="Permalink to this definition">¶</a></dt>
<dd><p>quiet mode; suppress all messages</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor--version">
<tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-helcor--version" title="Permalink to this definition">¶</a></dt>
<dd><p>print software version string</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor--licence">
<tt class="descname">--licence</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-helcor--licence" title="Permalink to this definition">¶</a></dt>
<dd><p>print software licence</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-helcor--verbose">
<tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-helcor--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="helcor-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-right-ascension=hhmmss">
<tt class="descname">right-ascension = hhmmss</tt><a class="headerlink" href="#confval-right-ascension=hhmmss" title="Permalink to this definition">¶</a></dt>
<dd><p>right ascension of object in hours, minutes and seconds</p>
</dd></dl>
<dl class="confval">
<dt id="confval-declination=ddmmss">
<tt class="descname">declination = ddmmss</tt><a class="headerlink" href="#confval-declination=ddmmss" title="Permalink to this definition">¶</a></dt>
<dd><p>declination of object in degrees, minutes and seconds</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>helcor -a182932 -d223424 -j2452763.5670</pre>
</div>
<p>The command computes and prints value of heliocentric correction to the standard output.
The object’s coordinates are R.A. = 18h 29m 32s, DEC. = +22d 34m 24s. Julian date of observation
is 2452763.5670.</p>
<div class="highlight-python"><pre>helcor -a182932 -d223424 -ohcor.dat table.dat</pre>
</div>
<p>The command performs the heliocentric correction to the table stored in <tt class="file docutils literal"><span class="pre">table.dat</span></tt>
file and the resulting table stores in <tt class="file docutils literal"><span class="pre">hcor.dat</span></tt> file. The object’s coordinates are
the same as in previous example.</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="#">helcor (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="flatbat_command.html"
title="previous chapter">flatbat (command)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="kombine_command.html"
title="next chapter">kombine (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="kombine_command.html" title="kombine (command)"
>next</a> |</li>
<li class="right" >
<a href="flatbat_command.html" title="flatbat (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>
