Type
Definitions
Description
| Value | When returned by PxLGetCameraFeatures | When returned by PxLGetFeature | When passed into PxLSetFeature |
|---|---|---|---|
FEATURE_FLAG_ PRESENCE | When set, this feature is supported by the camera. | Indicates the feature is supported*. | N/A |
FEATURE_FLAG_ READ_ONLY | When set, the feature can only be read. Any attempts to set the feature's value will return an error. | N/A | N/A |
FEATURE_FLAG_ DESC_SUPPORTED | When set, and if the camera supports descriptors, the feature can be set to different values in different descriptors. | N/A | N/A |
FEATURE_FLAG_ SETTABLE_ WHILE_STREAMING | When set, the feature may be changed when the camera is streaming. Supported by Pixelink Release 7.14 and later. | N/A | N/A |
FEATURE_FLAG_ PERSISTABLE | When set, the feature is saved to a camera user memory channel when PxLSaveSettings is called, and restored when PxLLoadSettings is called. Supported by Pixelink Release 7.14 and later. | N/A | N/A |
FEATURE_FLAG_ EMULATION | When set, the feature's functionality is being performed on the host by the API, rather than on the camera. Supported by Pixelink Release 7.14 and later. | N/A | N/A |
FEATURE_FLAG_ VOLATILE | When set, the feature's value, flags, or limits may be affected when another feature is changed. Supported by Pixelink Release 7.22 and later. | N/A | N/A |
FEATURE_FLAG_ MANUAL | When set, you may set the feature's value to a specific value. | When set, indicates that the feature has been manually set. | Used when setting the feature to a specific value. |
FEATURE_FLAG_ AUTO | When set, the feature supports automatic control by the camera. | When set, the feature is being automatically controlled by the camera. | Used to enable or disable automatic control of this feature by the camera. |
FEATURE_FLAG_ ONEPUSH | When set, this feature supports one-push (aka "auto-once") control by the camera. | When set, an auto-once is currently being performed by the camera. Polling with PxLGetFeature can be used to determine when the auto-once is complete. | Used to initiate an auto-once operation. When a one-push operation is finished, the feature returns to manual operation. |
FEATURE_FLAG_OFF | When set, this feature can either be off (disabled) or on (enabled). | When set, the feature is off (disabled). | Used to enable or disable the feature. |
FEATURE_FLAG_ CONTROLLER | When returned by PxLGetCameraFeatures: When set, the feature's functionality is being performed on assigned controller, rather than on the camera. Supported by Pixelink Release 10.4 and later. | N/A | N/A |
FEATURE_FLAG_ASSERT_ LOWER_LIMIT | Feature is prone to mechanical drift. See comment below. Supported by Pixelink Release 10.4 and later | N/A | Drives the feature to its absolute lower limit. See comment below. Supported by Pixelink Release 10.4 and later. |
FEATURE_FLAG_ASSERT_ UPPER_LIMIT | Feature is prone to mechanical drift. See comment below. Supported by Pixelink Release 10.4 and later. | N/A | Drives the feature to its absolute upper limit. See comment below. Supported by Pixelink Release 10.4 and later. |
FEATURE_FLAG_ USES_AUTO_ROI | When set, cameras/features use the AutoRoi. Supported by Pixelink Release 10.5 and later. | When set, the feature uses the AutoRoi. | N/A |
Comments, Restrictions and Limitations
Some features are mechanical in nature, and often use small electric motors to drive the mechanism (such as stepper motors). Due to the mechanical nature of the design, it’s possible for ‘drift’ to occur between where the system thinks the mechanism is positioned, and where it is actually positioned. Under these circumstances, it may be desirable to drive the mechanism to its absolute lower or upper limit, so that the system may re-align itself with the mechanism. The limit flags (FEATURE_FLAG_ASSERT_LOWER_LIMIT, and FEATURE_FLAG_ASSERT_UPPER_LIMIT) identify which features are prone to such drift (as returned from PxLGetCameraFeatures). Furthermore, these specific flags can be used with PxLSetFeature to facilitate the re-alignment.
Usage
An application will typically start by querying a feature's support and capabilities with PxLGetCameraFeatures, and then proceed to control and query a feature's state through PxLSetFeature and PxLGetFeature.
With PxLSetFeature, note that exactly one and only one of the flags MANUAL, AUTO, or ONEPUSH, can be set.
* If a feature is supported, PxLGetFeature will return FEATURE_FLAG_PRESENCE because this is required by DCAM, however, the information is redundant because PxLGetFeature will return an error when asked to get information about a feature that isn't supported.
Feature flags can be found in PixeLINKTypes.h.