Script TheSkyX  Version 1.27
Public Types | Public Slots | Properties | List of all members
ccdsoftCamera Class Reference

TheSkyX ccdsoftCamera object. More...

Inheritance diagram for ccdsoftCamera:

Public Types

enum  ccdsoftImageReduction { cdNone, cdAutoDark, cdBiasDarkFlat }
 The ccdsoftImageReduction enum. More...
 
enum  ccdsoftImageFrame { cdLight =1, cdBias, cdDark, cdFlat }
 The Image Frame type. More...
 
enum  ccdsoftSBIGGuiderAntiBloom { cdAntiBloomOff, cdAntiBloomLow, cdAntiBloomMedium, cdAntiBloomHigh }
 SBIG Autoguider AntiBlooming. More...
 
enum  ccdsoftMoveVia {
  cdAutoguideViaRelays, cdAutoguideViaRelayAPI, cdAutoguideViaDirectGuide, cdAutoguideViaPulseGuide,
  cdAutoguideViaAO
}
 Move via Relays, RelayAPI, DirectGuide, PulseGuide or using the SBIG AO. More...
 
enum  ccdsoftInterface {
  cdNoPort, cdLPT1, cdLPT2, cdLPT3,
  cdUSB =0x7F00, cdEthernet
}
 SBIG Camera communications physical interface. More...
 
enum  ccdsoftAutoSaveAs { cdFITS, cdSBIG }
 Automatically save images as native SBIG camera or FITS file format. More...
 
enum  ccdsoftFocusGraph { cdMaximumValue, cdSharpness }
 Graph focus by maximum value or image sharpness (frequency). More...
 
enum  ccdsoftColorChannel { cdLuminance = 1, cdRed = 2, cdGreen = 3, cdBlue = 4 }
 Color channels. More...
 
enum  ccdsoftfocTempCompMode { cdfocTempCompMode_None, cdfocTempCompMode_A, cdfocTempCompMode_B }
 Focuser temperature compensation mode. More...
 
enum  ccdsoftCameraState {
  cdStateNone, cdStateTakePicture, cdStateTakePictureSeries, cdStateFocus,
  cdStateMoveGuideStar, cdStateAutoGuide, cdStateCalibrate, cdStateTakeColor,
  cdStateAutoFocus, cdStateAutoFocus2
}
 Camera state. More...
 

Public Slots

int TakeImage ()
 Acquires an image from the camera. More...
 
int Autoguide ()
 Starts autoguiding. More...
 
int Abort ()
 Use this method to abort (stop) any camera operation currently in progress for example TakeImage(), Autoguide(), Calibrate(), etc. More...
 
int Connect ()
 Establishes communication between this camera object and the camera hardware. More...
 
int Disconnect ()
 Terminate the communication between this camera object and the camera hardware. More...
 
int CenterBrightestObject ()
 Center the brightest object on the last acquired photo by using the autoguider. More...
 
int Calibrate (int CalibrateAO)
 Calibrate the autoguider and fill in the calibration results so that autoguiding may be performed. More...
 
int AtFocus ()
 The method runs @Focus2, automated focus routine. More...
 
int TakeColor ()
 This method is not supported. More...
 
int MoveGuideStar ()
 Move the guide star to a different location on the CCD. More...
 
int Move (double FromX, double FromY, double ToX, double ToY)
 Make an autoguiding adjustment. More...
 
int focConnect ()
 Connect the focuser. More...
 
int focDisconnect ()
 Disconnect the focuser. More...
 
int focSettings ()
 Not suppored in TheSkyX. More...
 
int focMoveIn (int lSteps)
 Move the focuser in. More...
 
int focMoveOut (int lSteps)
 Move the focuser out. More...
 
int AtFocus2 ()
 The method runs @Focus2, automated focus routine. More...
 
int filterWheelConnect ()
 Connect the filterwheel. More...
 
int filterWheelDisconnect ()
 Disconnect the filterwheel. More...
 
int filterWheelIsConnected ()
 The method tells if the filterwheel is connected or not. More...
 
int centerAO ()
 This method causes the adaptive optics device to move to the center of its travel. More...
 
int rotatorConnect ()
 Connect the rotator. More...
 
int rotatorDisconnect ()
 Disconnect the rotator. More...
 
int rotatorIsConnected ()
 Returns non zero if the rotator is connected or zero if not connected. More...
 
double rotatorPositionAngle ()
 Returns the position angle of the rotator. More...
 
int rotatorGotoPositionAngle (double dPositionAngle)
 Commands the rotator to synchronously go to the position angle. More...
 
int rotatorIsRotating ()
 Returns non zero if the rotator is rotating or zero if the rotator is not rotating. More...
 
int AtFocus3 (int nAveraging, bool bFullAuto)
 The method runs @Focus3, automated focus routine. More...
 
General, name based get/set methods

Some properties, like the calibration results for the SBIG AO and SBIG external CCD can be otained from these functions. Only use for properties that are explicitly documented.

double PropDbl (QString lpszPropName)
 Returns a double property. More...
 
