ICameraV3Gain Property |
Namespace: ASCOM.DeviceInterface
GAIN VALUE MODE: The current gain value.
OR
GAINS INDEX MODE: Index into the Gains array for the current camera gainException | Condition |
---|---|
PropertyNotImplementedException | When neither GAINS INDEX mode nor GAIN VALUE mode are supported. |
InvalidValueException | When the supplied value is not valid. |
NotConnectedException | If the device is not connected |
DriverException | An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. |
This is an optional property and can throw a PropertyNotImplementedException if Gain is not supported by the camera.
The Gain property is used to adjust the gain setting of the camera and has two modes of operation:A driver can support none, one or both gain modes depending on the camera's capabilities. However, only one mode can be active at any one moment because both modes share the Gain property to return the gain value. Client applications can determine which mode is operational by reading the GainMin, GainMax and Gain properties. If a property can be read then its associated mode is active, if it throws a PropertyNotImplementedException then the mode is not active.
If a driver supports both modes the astronomer must be able to select the required mode through the driver Setup dialogue.
During driver initialisation the driver must set Gain to a valid value.
Please note that ReadoutMode may in some cases affect the gain of the camera; if so, the driver must be ensure that the two properties do not conflict if both are used.
This is only available in Camera Interface Version 2 and later.