APPLICATION NOTE

Multiple Regions of Interest (Multiple ROI)
V1.1.02018-Nov-22

Introduction
This document presents information on how to use the new Multiple Regions of Interest (Multiple ROI)
feature set with Bonito PRO CoaXPress cameras and the Euresys Coaxlink Quad G3 frame grabber. Multiple
ROI allows you to configure up to four non-overlapping regions of interest. This enables you to computeeach region differently at a higher frame rates.

Prerequisites
The following items are required:•Allied Vision Bonito PRO camera
Supported models: Bonito PRO X-1250, X-2620•Euresys Coaxlink Quad G3 frame grabber with related viewer or SDK installed on the host PC.
The Euresys Coaxlink Quad G3 frame grabber has been tested with Bonito PROcameras and fully supports the Multiple ROI feature set.

Ensure that frame grabber firmware and related SDK include driver support tooperate a single camera and up to four data streams.

The Bonito PRO Multiple ROI feature set may be supported with other frame
grabbers which support the Multiple ROI feature set and are compliant withGenICam SFNC V2.2 and CoaXPress V1.1 (or higher) standards. Please check withthe frame grabber manufacturer for more information.

Page 1 of 6

Multiple Regions of Interest (Multiple ROI)

Region of Interest versus Multiple Regions of Interest
With Region of Interest, you can configure a single region of interest. You can configure Height, Width,
OffsetX, and OffsetY for this single region.
(0,0)
OīƐetYOīƐetX
Region of IntereƐƚHeightMax

HeightZK/
Height.Max

WidthZK/Width.Max
WidthMax

Figure 1: Single region interest
With Multiple Regions of Interest, you can configure up to four non-overlapping regions of interest. For
each region you can configure Height, Width, OffsetX, and OffsetY.
(0,0)

Region 1/2

Region 0
HeightMax

Region 3

Region 2/1

ROIHeight.Max

ROI Width.Max
WidthMax

Figure 2: Four regions of interestRules to defining regions••••

Regions can share rows and columns
Regions cannot overlap
When Multiple ROI is enabled, binning and decimation are not available.
Each region is displayed in a different window when using the Euresys Frame
Grabber SDK/Viewer.

Page 2 of 6

Multiple Regions of Interest (Multiple ROI)

Multiple ROI features
The Multiple ROI feature implementation is fully compliant with GenICam SFNC Version 2.2 or later.

iCamera features reference
The features described in this document add Multiple ROI functions in accordancewith SFNC. For a complete description of individual features, see the Bonito PRO
Features Reference, available on the Allied Vision technical documentation
webpage.
https://www.alliedvision.com/en/support/technical-documentation/bonito-PROdocumentation.html
Defining Regions
In Multiple ROI mode, when different regions share rows, the left region must havea smaller RegionIDValue. If the left region has a larger region ID, the feature does
not work. This is a sensor limitation.

MultipleROIEnable
Select to enable or disable Multiple Regions of Interest. Once enabled, you canconfigure up to four regions of interest.
Use the RegionSelector feature to select the region you want to configure. You
can configure image Width, Height, OffSetX, and OffsetY. Use the RegionModefeature to enable the usage of the region. Repeat for each region of interest.
Standard

CustomFeature type

BooleanAccessRead/Write

Visibility

Beginner

Possible values

True, False

Default

False

Category/ImageFormatControl

CondensedRegionStatus
Status of all regions.
Standard

CustomFeature type

StringAccess

ReadVisibility

ExpertPossible values

D, V, P, O

Category/ImageFormatControl

Page 3 of 6

Multiple Regions of Interest (Multiple ROI)

ValueDVPO

Description
Disabled
ValidPosition error
Overlap error

RegionSelector
Selects the ROI to control. The RegionSelector feature allows devices that areable to extract multiple regions out of an image, to configure the features of thoseindividual regions independently.
As multiple ROIs are supported by the device, the RegionSelector can be added
to various features such as Height, Width, OffsetX, and OffsetY to specify thebehavior of the selected region.
Standard

GenICam SFNC Version 2.2

Feature type

Enumeration

AccessRead/Write

Visibility

Beginner

Possible values

Region0, Region1, Region2, Region3

Default

Region0Category/ImageFormatControl

Value
Region0
Region1
Region2
Region3

Description
Selected feature controls region 0.
Selected feature controls region 1.
Selected feature controls region 2.
Selected feature controls region 3.

RegionModeControls if the selected region of interest is active and streaming.
Standard

GenICam SFNC Version 2.2

Feature type

Enumeration

AccessRead/Write

Visibility

Beginner

Possible valuesOff, On

Default

On

Category/ImageFormatControl

Value
OffOn

Description
Disable the usage of the region.
Enable the usage of the region.

Page 4 of 6

Multiple Regions of Interest (Multiple ROI)

RegionDestination
Controls the destination of the selected region.
Standard

GenICam SFNC Version 2.2

Feature type

Enumeration

AccessRead/Write

Visibility

Beginner

Possible values

Stream0, Stream1, Stream2, Stream3

Default

Stream0

Category/ImageFormatControl

Value
Stream0
Stream1
Stream2
Stream3

Description
The destination of the region is data stream 0.
The destination of the region is data stream 1.
The destination of the region is data stream 2.
The destination of the region is data stream 3.

RegionIDValue
Returns a unique identifier value that corresponds to the selected region. Thisvalue is typically used by the transport layer to specify the region where thetransmitted data comes from.
Standard

CustomFeature type

Integer

Access

Read

Visibility

ExpertPossible values

0, 1, 2, 3

Default0

Category/ImageFormatControl

Example configuration
1. Set the MultiROIEnable feature to True to enable Multiple Regions of Interest. If this feature is set toFalse, you can only configure a single region of interest, Region0.
2. To configure the first region, select Region0 in RegionSelector.
3. Select Width and configure the width of Region0. The minimum supported width is 64 pixels.
4. Select Height and configure the height of Region0. The minimum supported height is 16 pixels.
5. Select OffsetX and configure the starting column of Region0 (relative to the first column of thesensor). OffsetX must be configured in multiples of 64.
6. Select OffsetY and configure the starting row of Region0 (relative to the first row of the sensor).
OffsetY must be configured in multiples of 16.
7. Enable the region by changing RegionMode from Off to On.

Page 5 of 6

Multiple Regions of Interest (Multiple ROI)

8. Check the region status using the CondensedRegionStatus feature to ensure that the region is valid.
9. To configure the second region, select Region1 in RegionSelector.
10. Repeat steps 3 to 8 for Region1.
11. To configure the third region, select Region2 in RegionSelector.
12. Repeat steps 3 to 8 for Region2.
13. To configure the fourth region, select Region3 in RegionSelector.
14. Repeat steps 3 to 8 for Region3.

(end of document)

For technical support, please contact support@alliedvision.com.
For comments or suggestions regarding this document, please contact
info@alliedvision.com.

Copyright and trademarks
All text, pictures, and graphics are protected by copyright and other laws protecting
intellectual property. All content is subject to change without notice.
All trademarks, logos, and brands cited in this document are property and/or copyrightmaterial of their respective owners. Use of these trademarks, logos, and brands does not
imply endorsement.
Copyright © 2018 Allied Vision GmbH. All rights reserved.

Page 6 of 6