TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
QSICamera Class Reference

#include <qsiapi.h>

Collaboration diagram for QSICamera:
Collaboration graph

Public Types

enum  CameraState {
  CameraIdle = 0, CameraWaiting = 1, CameraExposing = 2, CameraReading = 3,
  CameraDownload = 4, CameraError = 5
}
 
enum  GuideDirections { guideNorth = 0, guideSouth = 1, guideEast = 2, guideWest = 3 }
 
enum  FanMode { fanOff = 0, fanQuiet = 1, fanFull = 2 }
 
enum  FlushCycles {
  FlushZero = 0, FlushOne = 1, FlushTwo = 2, FlushFour = 3,
  FlushEight = 4
}
 
enum  ShutterMode { ShutterMechanical = 0, ShutterElectronic = 1 }
 
enum  PreExposureFlush {
  FlushNone = 0, FlushModest = 1, FlushNormal = 2, FlushAggressive = 3,
  FlushVeryAggressive = 4
}
 
enum  ShutterPriority { ShutterPriorityMechanical = 0, ShutterPriorityElectronic = 1 }
 
enum  CameraGain { CameraGainHigh = 0, CameraGainLow = 1, CameraGainAuto = 2 }
 
enum  AntiBloom { AntiBloomNormal = 0, AntiBloomHigh = 1 }
 
enum  ReadoutSpeed { HighImageQuality = 0, FastReadout = 1 }
 
enum  TriggerModeEnum { ShortWait = 4, LongWait = 6 }
 
enum  TriggerPolarityEnum { HighToLow = 0, LowToHigh = 1 }
 
enum  ShutterStateEnum {
  RightSlitCW = 0, LeftSlitCW = 1, RightGateCW = 2, LeftGateCW = 3,
  RightSlitCCW = 4, LeftSlitCCW = 5, RightGateCCW = 6, LeftGateCCW = 7
}
 

Public Member Functions

 QSICamera ()
 
 ~QSICamera ()
 
int get_BinX (short *pVal)
 
int put_BinX (short newVal)
 
int get_BinY (short *pVal)
 
int put_BinY (short newVal)
 
int get_CameraState (CameraState *pVal)
 
int get_CameraXSize (long *pVal)
 
int get_CameraYSize (long *pVal)
 
int get_CanAbortExposure (bool *pVal)
 
int get_CanAsymmetricBin (bool *pVal)
 
int get_CanGetCoolerPower (bool *pVal)
 
int get_CanPulseGuide (bool *pVal)
 
int get_CanSetCCDTemperature (bool *pVal)
 
int get_CanStopExposure (bool *pVal)
 
int get_CCDTemperature (double *pVal)
 
int get_Connected (bool *pVal)
 
int put_Connected (bool newVal)
 
int get_CoolerOn (bool *pVal)
 
int put_CoolerOn (bool newVal)
 
int get_CoolerPower (double *pVal)
 
int get_Description (std::string &pVal)
 
int get_DriverInfo (std::string &pVal)
 
int get_ElectronsPerADU (double *pVal)
 
int get_FullWellCapacity (double *pVal)
 
int get_HasFilterWheel (bool *pVal)
 
int get_HasShutter (bool *pVal)
 
int get_HeatSinkTemperature (double *pVal)
 
int get_ImageArraySize (int &xSize, int &ySize, int &elementSize)
 
int get_ImageArray (unsigned short *pVal)
 
int get_ImageArray (double *pVal)
 
int get_ImageReady (bool *pVal)
 
int get_IsMainCamera (bool *pVal)
 
int put_IsMainCamera (bool newVal)
 
int get_IsPulseGuiding (bool *pVal)
 
int get_LastError (std::string &pVal)
 
int get_LastExposureDuration (double *pVal)
 
int get_LastExposureStartTime (std::string &pVal)
 
int get_MaxADU (long *pVal)
 
int get_MaxBinX (short *pVal)
 
int get_MaxBinY (short *pVal)
 
int get_ModelNumber (std::string &pVal)
 
int get_Name (std::string &pVal)
 
int get_NumX (long *pVal)
 
int put_NumX (long newVal)
 
int get_NumY (long *pVal)
 
int put_NumY (long newVal)
 
