<!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 merging (combining) CCD frames. </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 merging (combining) CCD frames. </h1></div><h2>cmpack_kombine.h</h2><h3>Type definitions</h3><table><tr><td>CmpackKombine</td><td>Output frame context for kombine tool. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_kombine_init</td><td>Make new kombine context. </td></tr><tr><td>cmpack_kombine_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_kombine_set_bitpix</td><td>Set output data format. </td></tr><tr><td>cmpack_kombine_get_bitpix</td><td>Get output data format. </td></tr><tr><td>cmpack_kombine_set_border</td><td>Set image border size. </td></tr><tr><td>cmpack_kombine_get_border</td><td>Get image flip flags. </td></tr><tr><td>cmpack_kombine_open</td><td>Open output file. </td></tr><tr><td>cmpack_kombine_read</td><td>Add a frame to the accumulation buffer. </td></tr><tr><td>cmpack_kombine_close</td><td>Make combined CCD frame and writes it to the file. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to merge (combine) a set of CCD frames.</p><h2>CmpackKombine (data type)</h2><p>Output frame context for kombine tool.</p><h3>Synopsis</h3><p>typedef struct _CmpackKombine CmpackKombine</p><h3>Description</h3><p>This private data structure holds the accumulated data for single output frame.</p><h2>cmpack_kombine_init (function)</h2><p>Make new kombine context.</p><h3>Synopsis</h3><p class="synopsis">CmpackKombine * cmpack_kombine_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 new kombine context or zero on failure</p><h2>cmpack_kombine_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_kombine_set_console (CmpackKombine * 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>kombine context </td></tr><tr><td>con</td><td><tt>[in]</tt> </td><td>console context </td></tr></table><h2>cmpack_kombine_set_bitpix (function)</h2><p>Set output data format.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_kombine_set_bitpix (CmpackKombine * ctx, CmpackBitpix bitpix)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>bitpix</td><td><tt>[in]</tt> </td><td>output data format </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_kombine_get_bitpix (function)</h2><p>Get output data format.</p><h3>Synopsis</h3><p class="synopsis">CmpackBitpix cmpack_kombine_get_bitpix (CmpackKombine * ctx)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>output data format</p><h2>cmpack_kombine_set_border (function)</h2><p>Set image border size.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_kombine_set_border (CmpackKombine * ctx, const CmpackBorder * border)</p><h3>Description</h3><p>If you set the border to nonzero size, the conversion function will set the pixels which belongs to the border area to zero. You can use this feature to clear an unusable part of a frame.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>conversion context </td></tr><tr><td>border</td><td><tt>[in]</tt> </td><td>border size in pixels </td></tr></table><h2>cmpack_kombine_get_border (function)</h2><p>Get image flip flags.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_kombine_get_border (CmpackKombine * ctx, CmpackBorder * border)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>conversion context </td></tr><tr><td>border</td><td><tt>[out]</tt> </td><td>border size in pixels </td></tr></table><h2>cmpack_kombine_open (function)</h2><p>Open output file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_kombine_open (CmpackKombine * ctx, CmpackCcdFile * outfile)</p><h3>Description</h3><p>Opens new combined frame. Close the file by calling the cmpack_kombine_close() function.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>kombine context </td></tr><tr><td>outfile</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure.</p><h2>cmpack_kombine_read (function)</h2><p>Add a frame to the accumulation buffer.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_kombine_read (CmpackKombine * ctx, CmpackCcdFile * ccdfile, CmpackPhtFile * phtfile)</p><h3>Description</h3><p>The function reads the frame from specified CCD-frame file. It reads also the position offset from specified photometry file. Then shifts the frame by the offset and adds it to the accumulation buffer.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>kombine context </td></tr><tr><td>ccdfile</td><td><tt>[in]</tt> </td><td>CCD frame file </td></tr><tr><td>phtfile</td><td><tt>[in]</tt> </td><td>photometry file </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure.</p><h2>cmpack_kombine_close (function)</h2><p>Make combined CCD frame and writes it to the file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_kombine_close (CmpackKombine * ctx)</p><h3>Description</h3><p>The function computes the output CCD data, writes it to the file, closes the output frame.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>kombine context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure.</p></body></html>
