Supported by ...


All Pixelink cameras.  


All cameras have a region of interest (ROI) that can be read, but not all cameras support changing the ROI. To determine if the camera supports changing the ROI, use PxLGetCameraFeatures with FEATURE_ROI to check if feature flag FEATURE_FLAG_MANUAL is set.


Note: Pixelink cameras with CCD sensors (PL-B8xx and PL-B9xx) do not currently support changing the ROI.


Description


Region of Interest (ROI) is a feature of most CMOS sensors that allows only a portion of the active sensor to be selected and read out.  The benefit of this is a reduction in the total number of pixels and an increase in the readout speed.  Often referred to as windowing, the ROI is defined by a top and left pixel as well as a width and height. Together with the pixel addressing mode (FEATURE_PIXEL_ADDRESSING) and the pixel format (FEATURE_PIXEL_FORMAT), the ROI determines the total number of pixels in a frame and the total size of the image.


The ROI feature can be used to achieve very high frame rates in applications that do not require the full field of view of the sensor.  When used in conjunction with the pixel addressing feature, it can provide a digital zoom capability.


API Control


PxLGetFeaturePxLSetFeature


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

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

.

Feature Flags


CameraPresenceRead OnlyAutoManualOne-time AutoOffCiD
All Cameras
Yes
No
No
Yes
No
No
Yes


Parameters


CameraParameterUnitTypeMinMaxDefault
Step Size
Comments
PL-D721
PL-D721P
LeftColumnsAbsolute01248032
TopRowsAbsolute0101608
WidthColumnsAbsolute321280128032
HeightRowsAbsolute8102410248
PL-D722LeftColumnsAbsolute01888032
TopRowsAbsolute0119208
WidthColumnsAbsolute321920192032
HeightRowsAbsolute8120012008
PL-D725LeftColumnsAbsolute02528064
TopRowsAbsolute0204008
WidthColumnsAbsolute642592259264
HeightRowsAbsolute8204820488
PL-D726LeftColumnsAbsolute02184024
TopRowsAbsolute02976024
WidthColumnsAbsolute242208220824
HeightRowsAbsolute243000300024
PL-D729LeftColumnsAbsolute03808032
TopRowsAbsolute0248004
WidthColumnsAbsolute323840384032
HeightRowsAbsolute4248424844
PL-D732LeftColumnsAbsolute02016032
TopRowsAbsolute01072016
WidthColumnsAbsolute322048204832
HeightRowsAbsolute161088108816
PL-D734LeftColumnsAbsolute02016032
TopRowsAbsolute02032016
WidthColumnsAbsolute322048204832
HeightRowsAbsolute162048204816
PL-D752LeftColumnsAbsolute01888032
TopRowsAbsolute0119208
WidthColumnsAbsolute641920192032
HeightRowsAbsolute64120012008
PL-D755LeftColumnsAbsolute02416032
TopRowsAbsolute0204008
WidthColumnsAbsolute642448244832
HeightRowsAbsolute64204820488
PL-D759LeftColumnsAbsolute04064032
TopRowsAbsolute0215208
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64216021608
PL-D7512LeftColumnsAbsolute04064032
TopRowsAbsolute0299208
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64300030008
PL-D7715LeftColumnsAbsolute04576032
TopRowsAbsolute0328008
WidthColumnsAbsolute10244608460832
HeightRowsAbsolute768328832888
PL-D775LeftColumnsAbsolute02560032
TopRowsAbsolute0193608
WidthColumnsAbsolute322592259232
HeightRowsAbsolute8194419448
PL-B621
PL-B681
PL-B740
PL-B771

Left
Columns
Absolute
0
1272
0
8

Top
Rows
Absolute
0
1016
0
8

Width
Columns
Absolute
8
1280
1280
8

Height
Rows
Absolute
8
1024
1024
8

PL-B761
Left
Columns
Absolute0
7440
8

Top
Rows
Absolute04790
1

Width
Columns
Absolute8
752752
8
The minimum width
must be 8 times
the Pixel Addressing Value.

Height
Rows
Absolute1
480480
1
The minimum height
must be a multiple of
the Pixel Addressing Value.

PL-B762
Left
Columns
Absolute
0
744
0
8

Top
Rows
Absolute
0
476
0
4

Width
Columns
Absolute
8
752
752
8
The minimum width
must be 8 times
the Pixel Addressing Value.

Height
Rows
Absolute
4
480
480
4
The minimum height
must be 4 times
the Pixel Addressing Value.

PL-B774
PL-B622

Left
ColumnsAbsolute
0
1592
0
8

Top
Rows
Absolute
0
1192
0
8

Width
Columns
Absolute
8
1600
1600
8

Height
Rows
Absolute
8
1200
1200
8

PL-B776
PL-B623

Left
Columns
Absolute
0
2040
0
8

Top
Rows
Absolute0
1528
0
8

Width
ColumnsAbsolute
8
2048
2048
8

Height
Rows
Absolute
8
1536
1536
8

PL-B777
PL-B778

Left
Columns
Absolute
0
2584
0
8

Top
Rows
Absolute0
1936
0
8

Width
Columns
Absolute
8
2592
2592
8

Height
Rows
Absolute
8
1944
1944
8

PL-B780
PL-B686

Left
Columns
Absolute
0
2184
0
24

Top
Rows
Absolute
0
2976
0
24

Width
ColumnsAbsolute
24
2208
2208
24

Height
Rows
Absolute
24
3000
3000
24

PL-B952
PL-B953
Left
Columns
Absolute
0
0
0
n/a
CCD sensors.
No ROI functionality.

Top
Rows
Absolute0
0
0
n/a
Width
Columns
Absolute1024
1024
1024
n/a
Height
Rows
Absolute768
768
768
n/a
PL-B871
PL-B872
954/955
956/957

Left
Columns
Absolute
0
0
0
n/a
CCD Sensors.
No ROI functionality.

Top
Rows
Absolute
0
0
0
n/a
Width
Columns
Absolute
1392
1392
1392
n/a
Height
Rows
Absolute
1040
1040
1040
n/a
PL-B873
958/959

Left
Columns
Absolute
0
0
0
n/a
Top
Rows
Absolute
0
0
0
n/a
Width
Columns
Absolute
1600
1600
1600
n/a
Height
Rows
Absolute
1200
1200
1200
n/a