int get_PixelSizeX (double *pVal)
 
int get_PixelSizeY (double *pVal)
 
int get_PowerOfTwoBinning (bool *pVal)
 
int get_SerialNumber (std::string &pVal)
 
int get_SetCCDTemperature (double *pVal)
 
int put_SetCCDTemperature (double newVal)
 
int get_StartX (long *pVal)
 
int put_StartX (long newVal)
 
int get_StartY (long *pVal)
 
int put_StartY (long newVal)
 
int AbortExposure (void)
 
int PulseGuide (GuideDirections Direction, long Duration)
 
int StartExposure (double Duration, bool Light)
 
int StopExposure (void)
 
int put_SelectCamera (std::string serialNum)
 
int get_SelectCamera (std::string &serialNum)
 
int get_AvailableCameras (std::string cameraSerial[], std::string cameraDesc[], int &numFound)
 
int put_UseStructuredExceptions (bool newVal)
 
int get_SoundEnabled (bool &pVal)
 
int put_SoundEnabled (bool newVal)
 
int get_LEDEnabled (bool &pVal)
 
int put_LEDEnabled (bool newVal)
 
int get_FanMode (FanMode &pVal)
 
int put_FanMode (FanMode newVal)
 
int get_FlushCycles (FlushCycles &pVal)
 
int put_FlushCycles (FlushCycles newVal)
 
int get_ShutterMode (ShutterMode &pVal)
 
int put_ShutterMode (ShutterMode newVal)
 
int get_ReadoutSpeed (ReadoutSpeed &pVal)
 
int put_ReadoutSpeed (ReadoutSpeed newVal)
 
int get_FilterCount (int &count)
 
int get_Names (std::string names[])
 
int put_Names (std::string names[])
 
int get_Position (short *pVal)
 
int put_Position (short newVal)
 
int get_FocusOffset (long pVal[])
 
int put_FocusOffset (long newVal[])
 
int get_FilterWheelConnected (bool *pVal)
 
int put_FilterWheelConnected (bool newVal)
 
int put_EnableShutterStatusOutput (bool newVal)
 
int get_EnableShutterStatusOutput (bool *pVal)
 
int get_ManualShutterMode (bool *pVal)
 
int put_ManualShutterMode (bool newVal)
 
int put_ManualShutterOpen (bool newVal)
 
int get_CameraGain (CameraGain *pVal)
 
int put_CameraGain (CameraGain newVal)
 
int get_AntiBlooming (AntiBloom *pVal)
 
int put_AntiBlooming (AntiBloom newVal)
 
int get_ShutterPriority (ShutterPriority *pVal)
 
int put_ShutterPriority (ShutterPriority newVal)
 
int get_PreExposureFlush (PreExposureFlush *pVal)
 
int put_PreExposureFlush (PreExposureFlush newVal)
 
int put_HostTimedExposure (bool newVal)
 
int get_LastOverscanMean (unsigned short *pVal)
 
int get_MinExposureTime (double *pVal)
 
int get_MaxExposureTime (double *pVal)
 
int get_QSIDeviceCount (short *pVal)
 
int get_QSISelectedDevice (std::string &pVal)
 
int put_QSISelectedDevice (std::string newVal)
 
int get_QSISerialNumbers (std::string pVal[], int *iNumFound)
 
int QSIRead (unsigned char *Buffer, int BytesToRead, int *BytesReturned)
 
int QSIWrite (unsigned char *Buffer, int BytesToWrite, int *BytesWritten)
 
int get_QSIReadDataAvailable (int *pVal)
 
int get_QSIWriteDataPending (int *pVal)
 
int put_QSIReadTimeout (int newVal)
 
int put_QSIWriteTimeout (int newVal)
 
int put_QSIOpen (bool newVal)
 
int get_CanSetGain (bool *pVal)
 
int put_MaskPixels (bool newVal)
 
int get_MaskPixels (bool *pVal)
 
int put_PixelMask (std::vector< Pixel > pixels)
 
int get_PixelMask (std::vector< Pixel > *pixels)
 
int get_FilterPositionTrim (std::vector< short > *pVal)
 
int put_FilterPositionTrim (std::vector< short >)
 
int get_HasFilterWheelTrim (bool *pVal)
 
