<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html><head>
<link rel="stylesheet" type="text/css" href="cmunipack.css">
<title>Functions for reading and writing output data files (tables). </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 reading and writing output data files (tables). </h1></div><h2>cmpack_table.h</h2><h3>Enumerations</h3><table><tr><td>CmpackTableType</td><td>Table type identifiers. </td></tr><tr><td>CmpackColumnType</td><td>Column type identifier. </td></tr></table><h3>Type definitions</h3><table><tr><td>CmpackTable</td><td>Table context. </td></tr><tr><td>CmpackTabColumn</td><td>Table column context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_tab_init</td><td>Create a new table context. </td></tr><tr><td>cmpack_tab_load</td><td>Load a table from a file. </td></tr><tr><td>cmpack_tab_save</td><td>Save a table to a file. </td></tr><tr><td>cmpack_tab_clear</td><td>Clear table definition, header and data. </td></tr><tr><td>cmpack_tab_copy</td><td>Copy a table. </td></tr><tr><td>cmpack_tab_set_type</td><td>Set table type. </td></tr><tr><td>cmpack_tab_get_type</td><td>Get table type. </td></tr><tr><td>cmpack_tab_test</td><td>Check if the file is a table. </td></tr><tr><td>cmpack_tab_test_buffer</td><td>Test if the content of the buffer might be a table. </td></tr><tr><td>cmpack_tab_pkys</td><td>Set parameter value in file header (string). </td></tr><tr><td>cmpack_tab_pkyi</td><td>Set parameter value in file header (integer). </td></tr><tr><td>cmpack_tab_pkyd</td><td>Set parameter value in file header (integer). </td></tr><tr><td>cmpack_tab_gkys</td><td>Get value of parameter in file header (string). </td></tr><tr><td>cmpack_tab_gkyi</td><td>Get value of parameter in file header (integer). </td></tr><tr><td>cmpack_tab_gkyd</td><td>Get value of parameter in file header (double). </td></tr><tr><td>cmpack_tab_nkey</td><td>Get number of parameters in file header. </td></tr><tr><td>cmpack_tab_gkyn</td><td>Get the parameter from file header by its index. </td></tr><tr><td>cmpack_tab_dkey</td><td>Delete parameter from file header. </td></tr><tr><td>cmpack_tab_ncolumns</td><td>Get number of columns. </td></tr><tr><td>cmpack_tab_add_column</td><td>Append new column to the table. </td></tr><tr><td>cmpack_tab_get_column</td><td>Get column by its index. </td></tr><tr><td>cmpack_tab_find_column</td><td>Find column by its name. </td></tr><tr><td>cmpack_tab_column_set_name</td><td>Set column name. </td></tr><tr><td>cmpack_tab_column_get_name</td><td>Get column name. </td></tr><tr><td>cmpack_tab_nrows</td><td>Get number of rows in the table. </td></tr><tr><td>cmpack_tab_add_row</td><td>Append a new row to the table. </td></tr><tr><td>cmpack_tab_ptds</td><td>Set table data (string). </td></tr><tr><td>cmpack_tab_ptdi</td><td>Set table data (integer). </td></tr><tr><td>cmpack_tab_ptdd</td><td>Set table data (real number). </td></tr><tr><td>cmpack_tab_gtds</td><td>Get table data (string). </td></tr><tr><td>cmpack_tab_gtdi</td><td>Get table data (integer). </td></tr><tr><td>cmpack_tab_gtdd</td><td>Get table data (double). </td></tr></table><h3>Description</h3><p>Output data files contain data in form of table. It is used for storing light curves, track lists, etc.</p><p>Use cmpack-list object to process a set of photometry files and make output data. This format was inherited from original Munipack, but it's been extended to support saving a set of parameters (file header).</p><h2>CmpackTable (data type)</h2><p>Table context.</p><h3>Synopsis</h3><p>typedef struct _CmpackTable CmpackTable</p><h3>Description</h3><p>This private structure holds the table header and data</p><h2>CmpackTabColumn (data type)</h2><p>Table column context.</p><h3>Synopsis</h3><p>typedef struct _CmpackTabColumn CmpackTabColumn</p><h3>Description</h3><p>This private structure holds the information about table column</p><h2>CmpackTableType (enumeration)</h2><p>Table type identifiers.</p><h3>Synopsis</h3><p class="synopsis">enum CmpackTableType<br>{<br> CMPACK_TABLE_UNSPECIFIED,<br> CMPACK_TABLE_LIGHTCURVE,<br> CMPACK_TABLE_MUNIFIND,<br> CMPACK_TABLE_TRACKLIST,<br> CMPACK_TABLE_APERTURES,<br> CMPACK_TABLE_AIRMASS<br>};<h3>Enumerators</h3><table><tr><td>CMPACK_TABLE_UNSPECIFIED</td><td>Unspecified type. </td></tr><tr><td>CMPACK_TABLE_LIGHTCURVE</td><td>Light curve. </td></tr><tr><td>CMPACK_TABLE_MUNIFIND</td><td>Mag-dev graph, result of the Munifind tool. </td></tr><tr><td>CMPACK_TABLE_TRACKLIST</td><td>Track-list, frame offsets. </td></tr><tr><td>CMPACK_TABLE_APERTURES</td><td>Apertures and standard deviations. </td></tr><tr><td>CMPACK_TABLE_AIRMASS</td><td>Air-mass coefficients. </td></tr></table><h2>CmpackColumnType (enumeration)</h2><p>Column type identifier.</p><h3>Synopsis</h3><p class="synopsis">enum CmpackColumnType<br>{<br> CMPACK_COLUMN_STRING,<br> CMPACK_COLUMN_INTEGER,<br> CMPACK_COLUMN_DOUBLE<br>};<h3>Enumerators</h3><table><tr><td>CMPACK_COLUMN_STRING</td><td>Unspecified type. </td></tr><tr><td>CMPACK_COLUMN_INTEGER</td><td>Identifier of a star, an aperture, . </td></tr><tr><td>CMPACK_COLUMN_DOUBLE</td><td>Julian date. </td></tr></table><h2>cmpack_tab_init (function)</h2><p>Create a new table context.</p><h3>Synopsis</h3><p class="synopsis">CmpackTable * cmpack_tab_init (CmpackTableType type)</p><h3>Description</h3><p>This function makes an empty table</p><h3>Return value</h3><p>new reference to a table context</p><h2>cmpack_tab_load (function)</h2><p>Load a table from a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_load (CmpackTable ** tab, const char * filename, CmpackLoadMode flags)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[out]</tt> </td><td>new table context </td></tr><tr><td>filename</td><td><tt>[in]</tt> </td><td>path + file name </td></tr><tr><td>flags</td><td><tt>[in]</tt> </td><td>flags (see CMPACK_LOAD_xxx constants) </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_save (function)</h2><p>Save a table to a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_save (CmpackTable * tab, const char * filename)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>filename</td><td><tt>[in]</tt> </td><td>path + file name </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_clear (function)</h2><p>Clear table definition, header and data.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_clear (CmpackTable * tab)</p><h3>Description</h3><p>Deletes all information stored in a table context</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr></table><h2>cmpack_tab_copy (function)</h2><p>Copy a table.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_copy (CmpackTable * dsttab, const CmpackTable * srctab)</p><h3>Description</h3><p>Makes a copy of source table to the destination table. All content of the destination table will be deleted.</p><h3>Parameters</h3><table><tr><td>dsttab</td><td><tt>[in]</tt> </td><td>destination table context </td></tr><tr><td>srctab</td><td><tt>[in]</tt> </td><td>source table context </td></tr></table><h2>cmpack_tab_set_type (function)</h2><p>Set table type.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_set_type (CmpackTable * tab, CmpackTableType type)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>type</td><td><tt>[in]</tt> </td><td>table type identifier </td></tr></table><h2>cmpack_tab_get_type (function)</h2><p>Get table type.</p><h3>Synopsis</h3><p class="synopsis">CmpackTableType cmpack_tab_get_type (CmpackTable * tab)</p><h3>Description</h3><p>This function returns the type of the table</p><h3>Return value</h3><p>the integer value that represents the type of the table</p><h2>cmpack_tab_test (function)</h2><p>Check if the file is a table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_test (const char * filename)</p><h3>Parameters</h3><table><tr><td>filename</td><td><tt>[in]</tt> </td><td>path + file name </td></tr></table><h3>Return value</h3><p>nonzero if the file is a table, zero otherwise</p><h2>cmpack_tab_test_buffer (function)</h2><p>Test if the content of the buffer might be a table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_test_buffer (const char * buffer, int buflen, int filesize)</p><h3>Description</h3><p>The function checks the data in the buffer and returns nonzero, when the buffer contain first 'buflen' bytes from a table. This function is used for file format autodetection.</p><h3>Return value</h3><p>nonzero if the file is a photometry file, zero otherwise</p><h2>cmpack_tab_pkys (function)</h2><p>Set parameter value in file header (string).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_pkys (CmpackTable * tab, const char * key, const char * val)</p><h3>Description</h3><p>If the parameter does not exist, it makes new entry in the file header. If the parameter exists, its content is changed. Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>parameter value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_pkyi (function)</h2><p>Set parameter value in file header (integer).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_pkyi (CmpackTable * tab, const char * key, int val)</p><h3>Description</h3><p>If the parameter does not exist, it makes new entry in the file header. If the parameter exists, its content is changed. Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>parameter value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_pkyd (function)</h2><p>Set parameter value in file header (integer).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_pkyd (CmpackTable * tab, const char * key, double val, int prec)</p><h3>Description</h3><p>If the parameter does not exist, it makes new entry in the file header. If the parameter exists, its content is changed. Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>parameter value </td></tr><tr><td>prec</td><td><tt>[in]</tt> </td><td>number of decimal places </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_gkys (function)</h2><p>Get value of parameter in file header (string).</p><h3>Synopsis</h3><p class="synopsis">const char * cmpack_tab_gkys (CmpackTable * tab, const char * key)</p><h3>Description</h3><p>The val parameters receives the pointer to newly allocated memory buffer. The caller is responsible to free it by calling of cmpack_free() function. Keys are case sensitive. You can set the output parameter to NULL if you want to test the value only.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr></table><h3>Return value</h3><p>pointer to internal buffer or NULL on failure</p><h2>cmpack_tab_gkyi (function)</h2><p>Get value of parameter in file header (integer).</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_gkyi (CmpackTable * tab, const char * key, int defval)</p><h3>Description</h3><p>Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr><tr><td>defval</td><td><tt>[in]</tt> </td><td>default value </td></tr></table><h3>Return value</h3><p>parameter value on success, default value on failure</p><h2>cmpack_tab_gkyd (function)</h2><p>Get value of parameter in file header (double).</p><h3>Synopsis</h3><p class="synopsis">double cmpack_tab_gkyd (CmpackTable * tab, const char * key, double defval)</p><h3>Description</h3><p>Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr><tr><td>defval</td><td><tt>[in]</tt> </td><td>default value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_nkey (function)</h2><p>Get number of parameters in file header.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_nkey (CmpackTable * tab)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr></table><h3>Return value</h3><p>number of parameter or zero if the file is not valid context or if the header is empty.</p><h2>cmpack_tab_gkyn (function)</h2><p>Get the parameter from file header by its index.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_gkyn (CmpackTable * tab, int index, const char ** key, const char ** val)</p><h3>Description</h3><p>Index of the first parameter is zero. The output parameters receive the pointers to newly allocated memory buffers. The caller is responsible to free it by calling of cmpack_free() function. You can set the value of output parameter to NULL if you do not need to read it.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>index</td><td><tt>[in]</tt> </td><td>parameter index (starting by zero) </td></tr><tr><td>key</td><td><tt>[out]</tt> </td><td>parameter name (can be NULL) </td></tr><tr><td>val</td><td><tt>[out]</tt> </td><td>parameter value (can be NULL) </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure</p><h2>cmpack_tab_dkey (function)</h2><p>Delete parameter from file header.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_dkey (CmpackTable * tab, const char * key)</p><h3>Description</h3><p>Keys are case sensitive.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>key</td><td><tt>[in]</tt> </td><td>parameter name </td></tr></table><h2>cmpack_tab_ncolumns (function)</h2><p>Get number of columns.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_ncolumns (CmpackTable * tab)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr></table><h3>Return value</h3><p>number of columns or zero if the table is not valid context or if it is empty.</p><h2>cmpack_tab_add_column (function)</h2><p>Append new column to the table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_add_column (CmpackTable * tab, const char * name, CmpackColumnType type, int prec)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>name</td><td><tt>[in]</tt> </td><td>column name </td></tr><tr><td>type</td><td><tt>[in]</tt> </td><td>data type </td></tr><tr><td>prec</td><td><tt>[in]</tt> </td><td>number of places after the decimal point </td></tr></table><h3>Return value</h3><p>index of new column or negative value on failure</p><h2>cmpack_tab_get_column (function)</h2><p>Get column by its index.</p><h3>Synopsis</h3><p class="synopsis">CmpackTabColumn * cmpack_tab_get_column (CmpackTable * tab, int index)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>index</td><td><tt>[in]</tt> </td><td>column index </td></tr></table><h3>Return value</h3><p>new reference to table column</p><h2>cmpack_tab_find_column (function)</h2><p>Find column by its name.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_find_column (CmpackTable * tab, const char * name)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>name</td><td><tt>[in]</tt> </td><td>column name </td></tr></table><h3>Return value</h3><p>index of table column or negative value on failure</p><h2>cmpack_tab_column_set_name (function)</h2><p>Set column name.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_column_set_name (CmpackTabColumn * col, const char * name)</p><h3>Description</h3><p>The function returns pointer to the internal structure. You must not call the cmpack_free() function to it.</p><h3>Parameters</h3><table><tr><td>col</td><td><tt>[in]</tt> </td><td>column context </td></tr><tr><td>name</td><td><tt>[in]</tt> </td><td>new column name </td></tr></table><h2>cmpack_tab_column_get_name (function)</h2><p>Get column name.</p><h3>Synopsis</h3><p class="synopsis">const char * cmpack_tab_column_get_name (CmpackTabColumn * col)</p><h3>Description</h3><p>The function returns pointer to the internal structure. You must not call the cmpack_free() function to it.</p><h3>Parameters</h3><table><tr><td>col</td><td><tt>[in]</tt> </td><td>column context </td></tr></table><h3>Return value</h3><p>pointer to the column name</p><h2>cmpack_tab_nrows (function)</h2><p>Get number of rows in the table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_nrows (CmpackTable * tab)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr></table><h3>Return value</h3><p>If context is not valid or contains no data, returns zero</p><h2>cmpack_tab_add_row (function)</h2><p>Append a new row to the table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_add_row (CmpackTable * tab)</p><h3>Description</h3><p>The function appends a new row to the end of the table</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr></table><h3>Return value</h3><p>index of new row or negative number on failure</p><h2>cmpack_tab_ptds (function)</h2><p>Set table data (string).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_ptds (CmpackTable * tab, int row, int col, const char * val)</p><h3>Description</h3><p>The function modifies table data in specified row and column.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>new value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure.</p><h2>cmpack_tab_ptdi (function)</h2><p>Set table data (integer).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_ptdi (CmpackTable * tab, int row, int col, int val)</p><h3>Description</h3><p>The function modifies table data in specified row and column.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>new value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure.</p><h2>cmpack_tab_ptdd (function)</h2><p>Set table data (real number).</p><h3>Synopsis</h3><p class="synopsis">void cmpack_tab_ptdd (CmpackTable * tab, int row, int col, double val)</p><h3>Description</h3><p>The function modifies table data in specified row and column.</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[in]</tt> </td><td>new value </td></tr></table><h3>Return value</h3><p>zero on success, error code on failure.</p><h2>cmpack_tab_gtds (function)</h2><p>Get table data (string).</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_gtds (CmpackTable * tab, int row, int col, char ** val)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[out]</tt> </td><td>pointer to internal buffer </td></tr></table><h3>Return value</h3><p>nonzero on success, zero on failure</p><h2>cmpack_tab_gtdi (function)</h2><p>Get table data (integer).</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_gtdi (CmpackTable * tab, int row, int col, int * val)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[out]</tt> </td><td>value </td></tr></table><h3>Return value</h3><p>nonzero on success, zero on failure</p><h2>cmpack_tab_gtdd (function)</h2><p>Get table data (double).</p><h3>Synopsis</h3><p class="synopsis">int cmpack_tab_gtdd (CmpackTable * tab, int row, int col, double * val)</p><h3>Parameters</h3><table><tr><td>tab</td><td><tt>[in]</tt> </td><td>table context </td></tr><tr><td>row</td><td><tt>[in]</tt> </td><td>row index </td></tr><tr><td>col</td><td><tt>[in]</tt> </td><td>column index </td></tr><tr><td>val</td><td><tt>[out]</tt> </td><td>value </td></tr></table><h3>Return value</h3><p>nonzero on success, zero on failure</p></body></html>
