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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
/*
QHYCCD SDK
Copyright (c) 2014 QHYCCD.
All Rights Reserved.
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; either version 2 of the License, or (at your option)
any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
The full GNU General Public License is included in this distribution in the
file called LICENSE.
*/
/*!
* @file qhy21.h
* @brief QHY21 class define
*/
#include "qhybase.h"
#ifndef __QHY21DEF_H__
#define __QHY21DEF_H__
/**
* @brief QHY21 class define
*
* include all functions for QHY21
*/
class QHY21:public QHYBASE
{
public:
QHY21();
~QHY21();
/**
@fn uint32_t InitChipRegs(qhyccd_handle *h)
@brief Init the registers and some other things
@param h camera control handle
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t InitChipRegs(qhyccd_handle *h);
/**
@fn uint32_t IsChipHasFunction(CONTROL_ID id)
@brief check the camera has the function or not
@param id function id
@return
HAVE return QHYCCD_HAVE \n
NOT HAVE return QHYCCD_NOTHAVE
*/
uint32_t IsChipHasFunction(CONTROL_ID id);
/**
@fn uint32_t SetChipGain(qhyccd_handle *h,double gain)
@brief set the gain to camera
@param h camera control handle
@param gain gain value
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipGain(qhyccd_handle *h,double gain);
/**
@fn uint32_t SetChipExposeTime(qhyccd_handle *h,double i)
@brief set the expose time to camera
@param h camera control handle
@param i expose time value
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipExposeTime(qhyccd_handle *h,double i);
/**
@fn uint32_t SetChipSpeed(qhyccd_handle *h,uint32_t i)
@brief set the transfer speed to camera
@param h camera control handle
@param i speed level
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipSpeed(qhyccd_handle *h,uint32_t i);
/**
@fn uint32_t SetChipOffset(qhyccd_handle *h,double offset)
@brief set the camera offset
@param h camera control handle
@param offset offset value
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipOffset(qhyccd_handle *h,double offset);
/**
@fn uint32_t SetChipBinMode(qhyccd_handle *h,uint32_t wbin,uint32_t hbin)
@brief set the camera offset
@param h camera control handle
@param wbin width bin
@param hbin height bin
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipBinMode(qhyccd_handle *h,uint32_t wbin,uint32_t hbin);
/**
@fn uint32_t SendOrder2CFW(qhyccd_handle *handle,char *order,uint32_t length)
@brief send the command to camera's color filter wheel port
@param handle camera control handle
@param order the color filter position
@param length the order string length
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SendOrder2CFW(qhyccd_handle *handle,char *order,uint32_t length);
/**
@fn uint32_t GetCFWStatus(qhyccd_handle *handle,char *status)
@brief get the color filter wheel status
@param handle camera control handle
@param status the color filter wheel position status
@return
on success,return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t GetCFWStatus(qhyccd_handle *handle,char *status);
/**
@fn uint32_t GetControlMinMaxStepValue(CONTROL_ID controlId,double *min,double *max,double *step)
@brief get the min,max and step value for function
@param controlId the control id
@param min the min value for function
@param max the max value for function
@param step single step value for function
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t GetControlMinMaxStepValue(CONTROL_ID controlId,double *min,double *max,double *step);
/**
@fn double GetChipCoolTemp(qhyccd_handle *h)
@brief get the current ccd/cmos temprature
@param h camera control handle
@return
success return the current cool temprature \n
another QHYCCD_ERROR code on other failures
*/
double GetChipCoolTemp(qhyccd_handle *h);
/**
@fn double GetChipCoolPWM()
@brief get the current ccd/cmos temprature
@return
success return the current cool temprature \n
another QHYCCD_ERROR code on other failures
*/
double GetChipCoolPWM();
/**
@fn uint32_t CorrectWH(uint32_t *w,uint32_t *h)
@brief correct width and height if the setting width or height is not correct
@param w set width
@param h set height
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t CorrectWH(uint32_t *w,uint32_t *h);
/**
@fn double InitBIN11Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize)
@brief init the bin11 mode setting
@param x the image top left x position
@param y the image top left y position
@param xsize the image width
@param ysize the image height
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t InitBIN11Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize);
/**
@fn double InitBIN22Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize)
@brief init the bin22 mode setting
@param x the image top left x position
@param y the image top left y position
@param xsize the image width
@param ysize the image height
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t InitBIN22Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize);
/**
@fn double InitBIN44Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize)
@brief init the bin44 mode setting
@param x the image top left x position
@param y the image top left y position
@param xsize the image width
@param ysize the image height
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t InitBIN44Mode(uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize);
/**
@fn uint32_t SetChipResolution(qhyccd_handle *handle,uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize)
@brief set camera ouput resolution
@param handle camera control handle
@param x the top left position x
@param y the top left position y
@param xsize the image width
@param ysize the image height
@return
on success,return QHYCCD_SUCCESS\n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipResolution(qhyccd_handle *handle,uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize);
/**
@fn uint32_t BeginSingleExposure(qhyccd_handle *h)
@brief begin single exposure
@param h camera control handle
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t BeginSingleExposure(qhyccd_handle *h);
/**
@fn uint32_t CancelExposing(qhyccd_handle *handle)
@param handle camera control handle
@return
on success,return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t CancelExposing(qhyccd_handle *handle);
/**
@fn uint32_t CancelExposingAndReadout(qhyccd_handle *h)
@brief stop single exposure
@param h camera control handle
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t CancelExposingAndReadout(qhyccd_handle *h);
/**
@fn uint32_t GetSingleFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData)
@brief get single frame image data
@param h camera control handle
@param pW real width
@param pH real height
@param pBpp real depth bits
@param pChannels real channels
@param ImgData image data buffer
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t GetSingleFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData);
/**
@fn uint32_t AutoTempControl(qhyccd_handle *h,double ttemp)
@brief auto temprature control
@param h camera control handle
@param ttemp target temprature(degree Celsius)
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t AutoTempControl(qhyccd_handle *h,double ttemp);
/**
@fn uint32_t SetChipCoolPWM(qhyccd_handle *h,double PWM)
@brief set cool power
@param h camera control handle
@param PWM power(0-255)
@return
success return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
uint32_t SetChipCoolPWM(qhyccd_handle *h,double PWM);
/**
@fn void ConvertDataBIN11(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift)
@brief move the pixel raw data to correction position,and bin if need
@param Data raw image data
@param x image width
@param y image height
@param PixShift this is a way to fix the bad pixel data by the usb transfer
*/
void ConvertDataBIN11(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift);
/**
@fn void ConvertDataBIN22(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift)
@brief move the pixel raw data to correction position,and bin if need
@param Data raw image data
@param x image width
@param y image height
@param PixShift this is a way to fix the bad pixel data by the usb transfer
*/
void ConvertDataBIN22(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift);
/**
@fn void ConvertDataBIN44(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift)
@brief move the pixel raw data to correction position,and bin if need
@param Data raw image data
@param x image width
@param y image height
@param PixShift this is a way to fix the bad pixel data by the usb transfer
*/
void ConvertDataBIN44(uint8_t * Data,uint32_t x, uint32_t y, uint16_t PixShift);
/** @fn uint32_t SetFocusSetting(qhyccd_handle *h,uint32_t focusCenterX, uint32_t focusCenterY)
@brief Set the camera on focus mode
@param h camera control handle
@param focusCenterX
@param focusCenterY
@return
on success,return QHYCCD_SUCCESS \n
another QHYCCD_ERROR code on other failures
*/
virtual uint32_t SetFocusSetting(qhyccd_handle *h,uint32_t focusCenterX, uint32_t focusCenterY);
};
#endif
|
