Type
Definition declared in PixeLINKTypes.h.
The following features can be accessed through the PixeLINK API, although not all cameras have all features. Most of the features have flags that can be read and modified. See the Programmable Features Section for a description of the parameters for each feature and the units.
| Feature | Number of Params | Parameters | Units | Restrictions |
|---|---|---|---|---|
FEATURE_SPECIAL_CAMERA_MODE Places the camera in a special mode of operation. | 1 | fValue | Mode (enumeration) | Integer only |
| FEATURE_BRIGHTNESS Black level of the image | 1 | fValue | Percentage | N/A |
| FEATURE_SHARPNESS Sharpness of the picture | 1 | fValue | Percentage | N/A |
| FEATURE_COLOR_TEMP Color temperature of light source | 1 | fValue | Degrees Kelvin | N/A |
| FEATURE_HUE Color Phase | 1 | fValue | Degrees | N/A |
| FEATURE_SATURATION Color Saturation | 1 | fValue | Percentage | N/A |
| FEATURE_GAMMA Gamma Correction | 1 | fValue | N/A | N/A |
| FEATURE_SHUTTER Integration time | 1 | fValue | Seconds | N/A |
| FEATURE_GAIN Camera Circuit Gain | 1 | fValue | Decibels (dB) | N/A |
| FEATURE_IRIS Mechanical lens iris control | 1 | fValue | F number | N/A |
| FEATURE_FOCUS Lens focus control | 1 | fValue | Lens dependant | N/A |
| FEATURE_BODY_TEMPERATURE Indicates the current temperature (in degrees Celcius) of the body of the camera. | 1 | fValue | Degrees Celcius | Read only |
| FEATURE_SENSOR_TEMPERATURE Temperature of the camera's sensor head. | 1 | fValue | Degrees Celcius | Read only |
| FEATURE_TRIGGER Trigger delay and mode control | 5 | fMode | N/A | Integer only |
| fType | N/A | Integer only (see Trigger_Type) | ||
| fPolarity | N/A | 0 for negative polarity (Active Low) 1 for positive polarity (Active High) | ||
| fDelay | Seconds | N/A | ||
| fParameter | Depends on Mode | N/A | ||
| FEATURE_ZOOM Lens zoom control | 1 | fValue | Power | N/A |
| FEATURE_PAN Camera Pan control | 1 | fValue | Degrees | N/A |
| FEATURE_TILT Camera tilt control | 1 | fValue | Degrees | N/A |
| FEATURE_OPT_FILTER Optical filter of the camera lens control | 1 | fValue | N/A | Integer only |
| FEATURE_GPIO General Purpose Input/Output control | 6 | fGPIO | N/A | Integer only |
| fMode | N/A | Integer only (see GPIO Mode) | ||
| fPolarity | N/A | 0 for negative polarity (Active Low) 1 for positive polarity (Active High) | ||
| fParameter1 | Depends on Mode | N/A | ||
| fParameter2 | Depends on Mode | N/A | ||
| fParameter3 | Depends on Mode | N/A | ||
| FEATURE_FRAME_RATE Frame rate of the video stream | 1 | fValue | Frames/second | N/A |
| FEATURE_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 | ||
| FEATURE_FLIP Vertical and horizontal flip of the image. Note: Changing this feature can change FEATURE_PIXEL_FORMAT in returned frames when using FORMAT_BAYERXXX Only PL-B76x cameras support hardware flipping. For all other cameras flipping is performed by software in the API. | 2 | fHorizontal | N/A (1 = ON, 0 = OFF) | 1 or 0 |
| fVertical | N/A (1 = ON, 0 = OFF) | 1 or 0 | ||
| FEATURE_PIXEL_ADDRESSING Reduction in the number of pixels in the image data | 4 | fValue | N/A | Integer only |
| fMode | N/A | Integer only | ||
| fHorizontalValue | N/A | Integer only | ||
| fVerticalValue | N/A | Integer only | ||
| FEATURE_PIXEL_FORMAT Format of the pixel data | 1 | fValue | N/A | Integer only (see Pixel Format) |
| FEATURE_EXTENDED_SHUTTER Extended shutter control, allows multiple knee points | 5 | fNumberKnees | N/A | Integer only |
| fKnee1 | Seconds | N/A | ||
| fKnee2 | Seconds | N/A | ||
| fKnee3 | Seconds | N/A | ||
| fKnee4 | Seconds | N/A | ||
| FEATURE_AUTO_ROI Region of interest for application of AUTO or ONE_SHOT command | 4 | fLeft | Pixels | Integer only |
| fTop | Pixels | Integer only | ||
| fWidth | Pixels | Integer only | ||
| fHeight | Pixels | Integer only | ||
| FEATURE_LOOKUP_TABLE Lookup table control FEATURE_LOOKUP_TABLE behaves differently with PxLGetCameraFeatures. | 1 | fValue[MAX] | N/A | Integer only |
| FEATURE_MEMORY_CHANNEL The memory channel to which the settings can be saved. (Read with PxLGetCameraFeaturesto determine MAX_MEMORY_CHANNEL) | 1 | fValue | N/A | Integer only |
| FEATURE_WHITE_SHADING Camera color channel gains | 3 | fRedGain | Decibels (dB) | N/A |
| fGreenGain | Decibels (dB) | N/A | ||
| fBlueGain | Decibels (dB) | N/A | ||
| FEATURE_ROTATE Rotation of the image (in 90 degree steps). NOTE: Changing this feature can change FEATURE_PIXEL_FORMAT when using FORMAT_BAYERXXX. | 1 | fValue | Degrees Clockwise | N/A |
| FEATURE_IMAGER_CLOCK_DIVISOR Used to slow down the camera's imaging rate. | 1 | fValue | N/A | Integer only (must be power 2) |
| FEATURE_MAX_PIXEL_SIZE Indicates the maximum number of bits used to represent a pixel. Note that this is representative of the digital pixel value before any pixel formatting is applied. (i.e., the 'raw' pixel data) | 1 | fValue | Number of bits | Read only |
| FEATURE_MAX_PACKET_SIZE | 1 | fValue | Number | N/A |
| FEATURE_TRIGGER_WITH_CONTROLLED_LIGHTING Allows optimization of triggered image capture with rolling shutter cameras when in controlled or non-controlled lighting. | 1 | fValue | N/A | 1 or 0 |
| FEATURE_BANDWIDTH_LIMIT Limits the amount of link bandwidth the camera may use for video data. | 1 | fValue | Millions of bits per second | None |
| FEATURE_SHARPNESS_SCORE If supported, provides information the camera uses to calculate the 'SharpnessScore' of an image. Sharpness Score is a measure of how many crisp edges there are in an image. | 4 | fLeft | Pixels | Integer only |
| fTop | Pixels | Integer only | ||
| fWidth | Pixels | Integer only | ||
| fHeight | Pixels | Integer only | ||
| fMaxValue | N/A | Integer only | ||
| FEATURE_ACTUAL_FRAME_RATE If supported, reports the frame rate the camera will actually use when streaming images. | 1 | fValue | Frames per second | Read only |
Most features are used with the following functions:
The following features should only be set if the stream state is turned off (STOP_STREAM). Changes to these features can require the camera to renegotiate the bandwidth required on the bus, something that can only be done with the stream stopped.
- FEATURE_FRAME_RATE
- FEATURE_PIXEL_FORMAT
- FEATURE_PIXEL_ADDRESSING (formerly known as FEATURE_DECIMATION)
- FEATURE_ROI
- FEATURE_TRIGGER
- FEATURE_TRIGGER_WITH_CONTROLLED_LIGHT
- FEATURE_LOOKUP_TABLE
- FEATURE_IMAGER_CLK_DIVISOR
This information can be determined at runtime (with PixeLINK API 7.14 or later) by calling PxLGetCameraFeatures to get information about a feature, then examining the state of the feature flag FEATURE_FLAG_SETTABLE_WHILE_STREAMING.