Type
Definitions declared in PixeLINKTypes.h.
Description
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_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 or 3 | 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 or 2 | fValue | Lens dependant | N/A |
| FEATURE_SENSOR_TEMPERATURE Temperature of the camera's sensor head | 1 | fValue | Degrees Celsius | 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 | N/A | 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. Flip may be supported on camera, or by the API. Users can determine which cameras support on camera flipping programmatically via the FEATURE_FLAG_EMULATION flag returned by PxLGetCameraFeatures. | 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 | 2 or 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 commands | 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 PxLGetCameraFeatures to 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. Rotate may be supported on camera, or by the API. Users can determine which cameras support on camera rotating programmatically via the FEATURE_FLAG_EMULATION flag returned by PxLGetCameraFeatures. | 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_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_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_BODY_TEMPERATURE Indicates the current temperature (in degrees Celsius) of the body of the camera | 1 | fValue | Degrees Celsius | Read only |
| FEATURE_MAX_PACKET_SIZE Controls maximum size of the packets used for image data | 1 | fValue | Number | Non-persistable; is auto determined each time a GigE camera is initialized. |
| 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_ACTUAL_FRAME_RATE If supported, reports the frame rate the camera will actually use when streaming images. | 1 | fValue | Frames per second | Read only |
| 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. | 5 | fLeft | Pixels | Integer only |
| fTop | Pixels | Integer only | ||
| fWidth | Pixels | Integer only | ||
| fHeight | Pixels | Integer only | ||
| fMaxValue | N/A | Integer only | ||
| FEATURE_SPECIAL_CAMERA_MODE * Places the camera in a special mode of operation | 1 | fValue | Mode (enumeration) | Integer only |
| 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_POLAR_WEIGHTINGS Specifies the weighting factor to be used for each of the polar-subchannels, when determining pixel values. | 4 | f0Value | Percent | Limited to 100 percent |
| f45Value | Percent | Limited to 100 percent | ||
| f90Value | Percent | Limited to 100 percent | ||
| f135Value | Percent | Limited to 100 percent | ||
| FEATURE_POLAR_HSV_INTERPRETATION * Defines how the API should interpret the pixel format PIXEL_FORMAT_HSV4_12. | 1 | fInterpretation | N/A | Integer only (see HSV Interpretation) |
| FEATURE_PTP * Allows 2 or more cameras on the same network, to synchronize their clocks to a ‘Master’ clock using the IEEE1588 / PTPv2 protocol. | 4 | FEATURE_PTP_PARAM_MODE | N/A | Integer only |
| FEATURE_PTP_PARAM_STATUS | N/A | Integer only | ||
| FEATURE_PTP_PARAM_ ACCURACY | Seconds | Read only | ||
| FEATURE_PTP_ PARAM_OFFSET_ FROM_MASTER | Seconds | Read only | ||
| FEATURE_LIGHTING Controls the brightness level of the lighting controller assigned to the camera. | 4 | fBrightness | Brightness level | From 0 (no light) to 99 |
| fCurrent | Amps | Read only | ||
| fVoltage | Volts | Read only | ||
| fTemperature | Degrees Celsius | Read only | ||
| FEATURE_COMPRESSION * Enables the camera to output compressed images, using the specified compression scheme, when streaming a particular pixel format. | 2 | fPixelFormat | N/A | Integer only (see Pixel Format) |
| fCompressionStrategy | N/A | Integer only (see Parameter Compression Strategy) |
Notes
Most features are used with the following functions:
FEATURE_MEMORY_CHANNEL is an exception. It is used with:
* Changing Camera Features While Streaming
Some features can only be set if the stream state is turned off (STOP_STREAM). Changes to these features can require the camera to renegotiate bandwidth required on the bus, or may require significant changes to the imaging sensor setup, something that can only be done with the stream stopped.
FEATURE_PIXEL_ADDRESSING (formerly known as FEATURE_DECIMATION)
Note: This is not an exhaustive list. Which features can be set while streaming, can be determined at runtime (with Pixelink SDK release 7.14 or later) by calling PxLGetCameraFeatures to get information about a feature, and examining the state of the feature flag FEATURE_FLAG_SETTABLE_WHILE_STREAMING.
More information can also be found in the documentation for each feature.