C-Munipack 1.2 / Application programming interface / API reference

Functions for the making mag-dev graph.

cmpack_mfind.h

Defines

CMPACK_MFIND_AUTO

Type definitions

CmpackMuniFindMunifind context.

Functions

cmpack_mfind_initMake new context for the Munifind tool.
cmpack_mfind_set_consoleAttach console to the context.
cmpack_mfind_get_comparisonGet comparison star.
cmpack_mfind_set_thresholdSet clipping threshold.
cmpack_mfindMake mag-dev graph.

Description

Set of functions defined in this module allows user to make a mag-dev graph, that is used to find variable stars in a viewfield.

CmpackMuniFind (data type)

Munifind context.

Synopsis

typedef struct _CmpackMuniFind CmpackMuniFind

Description

This private data structure holds information needed to build the mag-dev graph.

cmpack_mfind_init (function)

Make new context for the Munifind tool.

Synopsis

CmpackMuniFind * cmpack_mfind_init (void)

Description

The reference counter is set to one. The caller is responsible to call cmpack_unref() when it is no longer needed.

Return value

pointer to context or zero on failure

cmpack_mfind_set_console (function)

Attach console to the context.

Synopsis

void cmpack_mfind_set_console (CmpackMuniFind * ctx, CmpackConsole * con)

Description

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.

Parameters

ctx[in] munifind context
con[in] console context

cmpack_mfind_get_comparison (function)

Get comparison star.

Synopsis

int cmpack_mfind_get_comparison (CmpackMuniFind * ctx)

Parameters

ctx[in] munifind context

Return value

identifier of the comparison star or negative value on error

cmpack_mfind_set_threshold (function)

Set clipping threshold.

Synopsis

void cmpack_mfind_set_threshold (CmpackMuniFind * ctx, double threshold)

Parameters

ctx[in] munifind context
threshold[in] threshold in %

cmpack_mfind (function)

Make mag-dev graph.

Synopsis

int cmpack_mfind (CmpackMuniFind * ctx, CmpackAllFile * file, CmpackTable * table, int comp_star)

Description

The result is stored to a given table

Parameters

ctx[in] munifind context
file[in] readall file
table[out] table with results
comp_star[in] comparison star id or CMPACK_MFIND_AUTO

Return value

zero on success or error code on failure.