<!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 heliocentric 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 heliocentric correction. </h1></div><h2>cmpack_hcorr.h</h2><h3>Enumerations</h3><table><tr><td>CmpackHCorrFlags</td><td>Correction flags. </td></tr></table><h3>Type definitions</h3><table><tr><td>CmpackHelCorr</td><td>Heliocentric correction context. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_hcorr_init</td><td>Make new heliocentric correction context. </td></tr><tr><td>cmpack_hcorr_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_hcorr_set_ra</td><td>Set object's right ascension. </td></tr><tr><td>cmpack_hcorr_get_ra</td><td>Get object's right ascension. </td></tr><tr><td>cmpack_hcorr_set_dec</td><td>Set object's declination. </td></tr><tr><td>cmpack_hcorr_get_dec</td><td>Get object's declination. </td></tr><tr><td>cmpack_hcorr</td><td>Make heliocentric correction of data stored in a table. </td></tr><tr><td>cmpack_hcorr_jd</td><td>Compute heliocentric correction for single julian date. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to apply heliocentric correction to light-curve data files.</p><h2>CmpackHelCorr (data type)</h2><p>Heliocentric correction context.</p><h3>Synopsis</h3><p>typedef struct _CmpackHelCorr CmpackHelCorr</p><h3>Description</h3><p>This private data structure holds the parameter for heliocentric correction.</p><h2>CmpackHCorrFlags (enumeration)</h2><p>Correction flags.</p><h3>Synopsis</h3><p class="synopsis">enum CmpackHCorrFlags<br>{<br> CMPACK_HCORR_DEFAULT = 0,<br> CMPACK_HCORR_REVERSE = (1<<0),<br> CMPACK_HCORR_ADDVALUE = (1<<1),<br> CMPACK_HCORR_NOMODIFY = (1<<2)<br>};<h3>Enumerators</h3><table><tr><td>CMPACK_HCORR_DEFAULT</td><td>Default behavior. </td></tr><tr><td>CMPACK_HCORR_REVERSE</td><td>JD is heliocentric, compute geocentric JD. </td></tr><tr><td>CMPACK_HCORR_ADDVALUE</td><td>Add value of hel. </td></tr><tr><td>CMPACK_HCORR_NOMODIFY</td><td>Do not modify values of JD. </td></tr></table><h2>cmpack_hcorr_init (function)</h2><p>Make new heliocentric correction context.</p><h3>Synopsis</h3><p class="synopsis">CmpackHelCorr * cmpack_hcorr_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_hcorr_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_hcorr_set_console (CmpackHelCorr * 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_hcorr_set_ra (function)</h2><p>Set object's right ascension.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_hcorr_set_ra (CmpackHelCorr * ctx, double ra)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>heliocentric correction context </td></tr><tr><td>ra</td><td><tt>[in]</tt> </td><td>right ascension in hours </td></tr></table><h2>cmpack_hcorr_get_ra (function)</h2><p>Get object's right ascension.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_hcorr_get_ra (CmpackHelCorr * ctx, double * ra)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>heliocentric correction context </td></tr><tr><td>ra</td><td><tt>[out]</tt> </td><td>right ascension in hours </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_hcorr_set_dec (function)</h2><p>Set object's declination.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_hcorr_set_dec (CmpackHelCorr * ctx, double dec)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>heliocentric correction context </td></tr><tr><td>dec</td><td><tt>[in]</tt> </td><td>declination in degrees </td></tr></table><h2>cmpack_hcorr_get_dec (function)</h2><p>Get object's declination.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_hcorr_get_dec (CmpackHelCorr * ctx, double * dec)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>heliocentric correction context </td></tr><tr><td>dec</td><td><tt>[out]</tt> </td><td>declination in degrees </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_hcorr (function)</h2><p>Make heliocentric correction of data stored in a table.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_hcorr (CmpackHelCorr * ctx, CmpackTable * table, int column, CmpackHCorrFlags flags)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>correction context </td></tr><tr><td>table</td><td><tt>[in]</tt> </td><td>table </td></tr><tr><td>column</td><td><tt>[in]</tt> </td><td>column containing values of JD </td></tr><tr><td>flags</td><td><tt>[in]</tt> </td><td>see CMPACK_HCORR_xxx constants </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure.</p><h2>cmpack_hcorr_jd (function)</h2><p>Compute heliocentric correction for single julian date.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_hcorr_jd (CmpackHelCorr * ctx, double jd, double * helcor)</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>heliocentric correction context </td></tr><tr><td>jd</td><td><tt>[in]</tt> </td><td>julian date of observation </td></tr><tr><td>helcor</td><td><tt>[out]</tt> </td><td>heliocentric correction in days </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p></body></html>
