Sophie

Sophie

distrib > Fedora > 15 > x86_64 > by-pkgid > 967d2ab22510ea682c2fd6fd5faeacb3 > files > 215

munipack-1.2.10-2.fc15.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html><head>
<link rel="stylesheet" type="text/css" href="cmunipack.css">
<title>Functions for the making mag-dev graph. </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 the making mag-dev graph. </h1></div><h2>cmpack_mfind.h</h2><h3>Defines</h3><table><tr><td>CMPACK_MFIND_AUTO</td><td></td></tr></table><h3>Type definitions</h3><table><tr><td>CmpackMuniFind</td><td>Munifind context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_mfind_init</td><td>Make new context for the Munifind tool. </td></tr><tr><td>cmpack_mfind_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_mfind_get_comparison</td><td>Get comparison star. </td></tr><tr><td>cmpack_mfind_set_threshold</td><td>Set clipping threshold. </td></tr><tr><td>cmpack_mfind</td><td>Make mag-dev graph. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to make a mag-dev graph, that is used to find variable stars in a viewfield.</p><h2>CmpackMuniFind (data type)</h2><p>Munifind context.</p><h3>Synopsis</h3><p>typedef struct _CmpackMuniFind CmpackMuniFind</p><h3>Description</h3><p>This private data structure holds information needed to build the mag-dev graph.</p><h2>cmpack_mfind_init (function)</h2><p>Make new context for the Munifind tool.</p><h3>Synopsis</h3><p class="synopsis">CmpackMuniFind * cmpack_mfind_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_mfind_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_mfind_set_console (CmpackMuniFind * 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>&nbsp;</td><td>munifind context </td></tr><tr><td>con</td><td><tt>[in]</tt>&nbsp;</td><td>console context </td></tr></table><h2>cmpack_mfind_get_comparison (function)</h2><p>Get comparison star.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_mfind_get_comparison (CmpackMuniFind * ctx)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt>&nbsp;</td><td>munifind context </td></tr></table><h3>Return value</h3><p>identifier of the comparison star or negative value on error</p><h2>cmpack_mfind_set_threshold (function)</h2><p>Set clipping threshold.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_mfind_set_threshold (CmpackMuniFind * ctx, double threshold)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt>&nbsp;</td><td>munifind context </td></tr><tr><td>threshold</td><td><tt>[in]</tt>&nbsp;</td><td>threshold in % </td></tr></table><h2>cmpack_mfind (function)</h2><p>Make mag-dev graph.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_mfind (CmpackMuniFind * ctx, CmpackAllFile * file, CmpackTable * table, int comp_star)</p><h3>Description</h3><p>The result is stored to a given table</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt>&nbsp;</td><td>munifind context </td></tr><tr><td>file</td><td><tt>[in]</tt>&nbsp;</td><td>readall file </td></tr><tr><td>table</td><td><tt>[out]</tt>&nbsp;</td><td>table with results </td></tr><tr><td>comp_star</td><td><tt>[in]</tt>&nbsp;</td><td>comparison star id or CMPACK_MFIND_AUTO </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure.</p></body></html>