<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN"> <html><head> <link rel="stylesheet" type="text/css" href="cmunipack.css"> <title>Functions for making photometry files. </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 making photometry files. </h1></div><h2>cmpack_phot.h</h2><h3>Type definitions</h3><table><tr><td>CmpackPhot</td><td>Configuration context for the Photometry tool. </td></tr></table><h3>Functions</h3><table><tr><td>cmpack_phot_init</td><td>Make new photometry configuration context. </td></tr><tr><td>cmpack_phot_set_console</td><td>Attach console to the context. </td></tr><tr><td>cmpack_phot_set_rnoise</td><td>Set readout noise level. </td></tr><tr><td>cmpack_phot_get_rnoise</td><td>Get readout noise level. </td></tr><tr><td>cmpack_phot_set_adcgain</td><td>Set ADC gain. </td></tr><tr><td>cmpack_phot_get_adcgain</td><td>Get ADC gain. </td></tr><tr><td>cmpack_phot_set_minval</td><td>Set threshold for bad pixels. </td></tr><tr><td>cmpack_phot_get_minval</td><td>Get threshold for bad pixels. </td></tr><tr><td>cmpack_phot_set_maxval</td><td>Set threshold for overexposed pixels. </td></tr><tr><td>cmpack_phot_get_maxval</td><td>Get threshold for overexposed pixels. </td></tr><tr><td>cmpack_phot_set_fwhm</td><td>Set expected value of FWHM of objects. </td></tr><tr><td>cmpack_phot_get_fwhm</td><td>Get expected value of FWHM of objects. </td></tr><tr><td>cmpack_phot_set_thresh</td><td>Set detection threshold. </td></tr><tr><td>cmpack_phot_get_thresh</td><td>Get detection threshold. </td></tr><tr><td>cmpack_phot_set_minshrp</td><td>Set min. </td></tr><tr><td>cmpack_phot_get_minshrp</td><td>Get min. </td></tr><tr><td>cmpack_phot_set_maxshrp</td><td>Set max. </td></tr><tr><td>cmpack_phot_get_maxshrp</td><td>Get max. </td></tr><tr><td>cmpack_phot_set_minrnd</td><td>Set min. </td></tr><tr><td>cmpack_phot_get_minrnd</td><td>Get min. </td></tr><tr><td>cmpack_phot_set_maxrnd</td><td>Set max. </td></tr><tr><td>cmpack_phot_get_maxrnd</td><td>Get max. </td></tr><tr><td>cmpack_phot_set_border</td><td>Set image border size. </td></tr><tr><td>cmpack_phot_get_border</td><td>Get image flip flags. </td></tr><tr><td>cmpack_phot_set_skyin</td><td>Set inner radius of the sky annulus. </td></tr><tr><td>cmpack_phot_get_skyin</td><td>Get inner radius of the sky annulus. </td></tr><tr><td>cmpack_phot_set_skyout</td><td>Set outer radius of the sky annulus. </td></tr><tr><td>cmpack_phot_get_skyout</td><td>Get outer radius of the sky annulus. </td></tr><tr><td>cmpack_phot_set_aper</td><td>Set apertures. </td></tr><tr><td>cmpack_phot_get_aper</td><td>Get apertures. </td></tr><tr><td>cmpack_phot</td><td>Make photometry file from a calibrated CCD frame. </td></tr></table><h3>Description</h3><p>Set of functions defined in this module allows user to make a photometry file from a CCD frame.</p><h2>CmpackPhot (data type)</h2><p>Configuration context for the Photometry tool.</p><h3>Synopsis</h3><p>typedef struct _CmpackPhot CmpackPhot</p><h3>Description</h3><p>This private data structure holds the configuration parameters for the photometry.</p><h2>cmpack_phot_init (function)</h2><p>Make new photometry configuration context.</p><h3>Synopsis</h3><p class="synopsis">CmpackPhot * cmpack_phot_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_phot_set_console (function)</h2><p>Attach console to the context.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_console (CmpackPhot * 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_phot_set_rnoise (function)</h2><p>Set readout noise level.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_rnoise (CmpackPhot * file, double rnoise)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>rnoise</td><td><tt>[in]</tt> </td><td>readout noise </td></tr></table><h2>cmpack_phot_get_rnoise (function)</h2><p>Get readout noise level.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_rnoise (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of readout noise level</p><h2>cmpack_phot_set_adcgain (function)</h2><p>Set ADC gain.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_adcgain (CmpackPhot * file, double adcgain)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>adcgain</td><td><tt>[in]</tt> </td><td>ADC gain </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_adcgain (function)</h2><p>Get ADC gain.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_adcgain (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current ADC gain</p><h2>cmpack_phot_set_minval (function)</h2><p>Set threshold for bad pixels.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_minval (CmpackPhot * file, double minval)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>minval</td><td><tt>[in]</tt> </td><td>minimal valid value in ADU </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_minval (function)</h2><p>Get threshold for bad pixels.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_minval (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>minimal valid value in ADU</p><h2>cmpack_phot_set_maxval (function)</h2><p>Set threshold for overexposed pixels.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_maxval (CmpackPhot * file, double maxval)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>maxval</td><td><tt>[in]</tt> </td><td>maximal valid value in ADU + 1 </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_maxval (function)</h2><p>Get threshold for overexposed pixels.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_maxval (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of threshold for overexposed pixels</p><h2>cmpack_phot_set_fwhm (function)</h2><p>Set expected value of FWHM of objects.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_fwhm (CmpackPhot * file, double fwhm)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>fwhm</td><td><tt>[in]</tt> </td><td>FWHM in pixels </td></tr></table><h2>cmpack_phot_get_fwhm (function)</h2><p>Get expected value of FWHM of objects.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_fwhm (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>FWHM in pixels</p><h2>cmpack_phot_set_thresh (function)</h2><p>Set detection threshold.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_thresh (CmpackPhot * file, double thresh)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>thresh</td><td><tt>[in]</tt> </td><td>threshold </td></tr></table><h2>cmpack_phot_get_thresh (function)</h2><p>Get detection threshold.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_thresh (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>threshold</p><h2>cmpack_phot_set_minshrp (function)</h2><p>Set min.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_minshrp (CmpackPhot * file, double minshrp)</p><h3>Description</h3><p>sharpness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>minshrp</td><td><tt>[in]</tt> </td><td>threshold </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_minshrp (function)</h2><p>Get min.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_minshrp (CmpackPhot * file)</p><h3>Description</h3><p>sharpness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of min. sharpness threshold</p><h2>cmpack_phot_set_maxshrp (function)</h2><p>Set max.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_maxshrp (CmpackPhot * file, double maxshrp)</p><h3>Description</h3><p>sharpness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>maxshrp</td><td><tt>[in]</tt> </td><td>threshold </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_maxshrp (function)</h2><p>Get max.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_maxshrp (CmpackPhot * file)</p><h3>Description</h3><p>sharpness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of max. sharpness threshold</p><h2>cmpack_phot_set_minrnd (function)</h2><p>Set min.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_minrnd (CmpackPhot * file, double minrnd)</p><h3>Description</h3><p>roundness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>minrnd</td><td><tt>[in]</tt> </td><td>threshold </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_minrnd (function)</h2><p>Get min.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_minrnd (CmpackPhot * file)</p><h3>Description</h3><p>roundness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of min. roundness threshold</p><h2>cmpack_phot_set_maxrnd (function)</h2><p>Set max.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_maxrnd (CmpackPhot * file, double maxrnd)</p><h3>Description</h3><p>roundness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>maxrnd</td><td><tt>[in]</tt> </td><td>threshold </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_maxrnd (function)</h2><p>Get max.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_maxrnd (CmpackPhot * file)</p><h3>Description</h3><p>roundness threshold</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of max. roundness threshold</p><h2>cmpack_phot_set_border (function)</h2><p>Set image border size.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_border (CmpackPhot * 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_phot_get_border (function)</h2><p>Get image flip flags.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_get_border (CmpackPhot * 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_phot_set_skyin (function)</h2><p>Set inner radius of the sky annulus.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_skyin (CmpackPhot * file, double skyin)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>skyin</td><td><tt>[in]</tt> </td><td>radius in pixels </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_skyin (function)</h2><p>Get inner radius of the sky annulus.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_skyin (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of inner radius of the sky annulus</p><h2>cmpack_phot_set_skyout (function)</h2><p>Set outer radius of the sky annulus.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_skyout (CmpackPhot * file, double skyout)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>skyout</td><td><tt>[in]</tt> </td><td>radius in pixels </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_skyout (function)</h2><p>Get outer radius of the sky annulus.</p><h3>Synopsis</h3><p class="synopsis">double cmpack_phot_get_skyout (CmpackPhot * file)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr></table><h3>Return value</h3><p>current value of outer radius of the sky annulus</p><h2>cmpack_phot_set_aper (function)</h2><p>Set apertures.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_set_aper (CmpackPhot * file, const double * items, int nitems)</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>items</td><td><tt>[in]</tt> </td><td>table of aperture radii </td></tr><tr><td>nitems</td><td><tt>[in]</tt> </td><td>number of apertures </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot_get_aper (function)</h2><p>Get apertures.</p><h3>Synopsis</h3><p class="synopsis">void cmpack_phot_get_aper (CmpackPhot * file, double ** items, int * nitems)</p><h3>Description</h3><p>The function makes copy of the data and returns the pointer to it. The caller is reponsible to free the memory by means of the cmpack_free() method.</p><h3>Parameters</h3><table><tr><td>file</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>items</td><td><tt>[out]</tt> </td><td>table of aperture radii </td></tr><tr><td>nitems</td><td><tt>[out]</tt> </td><td>number of apertures </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p><h2>cmpack_phot (function)</h2><p>Make photometry file from a calibrated CCD frame.</p><h3>Synopsis</h3><p class="synopsis">int cmpack_phot (CmpackPhot * ctx, CmpackCcdFile * infile, CmpackPhtFile * outfile, int * nstars)</p><h3>Description</h3><p>The function reads input frame, finds stars and determine their brightness. The result is stored in the photometry file.</p><h3>Parameters</h3><table><tr><td>ctx</td><td><tt>[in]</tt> </td><td>photometry configuration context </td></tr><tr><td>infile</td><td><tt>[in]</tt> </td><td>input file context </td></tr><tr><td>outfile</td><td><tt>[in]</tt> </td><td>output file context </td></tr><tr><td>nstars</td><td><tt>[out]</tt> </td><td>number of stars detected </td></tr></table><h3>Return value</h3><p>zero on success or error code on failure</p></body></html>
