summaryrefslogtreecommitdiff
path: root/include/qhy/titan034.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/qhy/titan034.h')
-rw-r--r--include/qhy/titan034.h412
1 files changed, 412 insertions, 0 deletions
diff --git a/include/qhy/titan034.h b/include/qhy/titan034.h
new file mode 100644
index 0000000..f24ae63
--- /dev/null
+++ b/include/qhy/titan034.h
@@ -0,0 +1,412 @@
+/*
+ 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 titan034.h
+ * @brief TITAN034 class define
+ */
+
+#include "qhybase.h"
+
+#ifdef LINUX
+#include <opencv/cv.h>
+#endif
+
+#ifndef TITAN034_DEF
+#define TITAN034_DEF
+
+
+/**
+ * @brief TITAN034 class define
+ *
+ * include all functions for titan034
+ */
+class TITAN034:public QHYBASE
+{
+public:
+ TITAN034();
+ ~TITAN034();
+ /**
+ @fn uint32_t ConnectCamera(qhyccd_device *d,qhyccd_handle **h)
+ @brief connect to the connected camera
+ @param d camera deivce
+ @param h camera control handle
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t ConnectCamera(qhyccd_device *d,qhyccd_handle **h);
+
+ /**
+ @fn uint32_t DisConnectCamera(qhyccd_handle *h)
+ @brief disconnect to the connected camera
+ @param h camera control handle
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t DisConnectCamera(qhyccd_handle *h);
+
+ /**
+ @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 ReSetParams2cam(qhyccd_handle *h)
+ @brief re set the params to camera,because some behavior will cause camera reset
+ @param h camera control handle
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t ReSetParams2cam(qhyccd_handle *h);
+
+ /**
+ @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 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 uint32_t GetChipMemoryLength()
+ @brief get the min cost memory for the image
+ @return
+ success return the total memory space(unit:byte) \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t GetChipMemoryLength();
+
+ /**
+ @fn double GetChipExposeTime()
+ @brief get the current exposetime
+ @return
+ success return the current expose time (unit:us) \n
+ another QHYCCD_ERROR code on other failures
+ */
+ double GetChipExposeTime();
+
+ /**
+ @fn double GetChipGain()
+ @brief get the current gain
+ @return
+ success return the current expose gain\n
+ another QHYCCD_ERROR code on other failures
+ */
+ double GetChipGain();
+
+ /**
+ @fn double GetChipSpeed()
+ @brief get the current transfer speed
+ @return
+ success return the current speed level \n
+ another QHYCCD_ERROR code on other failures
+ */
+ double GetChipSpeed();
+
+ /**
+ @fn double GetChipBitsMode()
+ @brief get the current camera depth bits
+ @return
+ success return the current camera depth bits \n
+ another QHYCCD_ERROR code on other failures
+ */
+ double GetChipBitsMode();
+
+ /**
+ @fn uint32_t SetChipBitsMode(qhyccd_handle *h,uint32_t bits)
+ @brief set the camera depth bits
+ @param h camera control handle
+ @param bits depth bits
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t SetChipBitsMode(qhyccd_handle *h,uint32_t bits);
+
+ /**
+ @fn uint32_t SetChipBinMode(qhyccd_handle *h,uint32_t wbin,uint32_t hbin)
+ @brief set the camera image bin mode
+ @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 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 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 BeginLiveExposure(qhyccd_handle *h)
+ @brief begin live exposure
+ @param h camera control handle
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t BeginLiveExposure(qhyccd_handle *h);
+
+ /**
+ @fn uint32_t StopLiveExposure(qhyccd_handle *h)
+ @brief stop live exposure
+ @param h camera control handle
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t StopLiveExposure(qhyccd_handle *h);
+
+ /**
+ @fn uint32_t GetLiveFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData)
+ @brief get live 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 GetLiveFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData);
+
+ /**
+ @fn uint32_t SetChipUSBTraffic(qhyccd_handle *h,uint32_t i)
+ @brief set hblank
+ @param h camera control handle
+ @param i hblank value
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t SetChipUSBTraffic(qhyccd_handle *h,uint32_t i);
+
+ /**
+ @fn uint32_t Send2GuiderPort(qhyccd_handle *h,uint32_t Direction,uint16_t PulseTime)
+ @brief send the command to camera's guide port
+ @param h camera control handle
+ @param Direction RA DEC
+ @param PulseTime the time last for command
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t Send2GuiderPort(qhyccd_handle *h,uint32_t Direction,uint16_t PulseTime);
+
+
+ /**
+ @fn double SetPll(qhyccd_handle *h,uint8_t clk)
+ @brief set the cmos inter pll
+ @param h camera control handle
+ @param clk clock
+ @return
+ success return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ double SetPll(qhyccd_handle *h,uint8_t clk);
+
+ /**
+ @fn void SWIFT_MSBLSB(uint8_t *ImgData)
+ @brief switch the image pixel data to right position
+ @param ImgData image buffer
+ */
+ void SWIFT_MSBLSB(uint8_t *ImgData);
+
+ /**
+ @fn void SetAnalogGain(double gain)
+ @brief set gain to camera,here it is the bottom
+ @param gain gain value
+ */
+ void SetAnalogGain(qhyccd_handle *h,double gain);
+
+ /** @fn uint32_t GetChipInfo(double *chipw,double *chiph,uint32_t *imagew,uint32_t *imageh,double *pixelw,double *pixelh)
+ @brief get the camera's ccd/cmos chip info
+ @param h camera control handle
+ @param chipw chip size width
+ @param chiph chip size height
+ @param imagew chip output image width
+ @param imageh chip output image height
+ @param pixelw chip pixel size width
+ @param pixelh chip pixel size height
+ @param bpp chip pixel depth
+ */
+ uint32_t GetChipInfo(double *chipw,double *chiph,uint32_t *imagew,uint32_t *imageh,double *pixelw,double *pixelh,uint32_t *bpp);
+
+
+ /** @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
+ */
+ uint32_t SetFocusSetting(qhyccd_handle *h,uint32_t focusCenterX, uint32_t focusCenterY);
+
+ /**
+ @fn uint32_t SetStreamMode(qhyccd_handle *handle,uint8_t mode)
+ @brief Set the camera's mode to chose the way reading data from camera
+ @param handle camera control handle
+ @param mode the stream mode \n
+ 0x00:default mode,single frame mode \n
+ 0x01:live mode \n
+ @return
+ on success,return QHYCCD_SUCCESS \n
+ another QHYCCD_ERROR code on other failures
+ */
+ uint32_t SetStreamMode(qhyccd_handle *handle,uint8_t mode);
+
+private:
+ uint32_t expmode; //!< expose time mode
+ uint32_t pllratio; //!< inter pll ratio
+ uint32_t lastx,lasty,lastxsize,lastysize;
+ uint32_t longtimeflag;
+ uint32_t transferflag;
+};
+#endif