C-Munipack 1.2 / Application programming interface / API reference
C-Munipack 1.2 / Application programming interface / API reference
CmpackTimeCorr | Bias-frame correction context. |
cmpack_tcorr_init | Make new time correction context. |
cmpack_tcorr_set_console | Attach console to the context. |
cmpack_tcorr_set_corr | Set time correction. |
cmpack_tcorr_get_corr | Get time correction. |
cmpack_tcorr | Execute time correction on a file. |
cmpack_tcorr_ex | Execute time correction on a file. |
Set of functions defined in this module allows user to apply time correction to CCD frames.
Bias-frame correction context.
typedef struct _CmpackTimeCorr CmpackTimeCorr
This private data structure holds the parameter for time correction as well as the time itself.
Make new time correction context.
CmpackTimeCorr * cmpack_tcorr_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 the new time correction context or zero on failure
Attach console to the context.
void cmpack_tcorr_set_console (CmpackTimeCorr * 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] | time correction context |
con | [in] | console context |
Set time correction.
void cmpack_tcorr_set_corr (CmpackTimeCorr * ctx, double corr)
ctx | [in] | time correction context |
corr | [in] | correction in seconds |
Get time correction.
double cmpack_tcorr_get_corr (CmpackTimeCorr * ctx)
ctx | [in] | time correction context |
current value of time correction in seconds
Execute time correction on a file.
int cmpack_tcorr (CmpackTimeCorr * ctx, CmpackCcdFile * file)
The function reads header data from the file context, performs the time correction and stores the output to the same context.
ctx | [in] | time correction context |
file | [inout] | frame context |
zero on success or error code on failure
Execute time correction on a file.
int cmpack_tcorr_ex (CmpackTimeCorr * ctx, CmpackCcdFile * infile, CmpackCcdFile * outfile)
The function reads header data from the infile context, performs the time correction and stores the output image to the outfile context.
ctx | [in] | time correction context |
infile | [in] | input frame context |
outfile | [in] | output frame context |
zero on success or error code on failure