C-Munipack 1.2 / Application programming interface / API reference
C-Munipack 1.2 / Application programming interface / API reference
CmpackListFormat | Output format identifiers. |
CmpackLister | Listing process context. |
cmpack_list_init | Make new listing context. |
cmpack_list_set_console | Attach console to the context. |
cmpack_list_set_aperture | Set aperture index. |
cmpack_list_get_aperture | Get aperture index. |
cmpack_list_set_var | Set list of variable stars. |
cmpack_list_set_comp | Set list of comparison stars. |
cmpack_list_set_check | Set list of check stars. |
cmpack_list_open | Start listing to a table. |
cmpack_list_read | Read single frame from a photometry file and process it. |
cmpack_list_close | Flush all data, close reading sequence. |
Set of functions defined in this module allows user to read a set of information from photometry files and make output file (a light curve, a track list, ...)
Listing process context.
typedef struct _CmpackLister CmpackLister
This private data structure holds the temporary data, which are used during listing process.
Output format identifiers.
enum CmpackListFormat
{
CMPACK_LIST_DIFFMAG,
CMPACK_LIST_INSTMAG,
CMPACK_LIST_TRACKLST,
CMPACK_LIST_STDDEV
};
CMPACK_LIST_DIFFMAG | Differential magnitudes (default). |
CMPACK_LIST_INSTMAG | Instrumental magnitudes. |
CMPACK_LIST_TRACKLST | Track list. |
CMPACK_LIST_STDDEV | Standard deviations. |
Make new listing context.
CmpackLister * cmpack_list_init (void)
The reference counter is set to one. The caller is responsible to call cmpack_unref() when it is no longer needed.
pointer to context or zero on failure
Attach console to the context.
void cmpack_list_set_console (CmpackLister * ctx, CmpackConsole * con)
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.
ctx | [in] | air-mass computation context |
con | [in] | console context |
Set aperture index.
void cmpack_list_set_aperture (CmpackLister * proc, int index)
proc | [in] | listing context |
index | [in] | aperture index (starts by 1) |
Get aperture index.
int cmpack_list_get_aperture (CmpackLister * proc)
proc | [in] | listing context |
aperture index (starts by 1)
Set list of variable stars.
void cmpack_list_set_var (CmpackLister * proc, const int * items, int nitems)
proc | [in] | listing context |
items | [in] | array of star identifiers |
nitems | [in] | number of items |
Set list of comparison stars.
void cmpack_list_set_comp (CmpackLister * proc, const int * items, int nitems)
proc | [in] | listing context |
items | [in] | array of star identifiers |
nitems | [in] | number of items |
Set list of check stars.
void cmpack_list_set_check (CmpackLister * proc, const int * items, int nitems)
proc | [in] | listing context |
items | [in] | array of star identifiers |
nitems | [in] | number of items |
Start listing to a table.
int cmpack_list_open (CmpackLister * proc, CmpackTable * table, CmpackListFormat format, int flags)
The function clears the content of the table, sets its columns. Use cmpack_list_close() to finish the operation. If the 'table' parameter is NULL, it makes a new table instance. You can get the pointer to it by calling the cmpack_list_get_table function.
proc | [in] | listing process context |
table | [in] | table context |
format | [in] | output format |
flags | [in] | flags |
zero on success or error code on failure
Read single frame from a photometry file and process it.
int cmpack_list_read (CmpackLister * proc, CmpackPhtFile * file, int frame)
proc | [in] | listing process context |
file | [in] | matched photometry file context |
frame | [in] | frame ordinal number |
zero on success or error code on failure
Flush all data, close reading sequence.
int cmpack_list_close (CmpackLister * proc)
The function finishes up the computation of output data.
proc | [in] | listing process context |
zero on success or error code on failure