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
|
/*******************************************************************************
Copyright(c) 2010, 2011 Gerry Rozema, Jasem Mutlaq. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*******************************************************************************/
#ifndef INDI_CCD_H
#define INDI_CCD_H
#include <fitsio.h>
#include "defaultdriver.h"
#include "indiguiderinterface.h"
extern const char *IMAGE_SETTINGS_TAB;
extern const char *IMAGE_INFO_TAB;
extern const char *GUIDE_HEAD_TAB;
extern const char *GUIDE_CONTROL_TAB;
class CCDChip
{
public:
CCDChip();
~CCDChip();
typedef enum { LIGHT_FRAME=0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME } CCD_FRAME;
int getXRes() { return XRes; }
int getYRes() { return YRes; }
int getSubX() { return SubX; }
int getSubY() { return SubY; }
int getSubW() { return SubW; }
int getSubH() { return SubH; }
int getBinX() { return BinX; }
int getBinY() { return BinY; }
int getPixelSizeX() { return PixelSizex; }
int getPixelSizeY() { return PixelSizey; }
int getBPP() { return BPP; }
int getFrameBufferSize() { return RawFrameSize; }
double getExposure() { return ImageExposureN[0].value; }
char *getFrameBuffer() { return RawFrame; }
bool isCompressed() { return SendCompressed; }
bool isInterlaced() { return Interlaced; }
CCD_FRAME getFrameType() { return FrameType; }
void setResolutoin(int x, int y);
void setFrame(int subx, int suby, int subw, int subh);
void setBin(int hor, int ver);
void setPixelSize(int x, int y);
void setCompressed (bool cmp);
void setInterlaced(bool intr);
void setFrameBufferSize(int nbuf);
void setBPP(int bpp);
int setFrameType(CCD_FRAME);
void setExposure(double duration);
void setExposureFailed();
private:
int XRes; // native resolution of the ccd
int YRes; // ditto
int SubX; // left side of the subframe we are requesting
int SubY; // top of the subframe requested
int SubW; // width of the subframe
int SubH; // height of the subframe
int BinX; // Binning requested in the x direction
int BinY; // Binning requested in the Y direction
float PixelSizex; // pixel size in microns, x direction
float PixelSizey; // pixel size in microns, y direction
int BPP; // Bytes per Pixel
bool Interlaced;
char *RawFrame;
int RawFrameSize;
bool SendCompressed;
CCD_FRAME FrameType;
INumberVectorProperty *ImageExposureNP;
INumber ImageExposureN[1];
INumberVectorProperty *ImageFrameNP;
INumber ImageFrameN[4];
INumberVectorProperty *ImageBinNP;
INumber ImageBinN[2];
INumberVectorProperty *ImagePixelSizeNP;
INumber ImagePixelSizeN[6];
ISwitch FrameTypeS[4];
ISwitchVectorProperty *FrameTypeSP;
ISwitch CompressS[2];
ISwitchVectorProperty *CompressSP;
IBLOB FitsB;
IBLOBVectorProperty *FitsBP;
friend class INDI::CCD;
};
/**
* \class INDI::CCD
\brief Class to provide general functionality of CCD cameras with a single CCD sensor, or a primary CCD sensor in addition to a secondary CCD guide head.
It also implements the interface to perform guiding. The class enable the ability to \e snoop on telescope equatorial coordinates and record them in the
FITS file before upload. Developers need to subclass INDI::CCD to implement any driver for CCD cameras within INDI.
\author Gerry Rozema, Jasem Mutlaq
*/
class INDI::CCD : public INDI::DefaultDriver, INDI::GuiderInterface
{
public:
CCD();
virtual ~CCD();
virtual bool initProperties();
virtual bool updateProperties();
virtual void ISGetProperties (const char *dev);
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n);
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n);
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n);
virtual void ISSnoopDevice (XMLEle *root);
protected:
/** \brief Start exposing primary CCD chip
\param duration Duration in seconds
\return 0 if OK and exposure will take some time to complete, 1 if exposure is short and complete already (e.g. bias), -1 on error.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual int StartExposure(float duration);
/** \brief Uploads primary CCD exposed buffer as FITS to the client. Dervied classes should class this function when an exposure is complete.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool ExposureComplete();
/** \brief Abort ongoing exposure
\return true is abort is successful, false otherwise.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool AbortExposure();
/** \brief Start exposing guide CCD chip
\param duration Duration in seconds
\return 0 if OK and exposure will take some time to complete, 1 if exposure is short and complete already (e.g. bias), -1 on error.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual int StartGuideExposure(float duration);
/** \brief Abort ongoing exposure
\return true is abort is successful, false otherwise.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool AbortGuideExposure();
/** \brief Uploads Guide head CCD exposed buffer as FITS to the client. Dervied classes should class this function when an exposure is complete.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool GuideExposureComplete();
/** \brief INDI::CCD calls this function when CCD Frame dimension needs to be updated in the hardware. Derived classes should implement this function
\param x Subframe X coordinate in pixels.
\param y Subframe Y coordinate in pixels.
\param w Subframe width in pixels.
\param h Subframe height in pixels.
\note (0,0) is defined as most left, top pixel in the subframe.
\return true is CCD chip update is successful, false otherwise.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool updateCCDFrame(int x, int y, int w, int h);
/** \brief INDI::CCD calls this function when CCD Binning needs to be updated in the hardware. Derived classes should implement this function
\param hor Horizontal binning.
\param ver Vertical binning.
\return true is CCD chip update is successful, false otherwise.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual bool updateCCDBin(int hor, int ver);
/** \brief Setup CCD paramters for primary CCD. Child classes call this function to update CCD paramaters
\param x Frame X coordinates in pixels.
\param y Frame Y coordinates in pixels.
\param bpp Bits Per Pixels.
\param xf X pixel size in microns.
\param yf Y pixel size in microns.
*/
virtual void SetCCDParams(int x,int y,int bpp,float xf,float yf);
/** \brief Setup CCD paramters for guide head CCD. Child classes call this function to update CCD paramaters
\param x Frame X coordinates in pixels.
\param y Frame Y coordinates in pixels.
\param bpp Bits Per Pixels.
\param xf X pixel size in microns.
\param yf Y pixel size in microns.
*/
virtual void SetGuidHeadParams(int x,int y,int bpp,float xf,float yf);
/** \brief Guide northward for ms milliseconds
\param ms Duration in milliseconds.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
\return True if successful, false otherwise.
*/
virtual bool GuideNorth(float ms);
/** \brief Guide southward for ms milliseconds
\param ms Duration in milliseconds.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
\return 0 if successful, -1 otherwise.
*/
virtual bool GuideSouth(float ms);
/** \brief Guide easward for ms milliseconds
\param ms Duration in milliseconds.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
\return 0 if successful, -1 otherwise.
*/
virtual bool GuideEast(float ms);
/** \brief Guide westward for ms milliseconds
\param ms Duration in milliseconds.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
\return 0 if successful, -1 otherwise.
*/
virtual bool GuideWest(float ms);
/** \brief Add FITS keywords to a fits file
\param fptr pointer to a valid FITS file.
\note This function is not implemented in INDI::CCD, it must be implemented in the child class
*/
virtual void addFITSKeywords(fitsfile *fptr);
float RA;
float Dec;
bool HasGuideHead;
bool HasSt4Port;
bool InExposure;
CCDChip PrimaryCCD;
CCDChip GuideCCD;
private:
// We are going to snoop these from a telescope
INumberVectorProperty EqNP;
INumber EqN[2];
ITextVectorProperty *TelescopeTP;
IText TelescopeT[1];
int uploadfile(void *fitsdata,int total);
};
#endif // INDI:CCD_H
|
