<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN"> <html><head> <link rel="stylesheet" type="text/css" href="cmunipack.css"> <title>munimatch</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>munimatch</h1></div><p>utility for finding matching photometry files</p><h3>Synopsis</h3><p class="synopsis">munimatch [ <i>options</i> ] <i>reference-file</i> <i>input-files</i> ...</p> <h3>Description</h3><p>The <a href="munimatch.html"><tt>munimatch</tt></a> command finds corresponding stars in two photometry files. One file is refered as reference file, the second one is called source file. The output of the matching process is the photometry file, which the stars from source file is written in, but their order is changed, so corresponding stars are on the same indices in output and reference files. Instead of a reference file, which is usually one frame from a sequence being processed, a catalogue file in XML format can be used.</p><p>The source and output files have to be in photometry file format. The reference file should be in photometry or catalogue file format, optionally. If a set of files is processed, then the reference file is common for all sources.</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>Output files</h3><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 <b>-o</b> 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 <b>-i</b> 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 <b>-g</b> option to specify a file name.</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>-g</b>, <b>--make-dirfile</b> <i>filepath</i></dt><dd><p>save list of output files to specified file, existing content of the file will be overwritten; see the Files section for details.</p></dd><dt><b>-o</b>, <b>--output-mask</b> <i>mask</i></dt><dd><p>set output file mask (default=<tt>%.mat</tt>), see the Files section for details.</p></dd><dt><b>-c</b>, <b>--counter</b> <i>value</i></dt><dd><p>set initial counter value (default=1), 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>max_stars</b> = <i>value</i></dt><dd><p>Max. number of input stars</p></dd><dt><b>vertices</b> = <i>value</i></dt><dd><p>Number of polygon vertices</p></dd><dt><b>clip_thresh</b> = <i>value</i></dt><dd><p>Clipping threshold</p></dd><dt><b>sp_fields</b> = <i>value</i></dt><dd><p>Matching method</p></dd><dt><b>sp_maxoffset</b> = <i>value</i></dt><dd><p>Max. offset for sparse fields</p></dd></dl><h3>Examples</h3><p><tt>munimatch -oout.mat ref.pht in.pht</tt></p><p>The command matches file <tt>in.pht</tt> as a source file and <tt>ref.pht</tt> as reference file and the writes output to <tt>out.mat</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>