int get_FilterWheelNames (std::vector< std::string > *pVal)
 
int get_SelectedFilterWheel (std::string *pVal)
 
int put_SelectedFilterWheel (std::string newVal)
 
int NewFilterWheel (std::string Name)
 
int DeleteFilterWheel (std::string Name)
 
int get_PCBTemperature (double *pVal)
 
int HSRImage (double Duration, unsigned short *Image)
 
int put_HSRMode (bool newVal)
 
int Flush (void)
 
int EnableTriggerMode (TriggerModeEnum newVal1, TriggerPolarityEnum newVal2)
 
int TerminatePendingTrigger (void)
 
int CancelTriggerMode (void)
 
int get_ShutterState (ShutterStateEnum *pVal)
 

Static Public Attributes

static const int MAXCAMERAS = 128
 

Private Member Functions

 QSICamera (const QSICamera &cam)
 
QSICameraoperator= (QSICamera that)
 

Private Attributes

void * pCam
 

Member Enumeration Documentation

◆ AntiBloom

Enumerator
AntiBloomNormal 
AntiBloomHigh 

◆ CameraGain

Enumerator
CameraGainHigh 
CameraGainLow 
CameraGainAuto 

◆ CameraState

Enumerator
CameraIdle 
CameraWaiting 
CameraExposing 
CameraReading 
CameraDownload 
CameraError 

◆ FanMode

Enumerator
fanOff 
fanQuiet 
fanFull 

◆ FlushCycles

Enumerator
FlushZero 
FlushOne 
FlushTwo 
FlushFour 
FlushEight 

◆ GuideDirections

Enumerator
guideNorth 
guideSouth 
guideEast 
guideWest 

◆ PreExposureFlush

Enumerator
FlushNone 
FlushModest 
FlushNormal 
FlushAggressive 
FlushVeryAggressive 

◆ ReadoutSpeed

Enumerator
HighImageQuality 
FastReadout 

◆ ShutterMode

Enumerator
ShutterMechanical 
ShutterElectronic 

◆ ShutterPriority

Enumerator
ShutterPriorityMechanical 
ShutterPriorityElectronic 

◆ ShutterStateEnum

Enumerator
RightSlitCW 
LeftSlitCW 
RightGateCW 
LeftGateCW 
RightSlitCCW 
LeftSlitCCW 
RightGateCCW 
LeftGateCCW 

◆ TriggerModeEnum

Enumerator
ShortWait 
LongWait 

◆ TriggerPolarityEnum

Enumerator
HighToLow 
LowToHigh 

Constructor & Destructor Documentation

◆ QSICamera() [1/2]

QSICamera::QSICamera ( )

◆ ~QSICamera()

QSICamera::~QSICamera ( )

◆ QSICamera() [2/2]

QSICamera::QSICamera ( const QSICamera cam)
private

Member Function Documentation

◆ AbortExposure()

int QSICamera::AbortExposure ( void  )

◆ CancelTriggerMode()

int QSICamera::CancelTriggerMode ( void  )

◆ DeleteFilterWheel()

int QSICamera::DeleteFilterWheel ( std::string  Name)

◆ EnableTriggerMode()

int QSICamera::EnableTriggerMode ( TriggerModeEnum  newVal1,
TriggerPolarityEnum  newVal2 
)

◆ Flush()

int QSICamera::Flush ( void  )

◆ get_AntiBlooming()

int QSICamera::get_AntiBlooming ( QSICamera::AntiBloom pVal)

◆ get_AvailableCameras()

int QSICamera::get_AvailableCameras ( std::string  cameraSerial[],
std::string  cameraDesc[],
int &  numFound 
)

◆ get_BinX()

int QSICamera::get_BinX ( short *  pVal)

◆ get_BinY()

int QSICamera::get_BinY ( short *  pVal)

◆ get_CameraGain()

int QSICamera::get_CameraGain ( QSICamera::CameraGain pVal)

◆ get_CameraState()

int QSICamera::get_CameraState ( CameraState pVal)

◆ get_CameraXSize()

int QSICamera::get_CameraXSize ( long pVal)

◆ get_CameraYSize()

int QSICamera::get_CameraYSize ( long pVal)

◆ get_CanAbortExposure()