void setPropDbl (QString lpszPropName, double dVal)
 Sets a double property. More...
 
int PropLng (QString lpszPropName)
 Returns a long property. More...
 
void setPropLng (QString lpszPropName, int nVal)
 Sets a long property. More...
 
QString PropStr (QString lpszPropName)
 Returns a string property. More...
 
void setPropStr (QString lpszPropName, QString qsVal)
 Sets a string property. More...
 
Properties with Parameters

These properties take one or more parameters and are technically methods. The set syntax is not identical to ccdsoft.

QString szFilterName (int lZeroBasedIndex)
 This property retuns the filter name associated with the zero based index to the filter. More...
 
void setszFilterName (int lZeroBasedIndex, QString qsValue)
 This property sets the filter name associated with the zero based index to the filter. More...
 
QString szBinModeFromIndex (int lZeroBasedIndex)
 This property returns the bin mode in a text form (i.e. More...
 
QString ReductionGroupFromIndex (int lZeroBasedIndex)
 This property returns the name of the reduction group for the given zero based index. More...
 
QVariant LRGBArray (int seriesIndex)
 This property is not supported. More...
 
void setLRGBArray (int seriesIndex, QVariant colorData)
 This property is not supported. More...
 

Properties

int WidthInPixels
 This property holds the width of the CCD in pixels. More...
 
int HeightInPixels
 This property holds the height of the CCD in pixels. More...
 
double Temperature
 This property holds temperature of the CCD. More...
 
double ThermalElectricCoolerPower
 This property holds the power applied to the thermo electric cooler of the CCD. More...
 
int IsExposureComplete
 This property tells if an exposure is complete. More...
 
QString ExposureStatus
 This property is a text string representing the exposure status. More...
 
double ExposureTime
 This property holds the exposure time for the TakeImage() method. More...
 
QString LastImageFileName
 This property holds the file path of the last photo acquired (AutoSave must be on). More...
 
QString AutoSavePath
 This property holds the path to the AutoSave folder. More...
 
QString AutoSavePrefix
 This property holds the AutoSave prefix. More...
 
ccdsoftImageReduction ImageReduction
 This property holds the type of image reduction that is applied to each image the camera acquries. More...
 
double Delay
 This property holds pre-exposure delay. More...
 
int Series
 This property holds the number of images TakeImage() will acquire when greater than 1. More...
 
int FilterIndexZeroBased
 This property holds the zero based filter of index for the filter wheel that is selected when TakeImage() is called. More...
 
int Subframe
 This property indicates if a subframe is active (non-zero) or not (zero) More...
 
int SubframeLeft
 This property holds the left coordinate of the subframe. More...
 
int SubframeTop
 This property holds the top coordinate of the subframe. More...
 
int SubframeRight
 This property holds the right coordinate of the subframe. More...
 
int SubframeBottom
 This property holds the bottom coordinate of the subframe. More...
 
int BinX
 This property holds x bin factor of the CCD. More...
 
int BinY
 This property holds y bin factor of the CCD. More...
 
int ToNewWindow
 This property holds whether or not to display acquired images in a new window or not. More...
 
int Autoguider
 This property holds whether or not this object is the autoguider (non-zero) or the imager (zero). More...
 
int Asynchronous
 The property holds if the ccdsoftCamera object is operating synchronously or asynchronously. More...
 
int lNumberFilters
 This property returns the number of unique filter positions in the filter wheel. More...
 
int lNumberBins
 This property returns the number of bin modes the camera has. More...
 
int ReductionGroupCount
 This property returns the number of image reduction (or calibration) groups that exist in the Image Calibration Library. More...
 
ccdsoftImageFrame Frame
 This property holds the type of frame that TakeImage will acquire. More...
 
ccdsoftSBIGGuiderAntiBloom SBIGGuiderAntiBloom
 This property holds the antiblooming setting for the SBIG autoguider. More...
 
int SBIGOffChipBinning
 This property holds the off chip binning setting for the SBIG camera. More...
 
int ImageUseDigitizedSkySurvey
 This property holds whether or not images acquired by the camera have a simulated image using the Digitized Sky Survey. More...
 
int ReverseX
 This property causes autoguiding adjustments reverse in the x direction. More...
 
int ShowAutoguider
 When set to false the autoguider image isn't shown while autoguiding to increase through put. More...
 
double GuideStarX
 This property holds the x coordinate of the destination guide star position. More...
 
double GuideStarY
 This property holds the y coordinate of the destination guide star position. More...
 
ccdsoftMoveVia MoveVia
 This property holds the means by which autoguiding adjustments are made. More...
 
int TrackBoxX
 This property holds the width of the autoguiding track box. More...
 
int TrackBoxY
 This property holds the height of the autoguiding track box. More...
 
int SavedCalibrationTimeX
 This property holds the X autoguider calibration time. More...
 
int SavedCalibrationTimeY
 This property holds the Y autoguider calibration time. More...
 
int EnabledXAxis
 This property holds if the x autoguider adjustments are enabled or not. More...
 
int EnabledYAxis
 This property holds if the y autoguider adjustments are enabled or not. More...
 
int AutoSaveOn
 This property holds if images acquired by the camera are automatically saved. More...
 
int AutoguiderAggressiveness
 This property holds the autoguider aggressiveness. More...
 
int AutoguiderMinimumMove
 This property the autoguider minium move. More...
 
int AutoguiderMaximumMove
 This property the autoguider maximum move. More...
 
double AutoguiderBacklashXAxis
 This property holds the autoguider backlash in seconds for the x. More...
 
double AutoguiderBacklashYAxis
 This property holds the autoguider backlash in seconds for the y. More...
 
int AutoguiderDelayAfterCorrection
 This property holds the delay after each autoguider correction. More...
 
int AutoguiderLogData
 This property indicates if an autoguider log is caputured during autoguiding. More...
 
int AutoguiderCalibrationTimeXAxis
 This property holds the autoguider calibration time for the x relay. More...
 
int AutoguiderCalibrationTimeYAxis
 This property holds the autoguider calibration time for the y relay. More...
 
int RegulateTemperature
 This property holds if camera temperature regulation is on or off. More...
 
int MoveToX
 This property holds the x coordinate of the guide star for the MoveGuideStar() method. More...
 
int MoveToY
 This property holds the x coordinate of the guide star for the MoveGuideStar() method. More...
 
int ColorSeries
 This property holds the number of color series to take with the TakeColor method. More...
 
int AutoSaveFocusImages
 This property sets wheter or not AutoSave applies when acquiring focus images. More...
 
int ScreenShutter
 This property turns off and on the screen shutter. More...
 
int HighPriorityDownloads
 This property turns on high priority downloads. More...
 
int DownloadAbortedExposures
 This property enables download of aborted exposures when the exposure time exceeds DownloadAbortedExposuresAfterSeconds. More...
 
int DownloadAbortedExposuresAfterSeconds
 This property holds the threshold of when aborted exposures are downloaded or not. More...
 
int SaveImagesWithUTC
 This property causes images to saved using UTC time. More...
 
int ShutDownTemperatureRegulationOnDisconnect
 This property causes temperature regulation to turn off upon disconnect. More...
 
ccdsoftAutoSaveAs AutoSaveFileFormat
 Not applicable in TheSkyX, only FITS is supported. More...
 
ccdsoftFocusGraph FocusGraphType
 Not applicable in TheSkyX since its focus graphs superceed CCDSoft. More...
 
int AtFocusSamples
 This property holds the number of samples using during an AtFocus2 run. More...
 
int AtFocusAveraging
 This property holds the averaging used during an AtFocus2 run. More...
 
int AtFocusInitialMoveDirection
 Not applicable in TheSkyX. More...
 
int AutoContrast
 Not applicable in TheSkyX. More...
 
int SBIGFanOn
 This property controls if the SBIG fan is on (non-zero) or off (zero). More...
 
int ContinuousFocus
 This property controls if images are acquired continuously on the focus tab. More...
 
double AutoguiderExposureTime
 This property holds the autoguide exposure time. More...
 
ccdsoftInterface CameraInterface
 This property holds the physical interface to SBIG cameras. More...
 
double DeclinationAtCalibration
 This property holds the declination at the time the autoguider was calibrated. More...
 
double TelescopeDeclination
 This property holds the declination where autougiding is presently being performed. More...
 
double TemperatureSetPoint
 This property holds the temperature setpoint for the CCD. More...
 
QString ReductionGroupName
 This property holds the image reduction name. More...
 
int lAsynchronous
 See. More...
 
double FocusExposureTime
 This property holds the exposure time for the focus tab. More...
 
ccdsoftfocTempCompMode focTemperatureCompensationMode
 This property holds the temperature compensation mode for the focuser. More...
 
int focBacklash
 Not applicable in TheSkyX. More...
 
int focMaximumLimit
 This property holds the maximum limit of the focuser. More...
 
int focMinimumLimit
 This property holds the minimum limit of the focuser. More...
 
int focSmallStepSize
 Not applicable in TheSkyX. More...
 
int focLargeStepSize
 Not applicable in TheSkyX. More...
 
int focPort
 This property holds the port the focuser is connected too. More...
 
double focTemperature
 This property holds the temperature reported by the focuser. More...
 
QString Status
 This property holds the camera status text. More...
 
int Percent
 This property holds the camera status percentage. More...
 
ccdsoftCameraState State
 This property holds the camera state. More...
 
double GuideErrorX
 This property holds the x guide error. More...
 
double GuideErrorY
 This property holds the y guide error. More...
 
double MaximumPixel
 This property holds the maximum pixel found in the last acquired image. More...
 
int focIsConnected
 This property holds if the focuser is connected or not. More...
 
int focPosition
 This property holds the focuser position. More...
 
Autoguider Calibration Results

These properties hold the results of autoguider calibration.

See also
Calibrate() and Calibration Results for SBIG External CCD and SBIG AO
double CalibrationVectorXPositiveXComponent
 Calibration result. More...
 
double CalibrationVectorXPositiveYComponent
 Calibration result. More...
 
double CalibrationVectorYPositiveXComponent
 Calibration result. More...
 
double CalibrationVectorYPositiveYComponent
 Calibration result. More...
 
double CalibrationVectorXNegativeXComponent
 Calibration result. More...
 
double CalibrationVectorXNegativeYComponent
 Calibration result. More...
 
double CalibrationVectorYNegativeXComponent
 Calibration result. More...
 
double CalibrationVectorYNegativeYComponent
 Calibration result. More...
 

Detailed Description

TheSkyX ccdsoftCamera object.

The ccdsoftCamera object allows scripted control of any camera compatible with TheSkyX in a way that closely matches the camera scripting interface offered by CCDSoft.

Member Enumeration Documentation

Automatically save images as native SBIG camera or FITS file format.

Enumerator
cdFITS 

Save as FITS.

cdSBIG 

Save as SBIG.

Camera state.

Enumerator
cdStateNone 

Camera is idle.

cdStateTakePicture 

Camera is taking a picture.

cdStateTakePictureSeries 

Camera is taking a seriesof pictures.

cdStateFocus 

Camera is acquiring focus pictures.

cdStateMoveGuideStar 

Camera is moving the guide star.

cdStateAutoGuide 

Camera is autoguiding.

cdStateCalibrate 

Camera is calibrating the autoguider.

cdStateTakeColor 

Camera is taking a color image.

cdStateAutoFocus 

Camera is performing autofocus.

cdStateAutoFocus2 

Camera is performing autofocus.

Color channels.

Enumerator
cdLuminance 

Luminace.

cdRed 

Red.

cdGreen 

Green.

cdBlue 

Blue.

Focuser temperature compensation mode.

Enumerator
cdfocTempCompMode_None 

No focuser temperature compensation.

cdfocTempCompMode_A 

Focuser temperature mode A.

cdfocTempCompMode_B 

Focuser temperature mode B.

Graph focus by maximum value or image sharpness (frequency).

Enumerator
cdMaximumValue 

Focus graph shows maximum value.

cdSharpness 

Focus graph shows sharpness.

The Image Frame type.

Enumerator
cdLight 

A light frame.

cdBias 

A bias frame.

cdDark 

A dark frame.

cdFlat 

A flat frame.

The ccdsoftImageReduction enum.

Enumerator
cdNone 

No image reduction is performed on each acquired image.

cdAutoDark 

A dark frame is automatically acquired and subtracted from light frames.

cdBiasDarkFlat 

Full image reduction is performed on each acquired image based on the Image Calibration Library.

See also
ImageReduction ReductionGroupName

SBIG Camera communications physical interface.

Enumerator
cdNoPort 

No port.

cdLPT1 

LPT1.

cdLPT2 

LPT2.

cdLPT3 

LPT3.

cdUSB 

USB.

cdEthernet 

Ethernet.

Move via Relays, RelayAPI, DirectGuide, PulseGuide or using the SBIG AO.

Enumerator
cdAutoguideViaRelays 

Autoguiding corrections will be made by camera relays.

cdAutoguideViaRelayAPI 

Autoguiding corrections will be made by the RelaAPI.

cdAutoguideViaDirectGuide 

Autoguiding corrections will be made by DirectGuide.

cdAutoguideViaPulseGuide 

Autoguiding corrections will be made by Pulse Guide.

cdAutoguideViaAO 

Internal to Software Bisque only do not use.

SBIG Autoguider AntiBlooming.

Enumerator
cdAntiBloomOff 

Antiblooming off.

cdAntiBloomLow 

Antiblooming low.

cdAntiBloomMedium 

Antiblooming medium.

cdAntiBloomHigh 

Antiblooming high.

Member Function Documentation

int ccdsoftCamera::Abort ( )
slot

Use this method to abort (stop) any camera operation currently in progress for example TakeImage(), Autoguide(), Calibrate(), etc.

Possible method return values

int ccdsoftCamera::AtFocus ( )
slot

The method runs @Focus2, automated focus routine.

TheSkyX only supports @Focus2. Possible method return values

int ccdsoftCamera::AtFocus2 ( )
slot

The method runs @Focus2, automated focus routine.

Possible method return values

int ccdsoftCamera::AtFocus3 ( int  nAveraging,
bool  bFullAuto 
)
slot

The method runs @Focus3, automated focus routine.

Parameters
nAveragingis the number of samples acquired at each focus position. Supported values are 1, 2, 3.
bFullAutowhen true (a non zero value), means one sample per focus position, automatically determines exposure time and optimal subframe. bFullAuto will take one full frame photo and determine what the best subframe should be from that.

Notes:

  • It uses the camera filter currently set.
  • Will start with the camera focus exposure time currently set.
  • Exposure time may be internally adjusted with or without bFullAuto on depending on signal found in photos.

Possible method return values

int ccdsoftCamera::Autoguide ( )
slot

Starts autoguiding.

Possible method return values

See also
Autoguider
int ccdsoftCamera::Calibrate ( int  CalibrateAO)
slot

Calibrate the autoguider and fill in the calibration results so that autoguiding may be performed.

The method must be called before Autoguide(). Possible method return values

Parameters
[in]CalibrateAOSet to 1 to calibrate an attached AO device, otherwise the autoguider is calibrated.
See also
MoveVia
int ccdsoftCamera::centerAO ( )
slot

This method causes the adaptive optics device to move to the center of its travel.

This method was added in TheSky build 7968. Note: clients using the CCDSoft2XAdaptor object can call this method by setting the property 'Camera.PropLng("centerAO()") = 1' as a workaround to avoid changing that interface (especially for those using early binding). Possible method return values

See also
Application.build.
int ccdsoftCamera::CenterBrightestObject ( )
slot

Center the brightest object on the last acquired photo by using the autoguider.

Possible method return values

See also
MoveVia.
int ccdsoftCamera::Connect ( )
slot

Establishes communication between this camera object and the camera hardware.

Possible method return values

int ccdsoftCamera::Disconnect ( )
slot

Terminate the communication between this camera object and the camera hardware.

Possible method return values

int ccdsoftCamera::filterWheelConnect ( )
slot

Connect the filterwheel.

Possible method return values

int ccdsoftCamera::filterWheelDisconnect ( )
slot

Disconnect the filterwheel.

Possible method return values

int ccdsoftCamera::filterWheelIsConnected ( )
slot

The method tells if the filterwheel is connected or not.

Possible method return values

int ccdsoftCamera::focConnect ( )
slot

Connect the focuser.

Possible method return values

int ccdsoftCamera::focDisconnect ( )
slot

Disconnect the focuser.

Possible method return values

int ccdsoftCamera::focMoveIn ( int  lSteps)
slot

Move the focuser in.

Possible method return values

int ccdsoftCamera::focMoveOut ( int  lSteps)
slot

Move the focuser out.

Possible method return values

int ccdsoftCamera::focSettings ( )
slot

Not suppored in TheSkyX.

QVariant ccdsoftCamera::LRGBArray ( int  seriesIndex)
slot

This property is not supported.

int ccdsoftCamera::Move ( double  FromX,
double  FromY,
double  ToX,
double  ToY 
)
slot

Make an autoguiding adjustment.

This method isn't normally called as clients call the Autoguide() method to perform autoguiding. Use this method to perform custom autoguiding. Possible method return values

int ccdsoftCamera::MoveGuideStar ( )
slot

Move the guide star to a different location on the CCD.

This isn't autoguiding, but rather a means to change where autoguiding occurs on the CCD. Possible method return values

See also
MoveToX MoveToY
double ccdsoftCamera::PropDbl ( QString  lpszPropName)
slot

Returns a double property.

int ccdsoftCamera::PropLng ( QString  lpszPropName)
slot

Returns a long property.

QString ccdsoftCamera::PropStr ( QString  lpszPropName)
slot

Returns a string property.

QString ccdsoftCamera::ReductionGroupFromIndex ( int  lZeroBasedIndex)
slot

This property returns the name of the reduction group for the given zero based index.

See also
ReductionGroupCount.
int ccdsoftCamera::rotatorConnect ( )
slot

Connect the rotator.

This method was added in TheSky build 9223, see Application.build. Possible method return values

int ccdsoftCamera::rotatorDisconnect ( )
slot

Disconnect the rotator.

This method was added in TheSky build 9223, see Application.build.Possible method return values

int ccdsoftCamera::rotatorGotoPositionAngle ( double  dPositionAngle)
slot

Commands the rotator to synchronously go to the position angle.

This method was added in TheSky build 9223, see Application.build. Possible method return values

int ccdsoftCamera::rotatorIsConnected ( )
slot

Returns non zero if the rotator is connected or zero if not connected.

This method was added in TheSky build 9223, see Application.build.

int ccdsoftCamera::rotatorIsRotating ( )
slot

Returns non zero if the rotator is rotating or zero if the rotator is not rotating.

This method was added in TheSky build 9223, see Application.build.

double ccdsoftCamera::rotatorPositionAngle ( )
slot

Returns the position angle of the rotator.

This method was added in TheSky build 9223, see Application.build.

void ccdsoftCamera::setLRGBArray ( int  seriesIndex,
QVariant  colorData 
)
slot

This property is not supported.

void ccdsoftCamera::setPropDbl ( QString  lpszPropName,
double  dVal 
)
slot

Sets a double property.

void ccdsoftCamera::setPropLng ( QString  lpszPropName,
int  nVal 
)
slot

Sets a long property.

void ccdsoftCamera::setPropStr ( QString  lpszPropName,
QString  qsVal 
)
slot

Sets a string property.

void ccdsoftCamera::setszFilterName ( int  lZeroBasedIndex,
QString  qsValue 
)
slot

This property sets the filter name associated with the zero based index to the filter.

QString ccdsoftCamera::szBinModeFromIndex ( int  lZeroBasedIndex)
slot

This property returns the bin mode in a text form (i.e.

"1x1", "2x2", etc.) for the given zero based index

See also
lNumberBins.
QString ccdsoftCamera::szFilterName ( int  lZeroBasedIndex)
slot

This property retuns the filter name associated with the zero based index to the filter.

int ccdsoftCamera::TakeColor ( )
slot

This method is not supported.

Note, all the primatives are available to take an LRBG Image. At some point in the furture, this method and LRGBArray might be mapped into TheSkyX's more flexilble Take Series capabilities. Possible method return values

int ccdsoftCamera::TakeImage ( )
slot

Acquires an image from the camera.

Possible method return values

Property Documentation

ccdsoftCamera::Asynchronous
readwrite

The property holds if the ccdsoftCamera object is operating synchronously or asynchronously.

See the Synchronous vs. Asynchronous Execution topic for more information about the differences between these methods of execution.

int ccdsoftCamera::AtFocusAveraging
readwrite

This property holds the averaging used during an AtFocus2 run.

int ccdsoftCamera::AtFocusInitialMoveDirection
readwrite

Not applicable in TheSkyX.

This property holds the initial direction for legacy AtFocus runs, TheSkyX only supports AtFocus2.

int ccdsoftCamera::AtFocusSamples
readwrite

This property holds the number of samples using during an AtFocus2 run.

int ccdsoftCamera::AutoContrast
readwrite

Not applicable in TheSkyX.

int ccdsoftCamera::Autoguider
readwrite

This property holds whether or not this object is the autoguider (non-zero) or the imager (zero).

int ccdsoftCamera::AutoguiderAggressiveness
readwrite

This property holds the autoguider aggressiveness.

10 = nominal aggressiveness, autoguiding corrections are made to their full amount; 5 = 50% where autoguiding corrections are made to half there amount. This method gives a means to deaden or amplify autoguiding corrections.

double ccdsoftCamera::AutoguiderBacklashXAxis
readwrite

This property holds the autoguider backlash in seconds for the x.

double ccdsoftCamera::AutoguiderBacklashYAxis
readwrite

This property holds the autoguider backlash in seconds for the y.

int ccdsoftCamera::AutoguiderCalibrationTimeXAxis
readwrite

This property holds the autoguider calibration time for the x relay.

int ccdsoftCamera::AutoguiderCalibrationTimeYAxis
readwrite

This property holds the autoguider calibration time for the y relay.

int ccdsoftCamera::AutoguiderDelayAfterCorrection
readwrite

This property holds the delay after each autoguider correction.

double ccdsoftCamera::AutoguiderExposureTime
readwrite

This property holds the autoguide exposure time.

int ccdsoftCamera::AutoguiderLogData
readwrite

This property indicates if an autoguider log is caputured during autoguiding.

int ccdsoftCamera::AutoguiderMaximumMove
readwrite

This property the autoguider maximum move.

The units are in one-thousandths of one second. For example, a value of 5.0 equals 0.005 seconds.

int ccdsoftCamera::AutoguiderMinimumMove
readwrite

This property the autoguider minium move.

The units are in one-thousandths of one second. For example, a value of 5.0 equals 0.005 seconds.

ccdsoftAutoSaveAs ccdsoftCamera::AutoSaveFileFormat
readwrite

Not applicable in TheSkyX, only FITS is supported.

This property holds the type of format AutoSave saves in.

int ccdsoftCamera::AutoSaveFocusImages
readwrite

This property sets wheter or not AutoSave applies when acquiring focus images.

int ccdsoftCamera::AutoSaveOn
readwrite

This property holds if images acquired by the camera are automatically saved.

QString ccdsoftCamera::AutoSavePath
readwrite

This property holds the path to the AutoSave folder.

QString ccdsoftCamera::AutoSavePrefix
readwrite

This property holds the AutoSave prefix.

int ccdsoftCamera::BinX
readwrite

This property holds x bin factor of the CCD.

int ccdsoftCamera::BinY
readwrite

This property holds y bin factor of the CCD.

double ccdsoftCamera::CalibrationVectorXNegativeXComponent
readwrite

Calibration result.

Negative x vector, x component.

double ccdsoftCamera::CalibrationVectorXNegativeYComponent
readwrite

Calibration result.

Negative x vector, y component.

double ccdsoftCamera::CalibrationVectorXPositiveXComponent
readwrite

Calibration result.

Positive x vector, x component.

double ccdsoftCamera::CalibrationVectorXPositiveYComponent
readwrite

Calibration result.

Positive x vector, y component.

double ccdsoftCamera::CalibrationVectorYNegativeXComponent
readwrite

Calibration result.

Negative y vector, x component.

double ccdsoftCamera::CalibrationVectorYNegativeYComponent
readwrite

Calibration result.

Negative y vector, y component.

double ccdsoftCamera::CalibrationVectorYPositiveXComponent
readwrite

Calibration result.

Positive y vector, x component.

double ccdsoftCamera::CalibrationVectorYPositiveYComponent
readwrite

Calibration result.

Positive y vector, y component.

ccdsoftInterface ccdsoftCamera::CameraInterface
readwrite

This property holds the physical interface to SBIG cameras.

int ccdsoftCamera::ColorSeries
readwrite

This property holds the number of color series to take with the TakeColor method.

int ccdsoftCamera::ContinuousFocus
readwrite

This property controls if images are acquired continuously on the focus tab.

double ccdsoftCamera::DeclinationAtCalibration
readwrite

This property holds the declination at the time the autoguider was calibrated.

double ccdsoftCamera::Delay
readwrite

This property holds pre-exposure delay.

int ccdsoftCamera::DownloadAbortedExposures
readwrite

This property enables download of aborted exposures when the exposure time exceeds DownloadAbortedExposuresAfterSeconds.

See also
DownloadAbortedExposuresAfterSeconds
int ccdsoftCamera::DownloadAbortedExposuresAfterSeconds
readwrite

This property holds the threshold of when aborted exposures are downloaded or not.

See also
DownloadAbortedExposures.
int ccdsoftCamera::EnabledXAxis
readwrite

This property holds if the x autoguider adjustments are enabled or not.

int ccdsoftCamera::EnabledYAxis
readwrite

This property holds if the y autoguider adjustments are enabled or not.

QString ccdsoftCamera::ExposureStatus
read

This property is a text string representing the exposure status.

double ccdsoftCamera::ExposureTime
readwrite

This property holds the exposure time for the TakeImage() method.

int ccdsoftCamera::FilterIndexZeroBased
readwrite

This property holds the zero based filter of index for the filter wheel that is selected when TakeImage() is called.

Note by design setting this property does not immediately change the filter wheel position but rather the change will occur when TakeImage() is called. Also, reading this value does not provide the index of the filter that is currently in place in the filter wheel hardware. However, TheSkyX build 10225 provides a means to read or get the index of the filter that is currently in place in the filter hardware (see Application::build to determine the build of TheSky in use an act accordingly for your situation). Simply use the generic name based accessor for this property and append the special key "Real-Time" to the property name.

For example, the following vb code:

Set Cam = CreateObject("TheSkyX.ccdsoftCamera")
MsgBox Cam.propLng("m_nFilterIndex Real-Time")

will display a message box with the filter index that is current selected in the filter hardware. This mechanism was added primarily to allow external programs the ability to query the current filter index in the filter wheel hardware and change focus offsets accordingly. An alternative is to use TheSky's ability to automatically change focus offsets based on filters by entering the 'Focus Offset' column value for each filter under the 'Filter Names Setup' window.

int ccdsoftCamera::focBacklash
readwrite

Not applicable in TheSkyX.

int ccdsoftCamera::focIsConnected
read

This property holds if the focuser is connected or not.

int ccdsoftCamera::focLargeStepSize
readwrite

Not applicable in TheSkyX.

int ccdsoftCamera::focMaximumLimit
read

This property holds the maximum limit of the focuser.

int ccdsoftCamera::focMinimumLimit
read

This property holds the minimum limit of the focuser.

int ccdsoftCamera::focPort
readwrite

This property holds the port the focuser is connected too.

int ccdsoftCamera::focPosition
read

This property holds the focuser position.

int ccdsoftCamera::focSmallStepSize
readwrite

Not applicable in TheSkyX.

double ccdsoftCamera::focTemperature
readwrite

This property holds the temperature reported by the focuser.

ccdsoftfocTempCompMode ccdsoftCamera::focTemperatureCompensationMode
readwrite

This property holds the temperature compensation mode for the focuser.

double ccdsoftCamera::FocusExposureTime
readwrite

This property holds the exposure time for the focus tab.

ccdsoftFocusGraph ccdsoftCamera::FocusGraphType
readwrite

Not applicable in TheSkyX since its focus graphs superceed CCDSoft.

This property holds the type of graph while focusing.

ccdsoftImageFrame ccdsoftCamera::Frame
readwrite

This property holds the type of frame that TakeImage will acquire.

double ccdsoftCamera::GuideErrorX
readwrite

This property holds the x guide error.

double ccdsoftCamera::GuideErrorY
readwrite

This property holds the y guide error.

double ccdsoftCamera::GuideStarX
readwrite

This property holds the x coordinate of the destination guide star position.

double ccdsoftCamera::GuideStarY
readwrite

This property holds the y coordinate of the destination guide star position.

int ccdsoftCamera::HeightInPixels
read

This property holds the height of the CCD in pixels.

int ccdsoftCamera::HighPriorityDownloads
readwrite

This property turns on high priority downloads.

ccdsoftImageReduction ccdsoftCamera::ImageReduction
readwrite

This property holds the type of image reduction that is applied to each image the camera acquries.

int ccdsoftCamera::ImageUseDigitizedSkySurvey
readwrite

This property holds whether or not images acquired by the camera have a simulated image using the Digitized Sky Survey.

int ccdsoftCamera::IsExposureComplete
read

This property tells if an exposure is complete.

See the Synchronous vs. Asynchronous Execution topic for more information about the differences between these methods of execution.

QString ccdsoftCamera::LastImageFileName
read

This property holds the file path of the last photo acquired (AutoSave must be on).

int ccdsoftCamera::lAsynchronous
readwrite

See.

See also
Asynchronous.
int ccdsoftCamera::lNumberBins
read

This property returns the number of bin modes the camera has.

int ccdsoftCamera::lNumberFilters
read

This property returns the number of unique filter positions in the filter wheel.

double ccdsoftCamera::MaximumPixel
read

This property holds the maximum pixel found in the last acquired image.

int ccdsoftCamera::MoveToX
readwrite

This property holds the x coordinate of the guide star for the MoveGuideStar() method.

int ccdsoftCamera::MoveToY
readwrite

This property holds the x coordinate of the guide star for the MoveGuideStar() method.

ccdsoftMoveVia ccdsoftCamera::MoveVia
readwrite

This property holds the means by which autoguiding adjustments are made.

int ccdsoftCamera::Percent
readwrite

This property holds the camera status percentage.

int ccdsoftCamera::ReductionGroupCount
read

This property returns the number of image reduction (or calibration) groups that exist in the Image Calibration Library.

See also
ReductionGroupFromIndex ImageReduction
QString ccdsoftCamera::ReductionGroupName
readwrite

This property holds the image reduction name.

See also
ImageReduction
int ccdsoftCamera::RegulateTemperature
readwrite

This property holds if camera temperature regulation is on or off.

int ccdsoftCamera::ReverseX
readwrite

This property causes autoguiding adjustments reverse in the x direction.

This allows using the same calibration results for GEM that has been calibrated one side of the meridian but is now autoguiding on the other side of the meridian.

int ccdsoftCamera::SavedCalibrationTimeX
readwrite

This property holds the X autoguider calibration time.

The units are 1/100s of a second, for example a value of 500 equals 5 seconds.

int ccdsoftCamera::SavedCalibrationTimeY
readwrite

This property holds the Y autoguider calibration time.

The units are 1/100s of a second, for example a value of 500 equals 5 seconds.

int ccdsoftCamera::SaveImagesWithUTC
readwrite

This property causes images to saved using UTC time.

int ccdsoftCamera::SBIGFanOn
readwrite

This property controls if the SBIG fan is on (non-zero) or off (zero).

ccdsoftSBIGGuiderAntiBloom ccdsoftCamera::SBIGGuiderAntiBloom
readwrite

This property holds the antiblooming setting for the SBIG autoguider.

int ccdsoftCamera::SBIGOffChipBinning
readwrite

This property holds the off chip binning setting for the SBIG camera.

int ccdsoftCamera::ScreenShutter
readwrite

This property turns off and on the screen shutter.

int ccdsoftCamera::Series
readwrite

This property holds the number of images TakeImage() will acquire when greater than 1.

int ccdsoftCamera::ShowAutoguider
readwrite

When set to false the autoguider image isn't shown while autoguiding to increase through put.

int ccdsoftCamera::ShutDownTemperatureRegulationOnDisconnect
readwrite

This property causes temperature regulation to turn off upon disconnect.

ccdsoftCameraState ccdsoftCamera::State
read

This property holds the camera state.

QString ccdsoftCamera::Status
readwrite

This property holds the camera status text.

int ccdsoftCamera::Subframe
readwrite

This property indicates if a subframe is active (non-zero) or not (zero)

See also
SubframeLeft, SubframeTop, SubframeRight, SubframeBottom
int ccdsoftCamera::SubframeBottom
readwrite

This property holds the bottom coordinate of the subframe.

int ccdsoftCamera::SubframeLeft
readwrite

This property holds the left coordinate of the subframe.

int ccdsoftCamera::SubframeRight
readwrite

This property holds the right coordinate of the subframe.

int ccdsoftCamera::SubframeTop
readwrite

This property holds the top coordinate of the subframe.

double ccdsoftCamera::TelescopeDeclination
readwrite

This property holds the declination where autougiding is presently being performed.

double ccdsoftCamera::Temperature
read

This property holds temperature of the CCD.

double ccdsoftCamera::TemperatureSetPoint
readwrite

This property holds the temperature setpoint for the CCD.

double ccdsoftCamera::ThermalElectricCoolerPower
read

This property holds the power applied to the thermo electric cooler of the CCD.

int ccdsoftCamera::ToNewWindow
readwrite

This property holds whether or not to display acquired images in a new window or not.

int ccdsoftCamera::TrackBoxX
readwrite

This property holds the width of the autoguiding track box.

int ccdsoftCamera::TrackBoxY
readwrite

This property holds the height of the autoguiding track box.

int ccdsoftCamera::WidthInPixels
read

This property holds the width of the CCD in pixels.

ScriptTheSkyX Examples
(C) Software Bisque, Inc. All rights reserved.