Supported by...
Cameras equipped with a Gen 3 or Gen 4 Sony IMX sensor (and suitable camera binaries). Check for support using PxLGetCameraFeatures.
Description
When enabled, puts the camera in a High Dynamic Range (HDR) mode of operation, whereby images can be produced that have enhanced detail discernment in dark areas of the image, without compromising brighter areas of the image. The resultant images can be produced automatically by the camera, or the user can request both ‘dark’ and ‘bright’ versions of the same image, and the application can use its own HDR algorithms to produce a resultant image.
API Control
| Feature | Num Params | Parameters | Units | Restrictions |
FEATURE_GAIN_HDR If supported, puts the camera in a High Dynamic Range (HDR) mode of operation, whereby images can be produced that have enhanced detail discernment in dark areas of the image, without compromising brighter areas of the image. | 1 | fValue | N/A | Integer Only |
Feature Flags
| Camera | Presence | Read Only | Auto | Manual | One-time Auto | Off | Settable While Streaming | Persistable |
| Certain PL-D and PL-X Cameras | Yes | No | No | Yes | No | Yes | No | Yes |
Parameter Values
| Parameter | Unit | Type | Min | Max | Default | Step Size | Comments |
| Mode | None | Absolute | 0 | 2 | 0 | 1 | 1: Camera HDR 2: Interleaved HDR Camera HDR indicates that the camera is to use its own algorithms to produce HDR images that are output in the stream similar to how normal images are streamed. Conversely, Interleaved HDR indicates that the camera should output a dark and bright version of the same image, and return both composite images to the user. The format of these composite images, is described in the note below. |
Notes:
Images received in Interleaved HDR mode, are twice as big as images received in non-Interleaved HDR mode. Each row (or line) of the image, is sent twice from the camera; first by a dark representation of the pixels in this row, followed immediately by the bright representation of these same pixels. This alternating pattern is repeated for all of the rows in the image.
Interleaved HDR mode is not compatible with YUV422, RGB24, and BGR24 pixel formats – attempting to use interleaved HDR mode with these pixel formats will result in indeterminate pixel data.
HDR (Interleaved and Camera) render the gain adjustment ineffective. That is, while HDR is enabled, the currently set gain value is ignored.
HDR Interleaved renders color temperature ineffective. That is, while HDR Interleaved is enabled, the currently set color temperature is ignored.
HDR Interleaved renders saturation ineffective. That is, while HDR Interleaved is enabled, the currently set saturation is ignored, and will effectively be 100%.
Interleaved HDR mode is not compatible with binning - When binning is enabled, the left and right images may look similar or identical, instead of the expected low gain and high gain images.