int QSICamera::get_CanAbortExposure ( bool pVal)

◆ get_CanAsymmetricBin()

int QSICamera::get_CanAsymmetricBin ( bool pVal)

◆ get_CanGetCoolerPower()

int QSICamera::get_CanGetCoolerPower ( bool pVal)

◆ get_CanPulseGuide()

int QSICamera::get_CanPulseGuide ( bool pVal)

◆ get_CanSetCCDTemperature()

int QSICamera::get_CanSetCCDTemperature ( bool pVal)

◆ get_CanSetGain()

int QSICamera::get_CanSetGain ( bool pVal)

◆ get_CanStopExposure()

int QSICamera::get_CanStopExposure ( bool pVal)

◆ get_CCDTemperature()

int QSICamera::get_CCDTemperature ( double *  pVal)

◆ get_Connected()

int QSICamera::get_Connected ( bool pVal)

◆ get_CoolerOn()

int QSICamera::get_CoolerOn ( bool pVal)

◆ get_CoolerPower()

int QSICamera::get_CoolerPower ( double *  pVal)

◆ get_Description()

int QSICamera::get_Description ( std::string &  pVal)

◆ get_DriverInfo()

int QSICamera::get_DriverInfo ( std::string &  pVal)

◆ get_ElectronsPerADU()

int QSICamera::get_ElectronsPerADU ( double *  pVal)

◆ get_EnableShutterStatusOutput()

int QSICamera::get_EnableShutterStatusOutput ( bool pVal)

◆ get_FanMode()

int QSICamera::get_FanMode ( FanMode pVal)

◆ get_FilterCount()

int QSICamera::get_FilterCount ( int &  count)

◆ get_FilterPositionTrim()

int QSICamera::get_FilterPositionTrim ( std::vector< short > *  pVal)

◆ get_FilterWheelConnected()

int QSICamera::get_FilterWheelConnected ( bool pVal)

◆ get_FilterWheelNames()

int QSICamera::get_FilterWheelNames ( std::vector< std::string > *  pVal)

◆ get_FlushCycles()

int QSICamera::get_FlushCycles ( FlushCycles pVal)

◆ get_FocusOffset()

int QSICamera::get_FocusOffset ( long  pVal[])

◆ get_FullWellCapacity()

int QSICamera::get_FullWellCapacity ( double *  pVal)

◆ get_HasFilterWheel()

int QSICamera::get_HasFilterWheel ( bool pVal)

◆ get_HasFilterWheelTrim()

int QSICamera::get_HasFilterWheelTrim ( bool pVal)

◆ get_HasShutter()

int QSICamera::get_HasShutter ( bool pVal)

◆ get_HeatSinkTemperature()

int QSICamera::get_HeatSinkTemperature ( double *  pVal)

◆ get_ImageArray() [1/2]

int QSICamera::get_ImageArray ( unsigned short *  pVal)

◆ get_ImageArray() [2/2]

int QSICamera::get_ImageArray ( double *  pVal)

◆ get_ImageArraySize()

int QSICamera::get_ImageArraySize ( int &  xSize,
int &  ySize,
int &  elementSize 
)

◆ get_ImageReady()

int QSICamera::get_ImageReady ( bool pVal)

◆ get_IsMainCamera()

int QSICamera::get_IsMainCamera ( bool pVal)

◆ get_IsPulseGuiding()

int QSICamera::get_IsPulseGuiding ( bool pVal)

◆ get_LastError()

int QSICamera::get_LastError ( std::string &  pVal)

◆ get_LastExposureDuration()

int QSICamera::get_LastExposureDuration ( double *  pVal)

◆ get_LastExposureStartTime()

int QSICamera::get_LastExposureStartTime ( std::string &  pVal)

◆ get_LastOverscanMean()

int QSICamera::get_LastOverscanMean ( unsigned short *  pVal)

◆ get_LEDEnabled()

int QSICamera::get_LEDEnabled ( bool pVal)

◆ get_ManualShutterMode()

int QSICamera::get_ManualShutterMode ( bool pVal)

◆ get_MaskPixels()

int QSICamera::get_MaskPixels ( bool pVal)

◆ get_MaxADU()

int QSICamera::get_MaxADU ( long pVal)

◆ get_MaxBinX()

