<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html><head>
<link rel="stylesheet" type="text/css" href="cmunipack.css">
<title>Functions for making output data files. </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="node014.html">Application programming interface</a> / <a href="node020.html">API reference</a></p><h1>Functions for making output data files. </h1></div><h2>cmpack_list.h</h2><h3>Enumerations</h3><table><tr><td>CmpackListFormat</td><td>Output format identifiers. </td></tr></table><h3>Type definitions</h3><table><tr><td>CmpackLister</td><td>Listing process context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_list_init</td><td>Make new listing context. </td></tr><tr><td>cmpack_list_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_list_set_aperture</td><td>Set aperture index. </td></tr><tr><td>cmpack_list_get_aperture</td><td>Get aperture index. </td></tr><tr><td>cmpack_list_set_var</td><td>Set list of variable stars. </td></tr><tr><td>cmpack_list_set_comp</td><td>Set list of comparison stars. </td></tr><tr><td>cmpack_list_set_check</td><td>Set list of check stars. </td></tr><tr><td>cmpack_list_open</td><td>Start listing to a table. </td></tr><tr><td>cmpack_list_read</td><td>Read single frame from a photometry file and process it. </td></tr><tr><td>cmpack_list_close</td><td>Flush all data, close reading sequence. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to read a set of information from photometry files and make output file (a light curve, a track list, ...)</p><h2>CmpackLister (data type)</h2><p>Listing process context.</p><h3>Synopsis</h3><p>typedef struct _CmpackLister CmpackLister</p><h3>Description</h3><p>This private data structure holds the temporary data, which are used during listing process.</p><h2>CmpackListFormat (enumeration)</h2><p>Output format identifiers.</p><h3>Synopsis</h3><p class="synopsis">enum CmpackListFormat<br>{<br> CMPACK_LIST_DIFFMAG,<br> CMPACK_LIST_INSTMAG,<br> CMPACK_LIST_TRACKLST,<br> CMPACK_LIST_STDDEV<br>};<h3>Enumerators</h3><table><tr><td>CMPACK_LIST_DIFFMAG</td><td>Differential magnitudes (default). </td></tr><tr><td>CMPACK_LIST_INSTMAG</td><td>Instrumental magnitudes. </td></tr><tr><td>CMPACK_LIST_TRACKLST</td><td>Track list. </td></tr><tr><td>CMPACK_LIST_STDDEV</td><td>Standard deviations. </td></tr></table><h2>cmpack_list_init (function)</h2><p>Make new listing context.</p><h3>Synopsis</h3><p class="synopsis">CmpackLister * cmpack_list_init (void)</p><h3>Description</h3><p>The reference counter is set to one. The caller is responsible to call cmpack_unref() when it is no longer needed.</p><h3>Return value</h3><p>pointer to context or zero on failure</p><h2>cmpack_list_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_list_set_console (CmpackLister * ctx, CmpackConsole * con)</p><h3>Description</h3><p>Increment console's reference counter. Only one console can be attached to a single context. If another console is attached, by calling this function dettaches it. Set console to NULL to dettach the current console.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>air-mass computation context </td></tr><tr><td>con</td><td><tt>[in]</tt> </td><td>console context </td></tr></table><h2>cmpack_list_set_aperture (function)</h2><p>Set aperture index.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_list_set_aperture (CmpackLister * proc, int index)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing context </td></tr><tr><td>index</td><td><tt>[in]</tt> </td><td>aperture index (starts by 1) </td></tr></table><h2>cmpack_list_get_aperture (function)</h2><p>Get aperture index.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_list_get_aperture (CmpackLister * proc)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing context </td></tr></table><h3>Return value</h3><p>aperture index (starts by 1)</p><h2>cmpack_list_set_var (function)</h2><p>Set list of variable stars.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_list_set_var (CmpackLister * proc, const int * items, int nitems)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing context </td></tr><tr><td>items</td><td><tt>[in]</tt> </td><td>array of star identifiers </td></tr><tr><td>nitems</td><td><tt>[in]</tt> </td><td>number of items </td></tr></table><h2>cmpack_list_set_comp (function)</h2><p>Set list of comparison stars.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_list_set_comp (CmpackLister * proc, const int * items, int nitems)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing context </td></tr><tr><td>items</td><td><tt>[in]</tt> </td><td>array of star identifiers </td></tr><tr><td>nitems</td><td><tt>[in]</tt> </td><td>number of items </td></tr></table><h2>cmpack_list_set_check (function)</h2><p>Set list of check stars.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_list_set_check (CmpackLister * proc, const int * items, int nitems)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing context </td></tr><tr><td>items</td><td><tt>[in]</tt> </td><td>array of star identifiers </td></tr><tr><td>nitems</td><td><tt>[in]</tt> </td><td>number of items </td></tr></table><h2>cmpack_list_open (function)</h2><p>Start listing to a table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_list_open (CmpackLister * proc, CmpackTable * table, CmpackListFormat format, int flags)</p><h3>Description</h3><p>The function clears the content of the table, sets its columns. Use cmpack_list_close() to finish the operation. If the 'table' parameter is NULL, it makes a new table instance. You can get the pointer to it by calling the cmpack_list_get_table function.</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing process context </td></tr><tr><td>table</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>format</td><td><tt>[in]</tt> </td><td>output format </td></tr><tr><td>flags</td><td><tt>[in]</tt> </td><td>flags </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_list_read (function)</h2><p>Read single frame from a photometry file and process it.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_list_read (CmpackLister * proc, CmpackPhtFile * file, int frame)</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing process context </td></tr><tr><td>file</td><td><tt>[in]</tt> </td><td>matched photometry file context </td></tr><tr><td>frame</td><td><tt>[in]</tt> </td><td>frame ordinal number </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_list_close (function)</h2><p>Flush all data, close reading sequence.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_list_close (CmpackLister * proc)</p><h3>Description</h3><p>The function finishes up the computation of output data.</p><h3>Parameters</h3><table><tr><td>proc</td><td><tt>[in]</tt> </td><td>listing process context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p></body></html>
