<!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 flat-frame correction. </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 flat-frame correction. </h1></div><h2>cmpack_flat.h</h2><h3>Type definitions</h3><table><tr><td>CmpackFlatCorr</td><td>Flat-frame correction context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_flat_init</td><td>Make new flat-frame correction context. </td></tr><tr><td>cmpack_flat_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_flat_set_border</td><td>Set image border size. </td></tr><tr><td>cmpack_flat_get_border</td><td>Get image flip flags. </td></tr><tr><td>cmpack_flat_rflat</td><td>Load flat-frame from a file. </td></tr><tr><td>cmpack_flat</td><td>Execute flat-frame correction. </td></tr><tr><td>cmpack_flat_ex</td><td>Execute flat-frame correction. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to apply flat-frame correction to CCD frames.</p><h2>CmpackFlatCorr (data type)</h2><p>Flat-frame correction context.</p><h3>Synopsis</h3><p>typedef struct _CmpackFlatCorr CmpackFlatCorr</p><h3>Description</h3><p>This private data structure holds the parameter for flat-frame correction as well as the flat frame itself.</p><h2>cmpack_flat_init (function)</h2><p>Make new flat-frame correction context.</p><h3>Synopsis</h3><p class="synopsis">CmpackFlatCorr * cmpack_flat_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 the new flat frame context or zero on failure</p><h2>cmpack_flat_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_flat_set_console (CmpackFlatCorr * 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>flat correction context </td></tr><tr><td>con</td><td><tt>[in]</tt> </td><td>console context </td></tr></table><h2>cmpack_flat_set_border (function)</h2><p>Set image border size.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_flat_set_border (CmpackFlatCorr * 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>flat correction context </td></tr><tr><td>border</td><td><tt>[in]</tt> </td><td>border size in pixels </td></tr></table><h2>cmpack_flat_get_border (function)</h2><p>Get image flip flags.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_flat_get_border (CmpackFlatCorr * ctx, CmpackBorder * border)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>flat correction context </td></tr><tr><td>border</td><td><tt>[out]</tt> </td><td>border size in pixels </td></tr></table><h2>cmpack_flat_rflat (function)</h2><p>Load flat-frame from a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_flat_rflat (CmpackFlatCorr * ctx, CmpackCcdFile * flatfile)</p><h3>Description</h3><p>The function reads the correction frame from the given frame context. The internal copy of the image data is made, no reference to the frame is held, so you can free it when this function has returned.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>flat correction context </td></tr><tr><td>flatfile</td><td><tt>[in]</tt> </td><td>bias frame context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_flat (function)</h2><p>Execute flat-frame correction.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_flat (CmpackFlatCorr * ctx, CmpackCcdFile * file)</p><h3>Description</h3><p>The function reads image data from the context, performs the flat correction and stores the output image to the same context.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>flat correction context </td></tr><tr><td>file</td><td><tt>[inout]</tt> </td><td>frame context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_flat_ex (function)</h2><p>Execute flat-frame correction.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_flat_ex (CmpackFlatCorr * ctx, CmpackCcdFile * infile, CmpackCcdFile * outfile)</p><h3>Description</h3><p>The function reads image data from the infile context, performs the flat correction and stores the output image to the outfile context.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>flat correction context </td></tr><tr><td>infile</td><td><tt>[in]</tt> </td><td>input frame context </td></tr><tr><td>outfile</td><td><tt>[in]</tt> </td><td>output frame context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p></body></html>