int QSICamera::get_MaxBinX ( short *  pVal)

◆ get_MaxBinY()

int QSICamera::get_MaxBinY ( short *  pVal)

◆ get_MaxExposureTime()

int QSICamera::get_MaxExposureTime ( double *  pVal)

◆ get_MinExposureTime()

int QSICamera::get_MinExposureTime ( double *  pVal)

◆ get_ModelNumber()

int QSICamera::get_ModelNumber ( std::string &  pVal)

◆ get_Name()

int QSICamera::get_Name ( std::string &  pVal)

◆ get_Names()

int QSICamera::get_Names ( std::string  names[])

◆ get_NumX()

int QSICamera::get_NumX ( long pVal)

◆ get_NumY()

int QSICamera::get_NumY ( long pVal)

◆ get_PCBTemperature()

int QSICamera::get_PCBTemperature ( double *  pVal)

◆ get_PixelMask()

int QSICamera::get_PixelMask ( std::vector< Pixel > *  pixels)

◆ get_PixelSizeX()

int QSICamera::get_PixelSizeX ( double *  pVal)

◆ get_PixelSizeY()

int QSICamera::get_PixelSizeY ( double *  pVal)

◆ get_Position()

int QSICamera::get_Position ( short *  pVal)

◆ get_PowerOfTwoBinning()

int QSICamera::get_PowerOfTwoBinning ( bool pVal)

◆ get_PreExposureFlush()

int QSICamera::get_PreExposureFlush ( QSICamera::PreExposureFlush pVal)

◆ get_QSIDeviceCount()

int QSICamera::get_QSIDeviceCount ( short *  pVal)

◆ get_QSIReadDataAvailable()

int QSICamera::get_QSIReadDataAvailable ( int *  pVal)

◆ get_QSISelectedDevice()

int QSICamera::get_QSISelectedDevice ( std::string &  pVal)

◆ get_QSISerialNumbers()

int QSICamera::get_QSISerialNumbers ( std::string  pVal[],
int *  iNumFound 
)

◆ get_QSIWriteDataPending()

int QSICamera::get_QSIWriteDataPending ( int *  pVal)

◆ get_ReadoutSpeed()

int QSICamera::get_ReadoutSpeed ( ReadoutSpeed pVal)

◆ get_SelectCamera()

int QSICamera::get_SelectCamera ( std::string &  serialNum)

◆ get_SelectedFilterWheel()

int QSICamera::get_SelectedFilterWheel ( std::string *  pVal)

◆ get_SerialNumber()

int QSICamera::get_SerialNumber ( std::string &  pVal)

◆ get_SetCCDTemperature()

int QSICamera::get_SetCCDTemperature ( double *  pVal)

◆ get_ShutterMode()

int QSICamera::get_ShutterMode ( ShutterMode pVal)

◆ get_ShutterPriority()

int QSICamera::get_ShutterPriority ( QSICamera::ShutterPriority pVal)

◆ get_ShutterState()

int QSICamera::get_ShutterState ( ShutterStateEnum pVal)

◆ get_SoundEnabled()

int QSICamera::get_SoundEnabled ( bool pVal)

◆ get_StartX()

int QSICamera::get_StartX ( long pVal)

◆ get_StartY()

int QSICamera::get_StartY ( long pVal)

◆ HSRImage()

int QSICamera::HSRImage ( double  Duration,
unsigned short *  Image 
)

◆ NewFilterWheel()

int QSICamera::NewFilterWheel ( std::string  Name)

◆ operator=()

QSICamera& QSICamera::operator= ( QSICamera  that)
private

◆ PulseGuide()

int QSICamera::PulseGuide ( GuideDirections  Direction,
long  Duration 
)

◆ put_AntiBlooming()

int QSICamera::put_AntiBlooming ( QSICamera::AntiBloom  newVal)

◆ put_BinX()

int QSICamera::put_BinX ( short  newVal)

◆ put_BinY()

int QSICamera::put_BinY ( short  newVal)

◆ put_CameraGain()

int QSICamera::put_CameraGain ( QSICamera::CameraGain  newVal)

◆ put_Connected()

int QSICamera::put_Connected ( bool  newVal)

◆ put_CoolerOn()

