Click or drag to resize

ICameraV3BayerOffsetX Property

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

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
short BayerOffsetX { get; }

Return Value

Type: Int16
The Bayer colour matrix X offset, as defined in SensorType.
Exceptions
ExceptionCondition
PropertyNotImplementedExceptionMonochrome cameras must throw this exception, colour cameras must not.
NotConnectedExceptionIf the device is not connected
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.
Remarks

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

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

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.

See Also