/usr/include/libindi/indiccd.h is in libindi-dev 0.9.7-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | /*******************************************************************************
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 <string.h>
#include "defaultdevice.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;
/**
* @brief The CCDChip class provides functionality of a CCD Chip within a CCD.
*
*/
class CCDChip
{
public:
CCDChip();
~CCDChip();
typedef enum { LIGHT_FRAME=0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME } CCD_FRAME;
typedef enum { FRAME_X, FRAME_Y, FRAME_W, FRAME_H} CCD_FRAME_INDEX;
typedef enum { BIN_W, BIN_H} CCD_BIN_INDEX;
typedef enum { CCD_MAX_X, CCD_MAX_Y, CCD_PIXEL_SIZE, CCD_PIXEL_SIZE_X, CCD_PIXEL_SIZE_Y, CCD_BITSPERPIXEL} CCD_INFO_INDEX;
/**
* @brief getXRes Get the horizontal resolution in pixels of the CCD Chip.
* @return the horizontal resolution of the CCD Chip.
*/
inline int getXRes() { return XRes; }
/**
* @brief Get the vertical resolution in pixels of the CCD Chip.
* @return the horizontal resolution of the CCD Chip.
*/
inline int getYRes() { return YRes; }
/**
* @brief getSubX Get the starting left coordinates (X) of the frame.
* @return the starting left coordinates (X) of the image.
*/
inline int getSubX() { return SubX; }
/**
* @brief getSubY Get the starting top coordinates (Y) of the frame.
* @return the starting top coordinates (Y) of the image.
*/
inline int getSubY() { return SubY; }
/**
* @brief getSubW Get the width of the frame
* @return unbinned width of the frame
*/
inline int getSubW() { return SubW; }
/**
* @brief getSubH Get the height of the frame
* @return unbinned height of the frame
*/
inline int getSubH() { return SubH; }
/**
* @brief getBinX Get horizontal binning of the CCD chip.
* @return horizontal binning of the CCD chip.
*/
inline int getBinX() { return BinX; }
/**
* @brief getBinY Get vertical binning of the CCD chip.
* @return vertical binning of the CCD chip.
*/
inline int getBinY() { return BinY; }
/**
* @brief getPixelSizeX Get horizontal pixel size in microns.
* @return horizontal pixel size in microns.
*/
inline float getPixelSizeX() { return PixelSizex; }
/**
* @brief getPixelSizeY Get vertical pixel size in microns.
* @return vertical pixel size in microns.
*/
inline float getPixelSizeY() { return PixelSizey; }
/**
* @brief getBPP Get CCD Chip depth (bits per pixel).
* @return bits per pixel.
*/
inline int getBPP() { return BPP; }
/**
* @brief getFrameBufferSize Get allocated frame buffer size to hold the CCD image frame.
* @return allocated frame buffer size to hold the CCD image frame.
*/
inline int getFrameBufferSize() { return RawFrameSize; }
/**
* @brief getExposureLeft Get exposure time left in seconds.
* @return exposure time left in seconds.
*/
inline double getExposureLeft() { return ImageExposureN[0].value; }
/**
* @brief getExposureDuration Get requested exposure duration for the CCD chip in seconds.
* @return requested exposure duration for the CCD chip in seconds.
*/
inline double getExposureDuration() { return exposureDuration; }
/**
* @brief getExposureStartTime
* @return exposure start time in ISO 8601 format.
*/
const char *getExposureStartTime();
/**
* @brief getFrameBuffer Get raw frame buffer of the CCD chip.
* @return raw frame buffer of the CCD chip.
*/
inline char *getFrameBuffer() { return RawFrame; }
/**
* @brief isCompressed
* @return True if frame is compressed, false otherwise.
*/
inline bool isCompressed() { return SendCompressed; }
/**
* @brief isInterlaced
* @return True if CCD chip is Interlaced, false otherwise.
*/
inline bool isInterlaced() { return Interlaced; }
/**
* @brief getFrameType
* @return CCD Frame type
*/
inline CCD_FRAME getFrameType() { return FrameType; }
/**
* @brief getFrameTypeName returns CCD Frame type name
* @param fType type of frame
* @return CCD Frame type name
*/
const char *getFrameTypeName(CCD_FRAME fType);
/**
* @brief setResolutoin set CCD Chip resolution
* @param x width
* @param y height
*/
void setResolutoin(int x, int y);
/**
* @brief setFrame Set desired frame resolutoin for an exposure.
* @param subx Left position.
* @param suby Top position.
* @param subw unbinned width of the frame.
* @param subh unbinned height of the frame.
*/
void setFrame(int subx, int suby, int subw, int subh);
/**
* @brief setBin Set CCD Chip binnig
* @param hor Horizontal binning.
* @param ver Vertical binning.
*/
void setBin(int hor, int ver);
/**
* @brief setPixelSize Set CCD Chip pixel size
* @param x Horziontal pixel size in microns.
* @param y Vertical pixel size in microns.
*/
void setPixelSize(float x, float y);
/**
* @brief setCompressed Set whether a frame is compressed after exposure?
* @param cmp If true, compress frame.
*/
void setCompressed (bool cmp);
/**
* @brief setInterlaced Set whether the CCD chip is interlaced or not?
* @param intr If true, the CCD chip is interlaced.
*/
void setInterlaced(bool intr);
/**
* @brief setFrameBufferSize Set desired frame buffer size. The function will allocate memory accordingly. The frame size depends on the
* desired frame resolution (Left, Top, Width, Height), depth of the CCD chip (bpp), and binning settings. You must set the frame size any time
* any of the prior parameters gets updated.
* @param nbuf size of buffer in bytes.
*/
void setFrameBufferSize(int nbuf);
/**
* @brief setBPP Set depth of CCD chip.
* @param bpp bits per pixel
*/
void setBPP(int bpp);
/**
* @brief setFrameType Set desired frame type for next exposure.
* @param type desired CCD frame type.
*/
void setFrameType(CCD_FRAME type);
/**
* @brief setExposureDuration Set desired CCD frame exposure duration for next exposure. You must call this function immediately before
* starting the actual exposure as it is used to calculate the timestamp used for the FITS header.
* @param duration exposure duration in seconds.
*/
void setExposureDuration(double duration);
/**
* @brief setExposureLeft Update exposure time left. Inform the client of the new exposure time left value.
* @param duration exposure duration left in seconds.
*/
void setExposureLeft(double duration);
/**
* @brief setExposureFailed Alert the client that the exposure failed.
*/
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; // UNBINNED width of the subframe
int SubH; // UNBINNED 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;
double exposureDuration;
timeval startExposureTime;
INumberVectorProperty *ImageExposureNP;
INumber ImageExposureN[1];
ISwitchVectorProperty *AbortExposureSP;
ISwitch AbortExposureS[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::DefaultDevice, 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 bool 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 target Chip 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(CCDChip *targetChip);
/** \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 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 Guide head frame dimension is updated by the client. 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 updateGuideFrame(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 INDI::CCD calls this function when Guide head binning is updated by the client. 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 updateGuideBin(int hor, int ver);
/** \brief INDI::CCD calls this function when CCD frame type needs to be updated in the hardware.
\param fType Frame type
\return true is CCD chip update is successful, false otherwise.
\note It is \e not mandotary to implement this function in the child class. The CCD hardware layer may either set the frame type when this function
is called, or (optionally) before an exposure is started.
*/
virtual bool updateCCDFrameType(CCDChip::CCD_FRAME fType);
/** \brief INDI::CCD calls this function when Guide frame type is updated by the client.
\param fType Frame type
\return true is CCD chip update is successful, false otherwise.
\note It is \e not mandotary to implement this function in the child class. The CCD hardware layer may either set the frame type when this function
is called, or (optionally) before an exposure is started.
*/
virtual bool updateGuideFrameType(CCDChip::CCD_FRAME fType);
/** \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 SetGuideHeadParams(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.
\param targetChip The target chip to extract the keywords from.
\note In additional to the standard FITS keywords, this function write the following keywords the FITS file:
<ul>
<li>EXPTIME: Total Exposure Time (s)</li>
<li>DARKTIME (if applicable): Total Exposure Time (s)</li>
<li>PIXSIZE1: Pixel Size 1 (microns)</li>
<li>PIXSIZE2: Pixel Size 2 (microns)</li>
<li>BINNING: Binning HOR x VER</li>
<li>FRAME: Frame Type</li>
<li>DATAMIN: Minimum value</li>
<li>DATAMAX: Maximum value</li>
<li>INSTRUME: CCD Name</li>
<li>DATE-OBS: UTC start date of observation</li>
</ul>
To add additional information, override this function in the child class and ensure to call INDI::CCD::addFITSKeywords.
*/
virtual void addFITSKeywords(fitsfile *fptr, CCDChip *targetChip);
/* A function to just remove GCC warnings about deprecated conversion */
void fits_update_key_s(fitsfile* fptr, int type, std::string name, void* p, std::string explanation, int* status);
/**
* @brief activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.
*/
virtual void activeDevicesUpdated() {}
virtual bool saveConfigItems(FILE *fp);
float RA;
float Dec;
bool HasGuideHead;
bool HasSt4Port;
bool InExposure;
bool InGuideExposure;
CCDChip PrimaryCCD;
CCDChip GuideCCD;
// We are going to snoop these from a telescope
INumberVectorProperty EqNP;
INumber EqN[2];
ITextVectorProperty *ActiveDeviceTP;
IText ActiveDeviceT[2];
private:
void getMinMax(double *min, double *max, CCDChip *targetChip);
};
#endif // INDI:CCD_H
|