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
4fLeftPixelsInteger Only
fTopPixelsInteger Only
fWidthPixelsInteger Only
fHeightPixelsInteger Only


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


Feature Flags


CameraPresenceRead OnlyAutoManualOne-time AutoOffCiD
All CamerasYesNoNoYesNoNoYes


Parameters


CameraParameterUnitTypeMinMaxDefaultStep SizeComments
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-D753LeftColumnsAbsolute01872016
TopRowsAbsolute0140008
WidthColumnsAbsolute641936193616
HeightRowsAbsolute64146414648
PL-D755LeftColumnsAbsolute02416032
TopRowsAbsolute0204008
WidthColumnsAbsolute642448244832
HeightRowsAbsolute64204820488
PL-D755MU-POLLeftColumnsAbsolute0119208
TopRowsAbsolute099204
WidthColumnsAbsolute32122412248
HeightRowsAbsolute32102410244
PL-D795LeftColumnsAbsolute02384016
TopRowsAbsolute0198408
WidthColumnsAbsolute642448244816
HeightRowsAbsolute64204820488
PL-D757LeftColumnsAbsolute0314408
TopRowsAbsolute0213608
WidthColumnsAbsolute64320832088
HeightRowsAbsolute64220022008
PL-D797LeftColumnsAbsolute0314408
TopRowsAbsolute0213608
WidthColumnsAbsolute64320832088
HeightRowsAbsolute64220022008
PL-D759LeftColumnsAbsolute04032032
TopRowsAbsolute0209608
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64216021608
PL-D799LeftColumnsAbsolute04032032
TopRowsAbsolute0209608
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64216021608
PL-D7512LeftColumnsAbsolute04032032
TopRowsAbsolute0293608
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64300030008
PL-D7912LeftColumnsAbsolute04032032
TopRowsAbsolute0293608
WidthColumnsAbsolute644096409632
HeightRowsAbsolute64300030008
PL-D7715LeftColumnsAbsolute04576032
TopRowsAbsolute0328008
WidthColumnsAbsolute10244608460832
HeightRowsAbsolute768328832888
PL-D775LeftColumnsAbsolute02560032
TopRowsAbsolute0193608
WidthColumnsAbsolute322592259232
HeightRowsAbsolute8194419448
PL-B621
PL-B681
PL-B740
PL-B771
LeftColumnsAbsolute0127208
TopRowsAbsolute0101608
WidthColumnsAbsolute8128012808
HeightRowsAbsolute8102410248
PL-B761LeftColumnsAbsolute074408
TopRowsAbsolute047901
WidthColumnsAbsolute87527528The minimum width
must be 8 times
the Pixel Addressing Value.
HeightRowsAbsolute14804801The minimum height
must be a multiple of
the Pixel Addressing Value.
PL-B762LeftColumnsAbsolute074408
TopRowsAbsolute047604
WidthColumnsAbsolute87527528The minimum width
must be 8 times
the Pixel Addressing Value.
HeightRowsAbsolute44804804The minimum height
must be 4 times
the Pixel Addressing Value.
PL-B774
PL-B622
LeftColumnsAbsolute0159208
TopRowsAbsolute0119208
WidthColumnsAbsolute8160016008
HeightRowsAbsolute8120012008
PL-B776
PL-B623
LeftColumnsAbsolute0204008
TopRowsAbsolute0152808
WidthColumnsAbsolute8204820488
HeightRowsAbsolute8153615368
PL-B777
PL-B778
LeftColumnsAbsolute0258408
TopRowsAbsolute0193608
WidthColumnsAbsolute8259225928
HeightRowsAbsolute8194419448
PL-B780
PL-B686
LeftColumnsAbsolute02184024
TopRowsAbsolute02976024
WidthColumnsAbsolute242208220824
HeightRowsAbsolute243000300024
PL-B952
PL-B953
LeftColumnsAbsolute000n/aCCD sensors.
No ROI functionality.
TopRowsAbsolute000n/a
WidthColumnsAbsolute102410241024n/a
HeightRowsAbsolute768768768n/a
PL-B871
PL-B872
954/955
956/957
LeftColumnsAbsolute000n/aCCD Sensors.
No ROI functionality.
TopRowsAbsolute000n/a
WidthColumnsAbsolute139213921392n/a
HeightRowsAbsolute104010401040n/a
PL-B873
958/959
LeftColumnsAbsolute000n/a
TopRowsAbsolute000n/a
WidthColumnsAbsolute160016001600n/a
HeightRowsAbsolute120012001200n/a