1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/**
\file
\brief Functions for the making master-flat correction frame
Set of functions defined in this module allows user to
make a master-flat frame from a set of CCD frames.
\author David Motl <dmotl@volny.cz>
\par Copying
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, version 2.
$Id: cmpack_mflat.h,v 1.1 2015/07/06 08:33:22 dmotl Exp $
*/
#ifndef _CMPACK_MFLAT_H_INCLUDED
#define _CMPACK_MFLAT_H_INCLUDED
#include "cmpack_common.h"
#include "cmpack_console.h"
#include "cmpack_ccdfile.h"
/******************** Private data structures ********************************/
/**
\brief Master-flat output frame context
\details This private data structure holds information needed to build
one master-flat frame.
*/
typedef struct _CmpackMasterFlat CmpackMasterFlat;
/******************** Public functions ********************************/
#ifdef __cplusplus
extern "C" {
#endif
/**
\brief Make new master-flat computation context
\details The function allocates memory with master-flat computation context
and returns a new reference to it. The reference counter is set to one.
The caller is responsible to call cmpack_mflat_destroy() when it is no longer
needed.
\return pointer to the new master-flat context or zero on failure
*/
CMPACK_EXPORT(CmpackMasterFlat*, cmpack_mflat_init, (void));
/**
\brief Make a new reference to the master-flat computation context
\details The function makes a new reference to the context and returns a
pointer to it. The reference counter is incremented by one. The caller
is responsible to call cmpack_mflat_destroy() when the reference is
no longer needed.
\return pointer to a new reference
*/
CMPACK_EXPORT(CmpackMasterFlat*, cmpack_mflat_reference, (CmpackMasterFlat* ctx));
/**
\brief Release a reference to the master-flat computation context
\details The function releases a reference to the context.
The reference counter is decreased by one and when it was the
last reference to the context, the context is freed and all memory
allocated in the context is reclaimed.
*/
CMPACK_EXPORT(void, cmpack_mflat_destroy, (CmpackMasterFlat* ctx));
/**
\brief Attach console to the master-dark computation context
\details The function connects a master-bias computation context with
a console context. The console is designed to print the information
during the data processing. The functions makes its own reference
to the console. Only one console can be attached to a single context,
if another console is attached to the single context, the original
one is released. Set console to NULL to release a reference to the
console that is currently attached to the context.
\param[in] ctx master-flat context
\param[in] con console context
*/
CMPACK_EXPORT(void, cmpack_mflat_set_console, (CmpackMasterFlat* ctx, CmpackConsole* con));
/**
\brief Set output data format
\details The function sets the format of the output CCD frame. If
the format is set to CMPACK_BITPIX_AUTO (default), the format of the first
source frame is used. Otherwise, the image data are converted into
specified format.
\param[in] ctx master-flat context
\param[in] bitpix output data format
*/
CMPACK_EXPORT(void, cmpack_mflat_set_bitpix, (CmpackMasterFlat* ctx, CmpackBitpix bitpix));
/**
\brief Get output data format
\param[in] ctx master-flat context
\return current image data format
*/
CMPACK_EXPORT(CmpackBitpix, cmpack_mflat_get_bitpix, (CmpackMasterFlat* ctx));
/**
\brief Set output level for the normalization of the master-flat frame
\details The functions sets the mean level of the output frame frame.
The deffault value is 10000.
\param[in] ctx master-flat context
\param[in] level mean level in ADU
*/
CMPACK_EXPORT(void, cmpack_mflat_set_level, (CmpackMasterFlat* ctx, double level));
/**
\brief Get normalization level
\param[in] ctx master-flat context
\return mean output level in ADU
*/
CMPACK_EXPORT(double, cmpack_mflat_get_level, (CmpackMasterFlat* ctx));
/**
\brief Set image border size
\details The function sets the size of CCD frame borders. The pixels
inside the frame borders are set always to zero. You can use this feature
to clear an unusable part of a frame.
\param[in] ctx master-flat context
\param[in] border border size in pixels
*/
CMPACK_EXPORT(void, cmpack_mflat_set_border, (CmpackMasterFlat* ctx, const CmpackBorder* border));
/**
\brief Get image border size
\details The function returns current border size
\param[in] ctx master-bias context
\param[out] border border size in pixels
*/
CMPACK_EXPORT(void, cmpack_mflat_get_border, (CmpackMasterFlat* ctx, CmpackBorder* border));
/**
\brief Set pixel value thresholds
\details The function sets the value of two thresholds that determine
valid pixel values. Pixels of value <= minvalue are treated as bad pixels,
pixels of value >= maxvalue are treated as overexposed pixels.
\param[in] ctx bias correction context
\param[in] minvalue bad pixel threshold
\param[in] maxvalue overexposed pixel threshold
*/
CMPACK_EXPORT(void, cmpack_mflat_set_thresholds, (CmpackMasterFlat* ctx, double minvalue, double maxvalue));
/**
\brief Set threshold for "invalid" pixel value
\details The function sets the value of threshold that determines
valid pixel values. Pixels of value <= minvalue are treated as bad pixels.
\param[in] ctx master-bias context
\param[in] minvalue bad pixel threshold
*/
CMPACK_EXPORT(void, cmpack_mflat_set_minvalue, (CmpackMasterFlat* ctx, double minvalue));
/**
\brief Get threshold for "invalid" pixel values
\param[in] ctx master-bias context
\return pixel value
*/
CMPACK_EXPORT(double, cmpack_mflat_get_minvalue, (CmpackMasterFlat* ctx));
/**
\brief Set threshold for "overexposed" pixels
\details The function sets the value of threshold that determines
valid pixel values. Pixels of value >= maxvalue are treated as overexposed pixels.
\param[in] ctx master-bias context
\param[in] maxvalue overexposed pixel threshold
*/
CMPACK_EXPORT(void, cmpack_mflat_set_maxvalue, (CmpackMasterFlat* ctx, double maxvalue));
/**
\brief Get threshold for "overexposed" pixels
\param[in] ctx master-bias context
\return pixel value
*/
CMPACK_EXPORT(double, cmpack_mflat_get_maxvalue, (CmpackMasterFlat* ctx));
/**
\brief Open output file
\details The function clears the image buffers in the context and initializes
the output file. After calling this function, you can process the source
frames by calling the cmpack_mflat_read() function. It is necessary to
finish the operation by calling the cmpack_mflat_close() function.
\param[in] ctx master-flat context
\param[in] outfile output file context
\return zero on success or error code on failure.
*/
CMPACK_EXPORT(int, cmpack_mflat_open, (CmpackMasterFlat* ctx, CmpackCcdFile* outfile));
/**
\brief Add a frame to the accumulation buffer
\details The function reads the frame from specified CCD-frame
file into memory.
\param[in] ctx master-flat context
\param[in] infile input file context
\return zero on success or error code on failure.
*/
CMPACK_EXPORT(int, cmpack_mflat_read, (CmpackMasterFlat* ctx, CmpackCcdFile* infile));
/**
\brief Make master-flat frame and save it to the file
\details The function computes the output CCD data, writes it to the
output file.
\param[in] ctx master-flat context
\return zero on success or error code on failure.
*/
CMPACK_EXPORT(int, cmpack_mflat_close, (CmpackMasterFlat* ctx));
#ifdef __cplusplus
}
#endif
#endif
|
