Region of Interest : Pixelink Support

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 support changing the ROI. In cases where the ROI can be changed, it is done on the host computer by Pixelink API.

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

PxLGetFeature, PxLSetFeature

Feature	Number of Params	Parameters	Units	Restrictions
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

Camera	Presence	Read Only	Auto	Manual	One-time Auto	Off	CiD
All Cameras	Yes	No	No	Yes	No	No	Yes

Parameters

Camera	Parameter	Unit	Type	Min	Max	Default	Step Size	Comments
PL-X9512	Left	Columns	Absolute	0	4032	0	32
	Top	Rows	Absolute	0	2936	0	8
	Width	Columns	Absolute	64	4096	4096	32
	Height	Rows	Absolute	64	3000	3000	8
PL-X9524	Left	Columns	Absolute	0	5264	0	8
	Top	Rows	Absolute	0	4544	0	8
	Width	Columns	Absolute	64	5328	5328	32
	Height	Rows	Absolute	64	4608	4608	8
PL-D721 PL-D721P, M1	Left	Columns	Absolute	0	1248	0	32
	Top	Rows	Absolute	0	1016	0	8
	Width	Columns	Absolute	32	1280	1280	32
	Height	Rows	Absolute	8	1024	1024	8
PL-D722	Left	Columns	Absolute	0	1888	0	32
	Top	Rows	Absolute	0	1192	0	8
	Width	Columns	Absolute	32	1920	1920	32
	Height	Rows	Absolute	8	1200	1200	8
PL-D725, M5	Left	Columns	Absolute	0	2528	0	64
	Top	Rows	Absolute	0	2040	0	8
	Width	Columns	Absolute	64	2592	2592	64
	Height	Rows	Absolute	8	2048	2048	8
PL-D726	Left	Columns	Absolute	0	2184	0	24
	Top	Rows	Absolute	0	2976	0	24
	Width	Columns	Absolute	24	2208	2208	24
	Height	Rows	Absolute	24	3000	3000	24
PL-D729	Left	Columns	Absolute	0	3808	0	32
	Top	Rows	Absolute	0	2480	0	4
	Width	Columns	Absolute	32	3840	3840	32
	Height	Rows	Absolute	4	2484	2484	4
PL-D732, M2	Left	Columns	Absolute	0	2016	0	32
	Top	Rows	Absolute	0	1072	0	16
	Width	Columns	Absolute	32	2048	2048	32
	Height	Rows	Absolute	16	1088	1088	16
PL-D734, M4	Left	Columns	Absolute	0	2016	0	32
	Top	Rows	Absolute	0	2032	0	16
	Width	Columns	Absolute	32	2048	2048	32
	Height	Rows	Absolute	16	2048	2048	16
PL-D752	Left	Columns	Absolute	0	1888	0	32
	Top	Rows	Absolute	0	1192	0	8
	Width	Columns	Absolute	64	1920	1920	32
	Height	Rows	Absolute	64	1200	1200	8
PL-D753, M3	Left	Columns	Absolute	0	1872	0	16
	Top	Rows	Absolute	0	1400	0	8
	Width	Columns	Absolute	64	1936	1936	16
	Height	Rows	Absolute	64	1464	1464	8
PL-D755, M5D	Left	Columns	Absolute	0	2416	0	32
	Top	Rows	Absolute	0	2040	0	8
	Width	Columns	Absolute	64	2448	2448	32
	Height	Rows	Absolute	64	2048	2048	8
PL-D755MU-POL	Left	Columns	Absolute	0	1192	0	8
	Top	Rows	Absolute	0	992	0	4
	Width	Columns	Absolute	32	1224	1224	8
	Height	Rows	Absolute	32	1024	1024	4
PL-D757, M7	Left	Columns	Absolute	0	3144	0	8
	Top	Rows	Absolute	0	2136	0	8
	Width	Columns	Absolute	64	3208	3208	8
	Height	Rows	Absolute	64	2200	2200	8
