ICameraV3BayerOffsetX Property

Returns the X offset of the Bayer matrix, as defined in SensorType.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
short BayerOffsetX { get; }

Return Value

Int16
The Bayer colour matrix X offset, as defined in SensorType.

Remarks

Must be implemented by colour cameras, monochrome cameras must throw a NotImplementedException

Since monochrome cameras don't have a Bayer colour matrix by definition, such cameras should throw a NotImplementedException. Colour cameras should always return a value and must not throw a NotImplementedException

The value returned must be in the range 0 to M-1 where M is the width of the Bayer matrix. The offset is relative to the 0,0 pixel in the sensor array, and does not change to reflect subframe settings.

It is recommended that this function be called only after a connection is established with the camera hardware, to ensure that the driver is aware of the capabilities of the specific camera model.

This is only available for the Camera Interface Version 2 and later.

Exceptions

NotImplementedExceptionMonochrome cameras must throw this exception, colour cameras must not.
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn 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.

Version Information

.NET Standard

Supported in: 2.0

See Also