Click or drag to resize

Camera Class

Implements a camera class to access any registered ASCOM Camera
Inheritance Hierarchy
SystemObject
  ASCOM.DriverAccessAscomDriver
    ASCOM.DriverAccessCamera

Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0
Syntax
Copy
public class Camera : AscomDriver, ICameraV4

The Camera type exposes the following members.

Constructors
 NameDescription
Public methodCamera Creates an instance of the camera class.
Top
Properties
 NameDescription
Public propertyBayerOffsetX Returns the X offset of the Bayer matrix, as defined in SensorType.
Public propertyBayerOffsetY Returns the Y offset of the Bayer matrix, as defined in SensorType.
Public propertyBinX Sets the binning factor for the X axis, also returns the current value.
Public propertyBinY Sets the binning factor for the Y axis, also returns the current value.
Public propertyCameraDeviceState Camera device state
Public propertyCameraState Returns the current camera operational state
Public propertyCameraXSize Returns the width of the CCD camera chip in unbinned pixels.
Public propertyCameraYSize Returns the height of the CCD camera chip in unbinned pixels.
Public propertyCanAbortExposure Returns true if the camera can abort exposures; false if not.
Public propertyCanAsymmetricBin Returns a flag showing whether this camera supports asymmetric binning
Public propertyCanFastReadout Camera has a fast readout mode
Public propertyCanGetCoolerPower If true, the camera's cooler power setting can be read.
Public propertyCanPulseGuide Returns a flag indicating whether this camera supports pulse guiding
Public propertyCanSetCCDTemperature Returns a flag indicating whether this camera supports setting the CCD temperature
Public propertyCanStopExposure Returns a flag indicating whether this camera can stop an exposure that is in progress
Public propertyCCDTemperature Returns the current CCD temperature in degrees Celsius.
Public propertyConnected Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.
(Inherited from AscomDriver)
Public propertyConnecting Returns True while the device is undertaking an asynchronous connect or disconnect operation.
(Inherited from AscomDriver)
Public propertyCoolerOn Turns on and off the camera cooler, and returns the current on/off state.
Public propertyCoolerPower Returns the present cooler power level, in percent.
Public propertyDescription Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
(Inherited from AscomDriver)
Public propertyDeviceState Returns the device's operational state in a single call.
(Inherited from AscomDriver)
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AscomDriver)
Public propertyDriverVersion A string containing only the major and minor version of the driver.
(Inherited from AscomDriver)
Public propertyElectronsPerADU Returns the gain of the camera in photoelectrons per A/D unit.
Public propertyExposureMax Returns the maximum exposure time supported by StartExposure.
Public propertyExposureMin Minimum exposure time
Public propertyExposureResolution Exposure resolution
Public propertyFastReadout Gets or sets Fast Readout Mode
Public propertyFullWellCapacity Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.)
Public propertyGain The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE)
Public propertyGainMax Maximum Gain value of that this camera supports
Public propertyGainMin Minimum Gain value of that this camera supports
Public propertyGains List of Gain names supported by the camera
Public propertyHasConnectAndDeviceState Returns if the device has a Platform 7 or later interface that supports Connect / Disconnect and DeviceState
(Inherited from AscomDriver)
Public propertyHasShutter Returns a flag indicating whether this camera has a mechanical shutter
Public propertyHeatSinkTemperature Returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius.
Public propertyImageArray Returns an array of int of size NumX * NumY containing the pixel values from the last exposure.
Public propertyImageArrayVariant Returns an array of COM-Variant of size NumX * NumY containing the pixel values from the last exposure.
Public propertyImageReady Returns a flag indicating whether the image is ready to be downloaded from the camera
Public propertyInterfaceVersion The interface version number that this device supports.
(Inherited from AscomDriver)
Public propertyIsPulseGuiding Returns a flag indicating whether the camera is currently in a PulseGuide operation.
Public propertyLastExposureDuration Reports the actual exposure duration in seconds (i.e. shutter open time).
Public propertyLastExposureStartTime Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format. The start time must be UTC.
Public propertyMaxADU Reports the maximum ADU value the camera can produce.
Public propertyMaxBinX Returns the maximum allowed binning for the X camera axis
Public propertyMaxBinY Returns the maximum allowed binning for the Y camera axis
Public propertyName The short name of the driver, for display purposes
(Inherited from AscomDriver)
Public propertyNumX Sets the subframe width. Also returns the current value.
Public propertyNumY Sets the subframe height. Also returns the current value.
Public propertyOffset The camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the Offsets array (OFFSETS INDEX MODE)
Public propertyOffsetMax Maximum Offset value that this camera supports
Public propertyOffsetMin Minimum Offset value that this camera supports
Public propertyOffsets List of Offset names supported by the camera
Public propertyPercentCompleted Percent completed, Interface Version 2 and later
Public propertyPixelSizeX Returns the width of the CCD chip pixels in microns.
Public propertyPixelSizeY Returns the height of the CCD chip pixels in microns.
Public propertyReadoutMode Readout mode, Interface Version 2 only
Public propertyReadoutModes List of available readout modes, Interface Version 2 only
Public propertySensorName Sensor name, Interface Version 2 and later
Public propertySensorType Type of colour information returned by the camera sensor, Interface Version 2 and later
Public propertySetCCDTemperature Sets the camera cooler set-point in degrees Celsius, and returns the current set-point.
Public propertyStartX Sets the subframe start position for the X axis (0 based) and returns the current value.
Public propertyStartY Sets the subframe start position for the Y axis (0 based). Also returns the current value.
Public propertySubExposureDuration Camera's sub-exposure interval
Public propertySupportedActionsReturns the list of custom action names supported by this driver.
(Inherited from AscomDriver)
Top
Methods
 NameDescription
Public methodAbortExposure Aborts the current exposure, if any, and returns the camera to Idle state.
Public methodActionInvokes the specified device-specific custom action.
(Inherited from AscomDriver)
Public methodStatic memberChoose The Choose() method returns the DriverID of the selected driver. Choose() allows you to optionally pass the DriverID of a "current" driver, and the corresponding camera type is pre-selected in the Chooser///s list. In this case, the OK button starts out enabled (lit-up); the assumption is that the pre-selected driver has already been configured.
Public methodCommandBlind Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodCommandBool Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodCommandString Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver)
Public methodConnect Connect to the device asynchronously
(Inherited from AscomDriver)
Public methodDisconnect Disconnect from the device asynchronously
(Inherited from AscomDriver)
Public methodDispose This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method.
(Inherited from AscomDriver)
Public methodPulseGuide Activates the Camera's mount control system to instruct the mount to move in a particular direction for a given period of time
Public methodSetupDialog Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancel manually.
(Inherited from AscomDriver)
Public methodStartExposure Starts an exposure. Use ImageReady to check when the exposure is complete.
Public methodStopExposure Stops the current exposure, if any.
Top
See Also