<!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 dark-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 dark-frame correction. </h1></div><h2>cmpack_dark.h</h2><h3>Type definitions</h3><table><tr><td>CmpackDarkCorr</td><td>Dark-frame correction context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_dark_init</td><td>Make new dark-frame correction context. </td></tr><tr><td>cmpack_dark_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_dark_set_scaling</td><td>Enable or disable dark-frame scaling. </td></tr><tr><td>cmpack_dark_get_scaling</td><td>Get status of dark-frame scaling. </td></tr><tr><td>cmpack_dark_set_border</td><td>Set image border size. </td></tr><tr><td>cmpack_dark_get_border</td><td>Get image flip flags. </td></tr><tr><td>cmpack_dark_rdark</td><td>Load dark-frame from a file. </td></tr><tr><td>cmpack_dark</td><td>Execute dark-frame correction on a file. </td></tr><tr><td>cmpack_dark_ex</td><td>Execute dark-frame correction on a file. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to apply dark-frame correction to CCD frames.</p><h2>CmpackDarkCorr (data type)</h2><p>Dark-frame correction context.</p><h3>Synopsis</h3><p>typedef struct _CmpackDarkCorr CmpackDarkCorr</p><h3>Description</h3><p>This private data structure holds the parameter for dark-frame correction as well as the dark frame itself.</p><h2>cmpack_dark_init (function)</h2><p>Make new dark-frame correction context.</p><h3>Synopsis</h3><p class="synopsis">CmpackDarkCorr * cmpack_dark_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_dark_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_dark_set_console (CmpackDarkCorr * 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_dark_set_scaling (function)</h2><p>Enable or disable dark-frame scaling.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_dark_set_scaling (CmpackDarkCorr * ctx, int scaling)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>air-mass computation context </td></tr><tr><td>scaling</td><td><tt>[in]</tt> </td><td>0 = disable, 1 = enable feature </td></tr></table><h2>cmpack_dark_get_scaling (function)</h2><p>Get status of dark-frame scaling.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_dark_get_scaling (CmpackDarkCorr * ctx)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>air-mass computation context </td></tr></table><h3>Return value</h3><p>zero = disabled, nonzero = enabled</p><h2>cmpack_dark_set_border (function)</h2><p>Set image border size.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_dark_set_border (CmpackDarkCorr * file, 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>file</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_dark_get_border (function)</h2><p>Get image flip flags.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_dark_get_border (CmpackDarkCorr * file, CmpackBorder * border)</p><h3>Parameters</h3><table><tr><td>file</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_dark_rdark (function)</h2><p>Load dark-frame from a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_dark_rdark (CmpackDarkCorr * ctx, CmpackCcdFile * darkfile)</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>dark-frame correction context </td></tr><tr><td>darkfile</td><td><tt>[in]</tt> </td><td>dark frame context </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_dark (function)</h2><p>Execute dark-frame correction on a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_dark (CmpackDarkCorr * ctx, CmpackCcdFile * file)</p><h3>Description</h3><p>The function reads image data from the context, performs the dark 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>dark-frame 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_dark_ex (function)</h2><p>Execute dark-frame correction on a file.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_dark_ex (CmpackDarkCorr * ctx, CmpackCcdFile * infile, CmpackCcdFile * outfile)</p><h3>Description</h3><p>The function reads image data from the infile context, performs the dark 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>dark-frame 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>
