Type


Definition 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.


FeatureNumber of ParamsParametersUnitsRestrictions
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_AUTO_ROI

Region of interest for application of AUTO or ONE_SHOT command
4fLeftPixelsInteger only
fTopPixelsInteger only
fWidthPixelsInteger only
fHeightPixelsInteger only
FEATURE_BANDWIDTH_LIMIT

Limits the amount of link bandwidth the camera may use for video data.
1fValueMillions of bits per secondNone
FEATURE_BODY_TEMPERATURE

Indicates the current temperature (in degrees Celcius) of the body of the camera.

1fValueDegrees CelciusRead only
FEATURE_BRIGHTNESS

Black level of the image

1fValuePercentageN/A
FEATURE_COLOR_TEMP

Color temperature of light source

1fValueDegrees KelvinN/A
FEATURE_EXTENDED_SHUTTER

Extended shutter control, allows multiple knee points
5fNumberKneesN/AInteger only
fKnee1SecondsN/A
fKnee2SecondsN/A
fKnee3SecondsN/A
fKnee4SecondsN/A
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
fHorizontalN/A (1 = ON, 0 = OFF)
1 or 0 
fVerticalN/A (1 = ON, 0 = OFF)
1 or 0
FEATURE_FOCUS

Lens focus control

1fValueLens dependantN/A
FEATURE_FRAME_RATE

Frame rate of the video stream
1fValueFrames/secondN/A
FEATURE_GAIN

Camera Circuit Gain

1fValueDecibels (dB)
N/A
FEATURE_GAIN_HDR

HDR mode, if supported.

1fValueNoneInteger Only
FEATURE_GAMMA

Gamma Correction

1fValueN/AN/A
FEATURE_GPIO

General Purpose Input/Output control
6fGPION/AInteger only
fModeN/AInteger only (see GPIO Mode)
fPolarityN/A0 for negative polarity (Active Low)

1 for positive polarity (Active High)
fParameter1Depends on ModeN/A
fParameter2Depends on ModeN/A
fParameter3Depends on ModeN/A
FEATURE_HUE

Color Phase

1fValueDegrees
N/A
FEATURE_IMAGER_CLOCK_DIVISOR

Used to slow down the camera's imaging rate.
1fValueN/AInteger only (must be power 2)
FEATURE_IRIS

Mechanical lens iris control

1fValueF number
N/A
FEATURE_LOOKUP_TABLE


Lookup table control FEATURE_LOOKUP_TABLE behaves differently with PxLGetCameraFeatures.

1fValue[MAX]N/AInteger only
FEATURE_MAX_PACKET_SIZE1fValueNumberN/A
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)
1fValueNumber of bitsRead only
FEATURE_MEMORY_CHANNEL

The memory channel to which the settings can be saved. (Read with PxLGetCameraFeaturesto determine MAX_MEMORY_CHANNEL)
1fValueN/AInteger only
FEATURE_OPT_FILTER

Optical filter of the camera lens control

1fValueN/AInteger only
FEATURE_PAN

Camera Pan control

1fValueDegrees
N/A
FEATURE_PIXEL_ADDRESSING 

Reduction in the number of pixels in the image data
4fValueN/AInteger only
fMode
N/A
Integer only
fHorizontalValueN/AInteger only
fVerticalValueN/AInteger only
FEATURE_PIXEL_FORMAT

Format of the pixel data 
1fValueN/AInteger only (see Pixel Format)
FEATURE_POLAR_HSV_INTERPRETATION

Defines how the API should interpret the pixel format PIXEL_FORMAT_HSV4_12. 
1fInterpretationN/AInteger Only(seeHSV Interpretation)
FEATURE_POLAR_WEIGHTINGS

Specifies the weighting factor to be used for each of the polar-subchannels, when determining pixel values.
4f0ValuePercentLimited to 100 percent
f45ValuePercentLimited to 100 percent
f90ValuePercentLimited to 100 percent
f135ValuePercentLimited to 100 percent
FEATURE_ROI

Region of interest of the image array
4fLeftPixelsInteger only
fTopPixelsInteger only
fWidthPixelsInteger only
fHeightPixelsInteger only
FEATURE_ROTATE

Rotation of the image (in 90 degree steps). NOTE: Changing this feature can change FEATURE_PIXEL_FORMAT when using FORMAT_BAYERXXX.
1fValueDegrees ClockwiseN/A
FEATURE_SATURATION

Color Saturation

1fValuePercentage
N/A
FEATURE_SENSOR_TEMPERATURE

Temperature of the camera's sensor head.

1fValueDegrees CelciusRead only
FEATURE_SHARPNESS

Sharpness of the picture

1fValuePercentageN/A
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.
4fLeftPixelsInteger only
fTopPixelsInteger only
fWidthPixelsInteger only
fHeightPixelsInteger only
fMaxValueN/AInteger only
FEATURE_SHUTTER

Integration time

 
1fValueSecondsN/A
FEATURE_SPECIAL_CAMERA_MODE


Places the camera in a special mode of operation.

1fValueMode


(enumeration)

Integer only
FEATURE_TILT

Camera tilt control

1fValueDegrees
N/A
FEATURE_TRIGGER

Trigger delay and mode control

5fModeN/AInteger only
fTypeN/AInteger only (see Trigger_Type)
fPolarityN/A0 for negative polarity (Active Low)

1 for positive polarity (Active High)
fDelaySecondsN/A
fParameterDepends on ModeN/A
FEATURE_TRIGGER_WITH_CONTROLLED_LIGHTING

Allows optimization of triggered image capture with rolling shutter cameras when in controlled or non-controlled lighting.
1fValueN/A1 or 0
FEATURE_WHITE_BAL

Color Temperature
1fValueDegrees KalvinN/A
FEATURE_WHITE_SHADING

Camera color channel gains
3fRedGainDecibels (dB)N/A
fGreenGainDecibels (dB)N/A
fBlueGainDecibels (dB)N/A
FEATURE_ZOOM

Lens zoom control

1fValuePowerN/A


Notes 


Most features are used with the following functions:





FEATURE_MEMORY_CHANNEL is an exception. It is used with:





Changing Camera Features While Streaming


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.