Supported by...
Pixelink PL-D and PL-X cameras with the latest firmware. Check for support using PxLGetCameraFeatures
Description
On some cameras models, the auto operations (FEATURE_FLAG_AUTO and FEATURE_FLAG_ONEPUSH) for exposure, white balance and gain will all use the AutoRoi when FEATURE_AUTO_ROI is enabled (this feature is disabled by default). When this feature is enabled and set, the auto operation (for example, Auto Exposure) will be performed over the specified AutoROI, instead of the full ROI.
The fLeft and fTop parameters are relative to the origin of the ROI, not the sensor itself. This ensures that the pixels represented in the AutoRoi will 'move' along with movements to the ROI (IE changes to ROI.fLeft and ROI.fTop).
The pixel units are pre-pixelAddressed pixels, so an AutoRoi of fLeft=100, fRight=200, fWidth=640, fHeight=480 would represent 307,200 pixels, so long as there is no pixel addressing applied. However, if a 2x2 pixel addressing (like decimation) were to then be applied, the AutoRoi parameters would remain the same, but it would now represent just 76,800 pixels.
Similar to FEATURE_ROI, FEATURE_AUTO_ROI is not be affected by the transformation features (FEATURE_FLIP and FEATURE_ROTATE).
API Control
| Feature | Number of Params | Parameters | Units | Restrictions |
FEATURE_AUTO_ROI Region of Interest of the image array | 4 | fLeft | Pixels | Integer Only |
| fTop | Pixels | Integer Only | ||
| fWidth | Pixels | Integer Only | ||
| fHeight | Pixels | Integer Only |
Please note: If fWidth or fHeight is larger than the ROI's values, those pixels that fall outside of the ROI will not be used for the auto calculation.
Feature Flags
Camera | Presence | Read Only | Auto | Manual | One-time Auto | Off | Settable While Streaming | Persistable | CiD |
PL-D and PL-X Cameras | Yes | No | No | Yes | No | Yes | Yes | Yes | No |