int QSICamera::put_CoolerOn ( bool  newVal)

◆ put_EnableShutterStatusOutput()

int QSICamera::put_EnableShutterStatusOutput ( bool  newVal)

◆ put_FanMode()

int QSICamera::put_FanMode ( FanMode  newVal)

◆ put_FilterPositionTrim()

int QSICamera::put_FilterPositionTrim ( std::vector< short >  newVal)

◆ put_FilterWheelConnected()

int QSICamera::put_FilterWheelConnected ( bool  newVal)

◆ put_FlushCycles()

int QSICamera::put_FlushCycles ( FlushCycles  newVal)

◆ put_FocusOffset()

int QSICamera::put_FocusOffset ( long  newVal[])

◆ put_HostTimedExposure()

int QSICamera::put_HostTimedExposure ( bool  newVal)

◆ put_HSRMode()

int QSICamera::put_HSRMode ( bool  newVal)

◆ put_IsMainCamera()

int QSICamera::put_IsMainCamera ( bool  newVal)

◆ put_LEDEnabled()

int QSICamera::put_LEDEnabled ( bool  newVal)

◆ put_ManualShutterMode()

int QSICamera::put_ManualShutterMode ( bool  newVal)

◆ put_ManualShutterOpen()

int QSICamera::put_ManualShutterOpen ( bool  newVal)

◆ put_MaskPixels()

int QSICamera::put_MaskPixels ( bool  newVal)

◆ put_Names()

int QSICamera::put_Names ( std::string  names[])

◆ put_NumX()

int QSICamera::put_NumX ( long  newVal)

◆ put_NumY()

int QSICamera::put_NumY ( long  newVal)

◆ put_PixelMask()

int QSICamera::put_PixelMask ( std::vector< Pixel pixels)

◆ put_Position()

int QSICamera::put_Position ( short  newVal)

◆ put_PreExposureFlush()

int QSICamera::put_PreExposureFlush ( QSICamera::PreExposureFlush  newVal)

◆ put_QSIOpen()

int QSICamera::put_QSIOpen ( bool  newVal)

◆ put_QSIReadTimeout()

int QSICamera::put_QSIReadTimeout ( int  newVal)

◆ put_QSISelectedDevice()

int QSICamera::put_QSISelectedDevice ( std::string  newVal)

◆ put_QSIWriteTimeout()

int QSICamera::put_QSIWriteTimeout ( int  newVal)

◆ put_ReadoutSpeed()

int QSICamera::put_ReadoutSpeed ( ReadoutSpeed  newVal)

◆ put_SelectCamera()

int QSICamera::put_SelectCamera ( std::string  serialNum)

◆ put_SelectedFilterWheel()

int QSICamera::put_SelectedFilterWheel ( std::string  newVal)

◆ put_SetCCDTemperature()

int QSICamera::put_SetCCDTemperature ( double  newVal)

◆ put_ShutterMode()

int QSICamera::put_ShutterMode ( ShutterMode  newVal)

◆ put_ShutterPriority()

int QSICamera::put_ShutterPriority ( QSICamera::ShutterPriority  newVal)

◆ put_SoundEnabled()

int QSICamera::put_SoundEnabled ( bool  newVal)

◆ put_StartX()

int QSICamera::put_StartX ( long  newVal)

◆ put_StartY()

int QSICamera::put_StartY ( long  newVal)

◆ put_UseStructuredExceptions()

int QSICamera::put_UseStructuredExceptions ( bool  newVal)

◆ QSIRead()

int QSICamera::QSIRead ( unsigned char *  Buffer,
int  BytesToRead,
int *  BytesReturned 
)

◆ QSIWrite()

int QSICamera::QSIWrite ( unsigned char *  Buffer,
int  BytesToWrite,
int *  BytesWritten 
)

◆ StartExposure()

int QSICamera::StartExposure ( double  Duration,
bool  Light 
)

◆ StopExposure()

int QSICamera::StopExposure ( void  )

◆ TerminatePendingTrigger()

int QSICamera::TerminatePendingTrigger ( void  )

Member Data Documentation

◆ MAXCAMERAS

const int QSICamera::MAXCAMERAS = 128
static

◆ pCam

void* QSICamera::pCam
private

The documentation for this class was generated from the following files: