Supported by ...


All Pixelink Cameras


* Older version of this API only supported 2 parameters; fValue and fMode. This version, and subsequent versions of this API, support all 4 parameters. The additional 2 parameters (fHorizontalValue and fVerticalValue) were added to support asymmetric pixel addressing. That is, the ability to specify a different pixel reduction factor for the horizontal and vertical dimensions. Note however, not all cameras support asymmetric pixel addressing. Use PxLGetCameraFeatures or PxLGetFeature for FEATURE_PIXEL_ADDRESSING, to determine if your particular camera supports asymmetric pixel addressing. If either of these functions indicates that this feature only takes 2 parameters, than your camera does NOT support asymmetric pixel addressing.


Description


The Pixel Addressing feature reduces the number of pixels that are read from the ROI.


Pixel Addressing is controlled by two parameters – a Pixel Addressing mode and a value.  


The Pixel Addressing mode determines how the number of pixels is reduced. The mode of Pixel Addressing can be decimate (0), averaging (1), binning (2) or resampling (3).


The Pixel Addressing value can be considered as the size of a block of pixels that will be reduced to a 2x2 group. With a Pixel Addressing value of 1, the Pixel Addressing mode has no effect and all pixels in the ROI will be returned.  For Pixel Addressing values greater than 1, the number of pixels will be reduced by the square of the value. For example, a Pixel Addressing value of 3 will reduce a 6 x 6 block of pixels to a 2 x 2 block – a reduction of 4/36 or 1/9.


The decimate mode will drop pixels all the pixels in the block except for the top-left group of four. At the highest Pixel Addressing value of 6, a 12 x 12 block of pixels is reduced to 2 x 2. At this level of reduction detail in the scene can be lost and color artifacts introduced.


The averaging mode will average pixels with the similar color within the block resulting in a 2x2 Bayer pattern. This allows details in the blocks to be detected and reduces the effects of color artifacts.  


The binning mode will sum pixels with similar color within the block reducing the block to a 2x2 Bayer pattern. Unlike binning with CCD sensors, this summation occurs after the image is digitized so no increase in sensitivity will be noticed but a dark image will appear brighter.


If your camera supports asymmetric pixel addressing (see "Supported by" for a description), then you can specify different factors to be applied to the horizontal and vertical dimensions. Note that the same pixel addressing mode is applied to both dimensions.


The resampling mode uses a different approach involving the conversion of the Bayer pattern in the blocks to RGB pixels. With a Pixel Addressing value of 1, resampling has no effect. With a Pixel Addressing mode of 2 or more, resampling skips a bayer to RGB conversion step and converts the block of 10-bit pixels to one 30-bit RGB pixel by averaging the red, green and blue channels. Setting the video format to YUV422 mode will result in the best image quality while resampling. Resampling will create images with the highest quality and the least artifacts.


Pixel Addressing will reduce the amount of data coming from the camera. However, only the Decimate mode will permit an increase in the frame rate. Averaging, binning and resampling modes will have the same frame rate as if the Pixel Addressing value was 1 (no decimation.)


Pixel Addressing works in the same fashion with color or monochrome sensors.


API Control

PxLGetFeature, PxLSetFeature


Feature IDNumber of ParmsParametersUnitsRestrictions
FEATURE_PIXEL_ADDRESSING

Reduction of the image data.

4*fValueN/AInteger Only
fModeN/AInteger Only
fHorizontal ValueN/AInteger Only
fVerticalValueN/AInteger Only


Note:  FEATURE_PIXEL_ADDRESSING and FEATURE_DECIMATION are equivalent. FEATURE_DECIMATION is a legacy term used by the API.Pixel Addressing.


Note: The stream state must be off (STREAM_OFF) to modify this feature. See PxLSetStreamState.


Note: Older version of this API only supported 2 parameters; fValue and fMode. This version, and subsequent versions of this API, support all 4 parameters. The additional 2 parameters (fHorizontalValue and fVerticalValue) were added to support asymmetric pixel addressing. That is, the ability to specify a different pixel reduction factor for the horizontal and vertical dimensions. Note however, not all cameras support asymmetric pixel addressing. Use PxLGetCameraFeatures or PxLGetFeature for FEATURE_PIXEL_ADDRESSING, to determine if your particular camera supports asymmetric pixel addressing. If either of these functions indicates that this feature only takes 2 parameters, than your camera does NOT support asymmetric pixel addressing.


Note: When fValue is set to 1, fMode may default to 2 (or binning), regardless of the mode set. There is no difference between binning and decimation when fValue is set to 1. 


Feature Flags


CameraPresenceRead OnlyAutoManualOne-time AutoOffSettable while streamingPersistable
All CamerasYesNoNoYesNoYesNoYes


Parameters


CameraParameterUnit TypeMinMaxDefaultStep SizeComments
PL-D721, M1,
 PL-D722, 
PL-D725, M5
ModeNoneAbsolute02020: Decimate, 2: Bin
Null





Symmetrical only
Horizontal ValueNoneAbsolute1211
Vertical ValueNoneAbsolute1211
PL-D726ModeNoneAbsolute02020: Decimate, 2: Bin
Null





Symmetrical only
Horizontal ValueNoneAbsolute1611Pixel Addressing value of 5 is not supported.
Vertical ValueNoneAbsolute1611Pixel Addressing value of 5 is not supported.
PL-D732, M2ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D734, M4ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D752, M2BModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D753ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D755, M5DModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D755MU-POLModeNoneAbsolute



N/A
Null






Horizontal ValueNoneAbsolute




Vertical ValueNoneAbsolute




PL-D757ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1211
Vertical ValueNoneAbsolute1211
PL-D759, M9ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D7512, M12ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D7620, M20ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1211
Vertical ValueNoneAbsolute1211
PL-D795ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D797ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1211
Vertical ValueNoneAbsolute1211
PL-D799ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D7912ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported
PL-D775ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-D7715, M15ModeNoneAbsolute02020: Decimate, 2: Bin
Null






Horizontal ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
Vertical ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B741ModeNoneAbsolute00010: Decimate
ValueNoneAbsolute1211
PL-B742, 681CModeNoneAbsolute03010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute0121
PL-B761ModeNoneAbsolute12111: Average, 2: Bin
ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B762ModeNoneAbsolute13111: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B771, 621MModeNoneAbsolute02010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1211
PL-B774, 622CModeNoneAbsolute03010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1211
PL-B776, 623CModeNoneAbsolute03010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B777, 625MModeNoneAbsolute02010: Decimate, 1: Average, 2: BIn
ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B778, 625CModeNoneAbsolute03010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1411Pixel Addressing Value of 3 is not supported.
PL-B781, 686MModeNoneAbsolute02010: Decimate, 1: Average, 2: Bin
ValueNoneAbsolute1611Pixel Addressing Value of 5 is not supported.
PL-B782, 686CModeNoneAbsolute03010: Decimate, 1: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1611Pixel Addressing value of 5 is not supported.  
PL-B950, 870 ModeNoneAbsolute03011: Average, 2: Bin, 3: Resample
ValueNoneAbsolute1411Pixel Addressing Values: Color Cameras: 2, 4. Mono Cameras: 2