PL-D759, M9	Left	Columns	Absolute	0	4032	0	32
	Top	Rows	Absolute	0	2096	0	8
	Width	Columns	Absolute	64	4096	4096	32
	Height	Rows	Absolute	64	2160	2160	8
PL-D7512, M12	Left	Columns	Absolute	0	4032	0	32
	Top	Rows	Absolute	0	2936	0	8
	Width	Columns	Absolute	64	4096	4096	32
	Height	Rows	Absolute	64	3000	3000	8
PL-D7620, M20	Left	Columns	Absolute	0	5408	0	8
	Top	Rows	Absolute	0	3584	0	8
	Width	Columns	Absolute	64	5472	5472	8
	Height	Rows	Absolute	64	3648	3648	8
PL-D795	Left	Columns	Absolute	0	2384	0	16
	Top	Rows	Absolute	0	1984	0	8
	Width	Columns	Absolute	64	2448	2448	16
	Height	Rows	Absolute	64	2048	2048	8
PL-D797, M7B	Left	Columns	Absolute	0	3144	0	8
	Top	Rows	Absolute	0	2136	0	8
	Width	Columns	Absolute	64	3208	3208	8
	Height	Rows	Absolute	64	2200	2200	8
PL-D799	Left	Columns	Absolute	0	4032	0	32
	Top	Rows	Absolute	0	2096	0	8
	Width	Columns	Absolute	64	4096	4096	32
	Height	Rows	Absolute	64	2160	2160	8
PL-D7912, M12B	Left	Columns	Absolute	0	4032	0	32
	Top	Rows	Absolute	0	2936	0	8
	Width	Columns	Absolute	64	4096	4096	32
	Height	Rows	Absolute	64	3000	3000	8
PL-D7920	Left	Columns	Absolute	0	4448	0	16
	Top	Rows	Absolute	0	4448	0	16
	Width	Columns	Absolute	64	4512	4512	16
	Height	Rows	Absolute	64	4512	4512	16
PL-D7924	Left	Columns	Absolute	0	5264	0	8
	Top	Rows	Absolute	0	4544	0	8
	Width	Columns	Absolute	64	5328	5328	8
	Height	Rows	Absolute	64	4608	4608	8
PL-D7715, M15	Left	Columns	Absolute	0	4576	0	32
	Top	Rows	Absolute	0	3280	0	8
	Width	Columns	Absolute	1024	4608	4608	32
	Height	Rows	Absolute	768	3288	3288	8
PL-D7718, M18	Left	Columns	Absolute	0	1536	0	16
	Top	Rows	Absolute	0	3616	0	16
	Width	Columns	Absolute	3376	4912	4912	16
	Height	Rows	Absolute	64	3680	3680	16
PL-D775	Left	Columns	Absolute	0	2560	0	32
	Top	Rows	Absolute	0	1936	0	8
	Width	Columns	Absolute	32	2592	2592	32
	Height	Rows	Absolute	8	1944	1944	8
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	Absolute	0	744	0	8
	Top	Rows	Absolute	0	479	0	1
	Width	Columns	Absolute	8	752	752	8	The minimum width must be 8 times the Pixel Addressing Value.
	Height	Rows	Absolute	1	480	480	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	Columns	Absolute	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	Absolute	0	1528	0	8
	Width	Columns	Absolute	8	2048	2048	8
	Height	Rows	Absolute	8	1536	1536	8
PL-B777 PL-B778	Left	Columns	Absolute	0	2584	0	8
	Top	Rows	Absolute	0	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	Columns	Absolute	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	Absolute	0	0	0	n/a
	Width	Columns	Absolute	1024	1024	1024	n/a
	Height	Rows	Absolute	768	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	CCD Sensors. No ROI functionality.
	Top	Rows	Absolute	0	0	0	n/a
	Width	Columns	Absolute	1600	1600	1600	n/a
	Height	Rows	Absolute	1200	1200	1200	n/a

Region of Interest

Related Articles