<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN"> <html><head> <link rel="stylesheet" type="text/css" href="cmunipack.css"> <title>meandark</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head><body><div class="main_head"><p class="head"><a href="index.html">C-Munipack 1.2</a> / <a href="node046.html">Command line tools</a> / <a href="node052.html">Toolkit reference</a></p><h1>meandark</h1></div><p>utility for making master-dark frames</p><h3>Synopsis</h3><p class="synopsis">meandark [ <i>options</i> ] <i>output-file</i> <i>input-files</i> ...</p> <h3>Description</h3><p>The <a href="meandark.html"><tt>meandark</tt></a> command compose a set of dark frames and makes one dark frame called 'master-dark'. 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 should be used. The output file is written in the FITS format too.</p><h3>Input files</h3><p>Names of input files can be specified directly on a command-line as command arguments; it is allowed to use the usual wildcard 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 wildcard notation here. Use the <b>-i</b> option to instruct the program to read the file.</p><h3>Options</h3><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><dt><b>-s</b>, <b>--set</b> <i>name=value</i></dt><dd><p>set value of configuration parameter</p></dd><dt><b>-i</b>, <b>--read-dirfile</b> <i>filepath</i></dt><dd><p>read list of input files from specified file; see the Files section for details.</p></dd><dt><b>-p</b>, <b>--configuration-file</b> <i>filepath</i></dt><dd><p>read parameters from given configuration file. See the Configuration file section for details.</p></dd><dt><b>-h</b>, <b>--help</b></dt><dd><p>print list of command-line parameters</p></dd><dt><b>-q</b>, <b>--quiet</b></dt><dd><p>quiet mode; suppress all messages</p></dd><dt><b>--version</b></dt><dd><p>print software version string</p></dd><dt><b>--licence</b></dt><dd><p>print software licence</p></dd><dt><b>--verbose</b></dt><dd><p>verbose mode; print debug messages</p></dd></dl><h3>Configuration file</h3><p>Configuration files are used to set the input parameters to the process that is going to be executed by a command. Use the <b>-p</b> 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: <i>name</i> = <i>value</i>, all other lines are silently ignored. Parameter names are case-sensitive.</p><dl><dt><b>bitpix</b> = <i>value</i></dt><dd><p>output data format (0=Auto)</p></dd><dt><b>scalable</b> = <i>value</i></dt><dd><p>make scalable dark-frame (0=No, 1=Yes)</p></dd></dl><h3>Examples</h3><p><tt>meandark out.fts in1.fts in2.fts in3.fts</tt></p><p>The command computes the master-dark frame from the input files <tt>in1.fts</tt>, <tt>in2.fts</tt> a <tt>in3.fts</tt>; the resulting frame is stored to output file <tt>out.fts</tt>.</p><h3>Exit status</h3><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></body></html>
