Skip to content

Image ROI#

The Image ROI camera feature allows you to specify the part of the sensor array that you want to use for image acquisition.

ROI is short for region of interest (formerly AOI = area of interest).

If an image ROI has been specified, the camera will only transmit pixel data from within that region. On most cameras, this increases the camera's maximum frame rate significantly.

The image ROI settings are independent from the auto function ROI settings.

Using the Feature#

Changing Position and Size of an Image ROI#

With the factory settings enabled, the camera is set to a default resolution. However, you can change the position and size as required.

To change the position and size of the image ROI:

  1. Make sure the camera is idle, i.e., not capturing images.
  2. If you are using an ace Classic/U/L camera, set the CenterX and CenterY parameters to false.
  3. Use the following parameters to specify the size of the image ROI:

    • Width
    • Height
  4. Use the following parameters to specify the position of the image ROI:

    • OffsetX
    • OffsetY

The origin of the image ROI is in the top left corner of the sensor array (column 0, row 0).

Example: Assume that you have specified the following settings:

  • Width = 16
  • Height = 10
  • OffsetX = 2
  • OffsetY = 6

This creates the following image ROI:

Image ROI Example

Info

  • On most cameras, decreasing the size (especially the height) of the image ROI increases the camera's maximum frame rate significantly.
  • If the Binning feature is enabled, the settings for the image ROI refer to the binned lines and columns and not to the physical lines in the sensor.

Guidelines#

When you are specifying an image ROI, follow these guidelines:

Guideline Example
OffsetX + WidthWidthMax Camera with a 1920 x 1080 pixel sensor:
OffsetX + Width ≤ 1920
OffsetY + HeightHeightMax Camera with a 1920 x 1080 pixel sensor:
OffsetY + Height ≤ 1080

The WidthMax and HeightMax parameter values adapt to the current settings for Binning, Decimation, or Scaling (if available).

Specifics#

Image ROI Sizes#

Show all camera models

Camera Model Minimum Width Minimum Height
a2A1920-51gcBAS 4 2
a2A1920-51gcPRO 4 2
a2A1920-51gmBAS 4 1
a2A1920-51gmPRO 4 1
a2A1920-160ucBAS 4 2
a2A1920-160ucPRO 4 2
a2A1920-160umBAS 4 1
a2A1920-160umPRO 4 1
a2A2448-23gcBAS 4 2
a2A2448-23gcPRO 4 2
a2A2448-23gmBAS 4 1
a2A2448-23gmPRO 4 1
a2A2448-75ucBAS 4 2
a2A2448-75ucPRO 4 2
a2A2448-75umBAS 4 1
a2A2448-75umPRO 4 1
a2A2590-22gcBAS 4 2
a2A2590-22gcPRO 4 2
a2A2590-22gmBAS 4 1
a2A2590-22gmPRO 4 1
a2A2590-60ucBAS 4 2
a2A2590-60ucPRO 4 2
a2A2590-60umBAS 4 1
a2A2590-60umPRO 4 1
a2A2840-14gcBAS 4 2
a2A2840-14gcPRO 4 2
a2A2840-14gmBAS 4 1
a2A2840-14gmPRO 4 1
a2A2840-48ucBAS 4 2
a2A2840-48ucPRO 4 2
a2A2840-48umBAS 4 1
a2A2840-48umPRO 4 1
a2A3840-13gcBAS 4 2
a2A3840-13gcPRO 4 2
a2A3840-13gmBAS 4 1
a2A3840-13gmPRO 4 1
a2A3840-45ucBAS 4 2
a2A3840-45ucPRO 4 2
a2A3840-45umBAS 4 1
a2A3840-45umPRO 4 1
a2A4096-9gcBAS 4 2
a2A4096-9gcPRO 4 2
a2A4096-9gmBAS 4 1
a2A4096-9gmPRO 4 1
a2A4096-30ucBAS 4 2
a2A4096-30ucPRO 4 2
a2A4096-30umBAS 4 1
a2A4096-30umPRO 4 1
a2A4504-5gcBAS 4 2
a2A4504-5gcPRO 4 2
a2A4504-5gmBAS 4 1
a2A4504-5gmPRO 4 1
a2A4504-18ucBAS 4 2
a2A4504-18ucPRO 4 2
a2A4504-18umBAS 4 1
a2A4504-18umPRO 4 1
a2A5320-7gcBAS 4 2
a2A5320-7gcPRO 4 2
a2A5320-7gmBAS 4 1
a2A5320-7gmPRO 4 1
a2A5320-23ucBAS 4 2
a2A5320-23ucPRO 4 2
a2A5320-23umBAS 4 1
a2A5320-23umPRO 4 1
a2A5328-4gcBAS 4 2
a2A5328-4gcPRO 4 2
a2A5328-4gmBAS 4 1
a2A5328-4gmPRO 4 1
a2A5328-15ucBAS 4 2
a2A5328-15ucPRO 4 2
a2A5328-15umBAS 4 1
a2A5328-15umPRO 4 1
acA640-90gc 2 2
acA640-90gm 1 1
acA640-90uc 2 2
acA640-90um 1 1
acA640-120gc 2 2
acA640-120gm 1 1
acA640-120uc 2 2
acA640-120um 1 1
acA640-121gm 1 1
acA640-300gc 16 2
acA640-300gm 16 1
acA640-750uc 16 2
acA640-750um 16 1
acA720-290gc 2 2
acA720-290gm 1 1
acA720-520uc 2 2
acA720-520um 1 1
acA780-75gc 2 2
acA780-75gm 1 1
acA800-200gc 16 2
acA800-200gm 16 1
acA800-510uc 16 2
acA800-510um 16 1
acA1280-60gc 2 2
acA1280-60gm 1 1
acA1300-22gc 2 2
acA1300-22gm 1 1
acA1300-30gc 2 2
acA1300-30gm 1 1
acA1300-30uc 2 2
acA1300-30um 1 1
acA1300-60gc 2 2
acA1300-60gm 1 1
acA1300-60gmNIR 1 1
acA1300-75gc 16 2
acA1300-75gm 16 1
acA1300-200uc 16 2
acA1300-200um 16 1
acA1440-73gc 2 2
acA1440-73gm 1 1
acA1440-220uc 2 2
acA1440-220um 1 1
acA1600-20gc 2 2
acA1600-20gm 1 1
acA1600-20uc 2 2
acA1600-20um 1 1
acA1600-60gc 2 2
acA1600-60gm 1 1
acA1920-25gc 64 64
acA1920-25gm 64 64
acA1920-25uc 64a 64a
acA1920-25um 64a 64a
acA1920-40gc 2 2
acA1920-40gm 1 1
acA1920-40uc 4 2
acA1920-40ucMED 4 2
acA1920-40um 4 1
acA1920-40umMED 4 1
acA1920-48gc 32 2
acA1920-48gm 32 1
acA1920-50gc 2 2
acA1920-50gm 1 1
acA1920-150uc 32 2
acA1920-150um 32 1
acA1920-155uc 4 2
acA1920-155ucMED 4 2
acA1920-155um 4 1
acA1920-155umMED 4 1
acA2000-50gc 2 2
acA2000-50gm 1 1
acA2000-50gmNIR 1 1
acA2000-165uc 8 2
acA2000-165um 8 1
acA2000-165umNIR 8 1
acA2040-25gc 2 2
acA2040-25gm 1 1
acA2040-25gmNIR 1 1
acA2040-35gc 2 2
acA2040-35gm 1 1
acA2040-55uc 4 2
acA2040-55um 4 1
acA2040-90uc 8 2
acA2040-90um 8 1
acA2040-90umNIR 8 1
acA2040-120uc 4 2
acA2040-120um 4 1
acA2440-20gc 2 2
acA2440-20gm 1 1
acA2440-35uc 4 2
acA2440-35ucMED 4 2
acA2440-35um 4 1
acA2440-35umMED 4 1
acA2440-75uc 4 2
acA2440-75ucMED 4 2
acA2440-75um 4 1
acA2440-75umMED 4 1
acA2500-14gc 64 64
acA2500-14gm 64 64
acA2500-14uc 64a 64a
acA2500-14um 64a 64a
acA2500-20gc 32 2
acA2500-20gcMED 32 2
acA2500-20gm 32 1
acA2500-20gmMED 32 1
acA2500-60uc 32 1
acA2500-60um 32 1
acA3088-16gc 376 320
acA3088-16gm 376 320
acA3088-57uc 376 320
acA3088-57ucMED 376 320
acA3088-57um 376 320
acA3088-57umMED 376 320
acA3800-10gc 2 2
acA3800-10gm 1 1
acA3800-14uc 64 64
acA3800-14um 64a 64a
acA4024-8gc 8 6
acA4024-8gm 8 5
acA4024-29uc 8 6
acA4024-29um 8 5
acA4096-11gc 16 2
acA4096-11gm 16 1
acA4096-30uc 4 2
acA4096-30ucMED 4 2
acA4096-30um 4 1
acA4096-30umMED 4 1
acA4096-40uc 4 2
acA4096-40ucMED 4 2
acA4096-40um 4 1
acA4096-40umMED 4 1
acA4112-8gc 16 2
acA4112-8gm 16 1
acA4112-20uc 4 2
acA4112-20ucMED 4 2
acA4112-20um 4 1
acA4112-20umMED 4 1
acA4112-30uc 4 2
acA4112-30ucMED 4 2
acA4112-30um 4 1
acA4112-30umMED 4 1
acA4600-7gc 2 2
acA4600-10uc 64 64
acA5472-5gc 8 6
acA5472-5gm 8 5
acA5472-17uc 8 6
acA5472-17ucMED 8 6
acA5472-17um 8 5
acA5472-17umMED 8 5
boA4096-93cc 48 2
boA4096-93cm 48 2
boA4112-68cc 48 2
boA4112-68cm 48 2
boA4500-45cc 48 2
boA4500-45cm 48 2
boA6500-36cc 48 2
boA6500-36cm 48 2
boA8100-16cc 48 2
boA8100-16cm 48 2
daA1280-54lc 16 8
daA1280-54lm 16 8
daA1280-54uc 16 8
daA1280-54um 16 8
daA1600-60lc 16 8
daA1600-60lm 16 8
daA1600-60uc 16 8
daA1600-60um 16 8
daA1920-15um 16 8
daA1920-30uc 16 8
daA1920-30um 16 8
daA1920-160uc 4 2
daA1920-160um 4 1
daA2500-14lc 4 4
daA2500-14lm 4 4
daA2500-14uc 16 8
daA2500-14um 16 8
daA3840-45uc 2 6
daA3840-45um 4 4
puA1280-54uc 16 8
puA1280-54um 16 8
puA1600-60uc 16 8
puA1600-60um 16 8
puA1920-30uc 4 4
puA1920-30um 4 4
puA2500-14uc 4 4
puA2500-14um 4 4

  1. When binning is enabled, the minimum width and minimum height are reduced. Values are rounded up to the nearest integer. Example: If you have configured horizontal binning by 3, the effective minimum width is 64 / 3 = 21.333 ≈ 22.

Image ROI Characteristics#

Show all camera models

Camera Model Decreasing Height Increases Frame Rate Significantly
a2A1920-51gcBAS Yes
a2A1920-51gcPRO Yes
a2A1920-51gmBAS Yes
a2A1920-51gmPRO Yes
a2A1920-160ucBAS Yes
a2A1920-160ucPRO Yes
a2A1920-160umBAS Yes
a2A1920-160umPRO Yes
a2A2448-23gcBAS Yes
a2A2448-23gcPRO Yes
a2A2448-23gmBAS Yes
a2A2448-23gmPRO Yes
a2A2448-75ucBAS Yes
a2A2448-75ucPRO Yes
a2A2448-75umBAS Yes
a2A2448-75umPRO Yes
a2A2590-22gcBAS No
a2A2590-22gcPRO No
a2A2590-22gmBAS No
a2A2590-22gmPRO No
a2A2590-60ucBAS No
a2A2590-60ucPRO No
a2A2590-60umBAS No
a2A2590-60umPRO No
a2A2840-14gcBAS Yes
a2A2840-14gcPRO Yes
a2A2840-14gmBAS Yes
a2A2840-14gmPRO Yes
a2A2840-48ucBAS Yes
a2A2840-48ucPRO Yes
a2A2840-48umBAS Yes
a2A2840-48umPRO Yes
a2A3840-13gcBAS No
a2A3840-13gcPRO No
a2A3840-13gmBAS No
a2A3840-13gmPRO No
a2A3840-45ucBAS No
a2A3840-45ucPRO No
a2A3840-45umBAS No
a2A3840-45umPRO No
a2A4096-9gcBAS Yes
a2A4096-9gcPRO Yes
a2A4096-9gmBAS Yes
a2A4096-9gmPRO Yes
a2A4096-30ucBAS Yes
a2A4096-30ucPRO Yes
a2A4096-30umBAS Yes
a2A4096-30umPRO Yes
a2A4504-5gcBAS Yes
a2A4504-5gcPRO Yes
a2A4504-5gmBAS Yes
a2A4504-5gmPRO Yes
a2A4504-18ucBAS Yes
a2A4504-18ucPRO Yes
a2A4504-18umBAS Yes
a2A4504-18umPRO Yes
a2A5320-7gcBAS Yes
a2A5320-7gcPRO Yes
a2A5320-7gmBAS Yes
a2A5320-7gmPRO Yes
a2A5320-23ucBAS Yes
a2A5320-23ucPRO Yes
a2A5320-23umBAS Yes
a2A5320-23umPRO Yes
a2A5328-4gcBAS Yes
a2A5328-4gcPRO Yes
a2A5328-4gmBAS Yes
a2A5328-4gmPRO Yes
a2A5328-15ucBAS Yes
a2A5328-15ucPRO Yes
a2A5328-15umBAS Yes
a2A5328-15umPRO Yes
acA640-90gc Yes
acA640-90gm Yes
acA640-90uc Yes
acA640-90um Yes
acA640-120gc Yes
acA640-120gm Yes
acA640-120uc Yes
acA640-120um Yes
acA640-121gm Yes
acA640-300gc Yes
acA640-300gm Yes
acA640-750uc Yes
acA640-750um Yes
acA720-290gc Yes
acA720-290gm Yes
acA720-520uc Yes
acA720-520um Yes
acA780-75gc Yes
acA780-75gm Yes
acA800-200gc Yes
acA800-200gm Yes
acA800-510uc Yes
acA800-510um Yes
acA1280-60gc Yes
acA1280-60gm Yes
acA1300-22gc Yes
acA1300-22gm Yes
acA1300-30gc Yes
acA1300-30gm Yes
acA1300-30uc Yes
acA1300-30um Yes
acA1300-60gc Yes
acA1300-60gm Yes
acA1300-60gmNIR Yes
acA1300-75gc Yes
acA1300-75gm Yes
acA1300-200uc Yes
acA1300-200um Yes
acA1440-73gc Yes
acA1440-73gm Yes
acA1440-220uc Yes
acA1440-220um Yes
acA1600-20gc Yes
acA1600-20gm Yes
acA1600-20uc Yes
acA1600-20um Yes
acA1600-60gc Yes
acA1600-60gm Yes
acA1920-25gc Yes
acA1920-25gm Yes
acA1920-25uc Yes
acA1920-25um Yes
acA1920-40gc Yes
acA1920-40gm Yes
acA1920-40uc Yes
acA1920-40ucMED Yes
acA1920-40um Yes
acA1920-40umMED Yes
acA1920-48gc Yes
acA1920-48gm Yes
acA1920-50gc Yes
acA1920-50gm Yes
acA1920-150uc Yes
acA1920-150um Yes
acA1920-155uc Yes
acA1920-155ucMED Yes
acA1920-155um Yes
acA1920-155umMED Yes
acA2000-50gc Yes
acA2000-50gm Yes
acA2000-50gmNIR Yes
acA2000-165uc Yes
acA2000-165um Yes
acA2000-165umNIR Yes
acA2040-25gc Yes
acA2040-25gm Yes
acA2040-25gmNIR Yes
acA2040-35gc Yes
acA2040-35gm Yes
acA2040-55uc Yes
acA2040-55um Yes
acA2040-90uc Yes
acA2040-90um Yes
acA2040-90umNIR Yes
acA2040-120uc Yes
acA2040-120um Yes
acA2440-20gc Yes
acA2440-20gm Yes
acA2440-35uc Yes
acA2440-35ucMED Yes
acA2440-35um Yes
acA2440-35umMED Yes
acA2440-75uc Yes
acA2440-75ucMED Yes
acA2440-75um Yes
acA2440-75umMED Yes
acA2500-14gc Yes
acA2500-14gm Yes
acA2500-14uc Yes
acA2500-14um Yes
acA2500-20gc Yes
acA2500-20gcMED Yes
acA2500-20gm Yes
acA2500-20gmMED Yes
acA2500-60uc Yes
acA2500-60um Yes
acA3088-16gc Yes
acA3088-16gm Yes
acA3088-57uc Yes
acA3088-57ucMED Yes
acA3088-57um Yes
acA3088-57umMED Yes
acA3800-10gc Yes
acA3800-10gm Yes
acA3800-14uc Yes
acA3800-14um Yes
acA4024-8gc No
acA4024-8gm No
acA4024-29uc No
acA4024-29um No
acA4096-11gc Yes
acA4096-11gm Yes
acA4096-30uc Yes
acA4096-30ucMED Yes
acA4096-30um Yes
acA4096-30umMED Yes
acA4096-40uc Yes
acA4096-40ucMED Yes
acA4096-40um Yes
acA4096-40umMED Yes
acA4112-8gc Yes
acA4112-8gm Yes
acA4112-20uc Yes
acA4112-20ucMED Yes
acA4112-20um Yes
acA4112-20umMED Yes
acA4112-30uc Yes
acA4112-30ucMED Yes
acA4112-30um Yes
acA4112-30umMED Yes
acA4600-7gc Yes
acA4600-10uc Yes
acA5472-5gc No
acA5472-5gm No
acA5472-17uc No
acA5472-17ucMED No
acA5472-17um No
acA5472-17umMED No
boA4096-93cc Yes
boA4096-93cm Yes
boA4112-68cc Yes
boA4112-68cm Yes
boA4500-45cc Yes
boA4500-45cm Yes
boA6500-36cc Yes
boA6500-36cm Yes
boA8100-16cc Yes
boA8100-16cm Yes
daA1280-54lc Yes
daA1280-54lm Yes
daA1280-54uc Yes
daA1280-54um Yes
daA1600-60lc Yes
daA1600-60lm Yes
daA1600-60uc Yes
daA1600-60um Yes
daA1920-15um Yes
daA1920-30uc Yes
daA1920-30um Yes
daA1920-160uc Yes
daA1920-160um Yes
daA2500-14lc Yes
daA2500-14lm Yes
daA2500-14uc Yes
daA2500-14um Yes
daA3840-45uc Yes
daA3840-45um Yes
puA1280-54uc Yes
puA1280-54um Yes
puA1600-60uc Yes
puA1600-60um Yes
puA1920-30uc Yes
puA1920-30um Yes
puA2500-14uc Yes
puA2500-14um Yes

Sample Code#

ace Classic/U/L GigE Cameras#

// Set the width to the maximum value
int64_t maxWidth = camera.Width.GetMax();
camera.Width.SetValue(maxWidth);
// Set the height to 500
camera.Height.SetValue(500);
// Set the offset to 0,0
camera.OffsetX.SetValue(0);
camera.OffsetY.SetValue(0);
INodeMap& nodemap = camera.GetNodeMap();
// Set the width to the maximum value
int64_t maxWidth = CIntegerParameter(nodemap, "Width").GetMax();
CIntegerParameter(nodemap, "Width").SetValue(maxWidth);
// Set the height to 500
CIntegerParameter(nodemap, "Height").SetValue(500);
// Set the offset to 0,0
CIntegerParameter(nodemap, "OffsetX").SetValue(0);
CIntegerParameter(nodemap, "OffsetY").SetValue(0);
// Set the width to the maximum value
Int64 maxWidth = camera.Parameters[PLCamera.Width].GetMaximum();
camera.Parameters[PLCamera.Width].SetValue(maxWidth);
// Set the height to 500
camera.Parameters[PLCamera.Height].SetValue(500);
// Set the offset to 0,0
camera.Parameters[PLCamera.OffsetX].SetValue(0);
camera.Parameters[PLCamera.OffsetY].SetValue(0);
/* Macro to check for errors */
#define CHECK(errc) if (GENAPI_E_OK != errc) printErrorAndExit(errc)
GENAPIC_RESULT errRes = GENAPI_E_OK;  /* Return value of pylon methods */
int64_t maxWidth = 0;
/* Set the width to the maximum value */
errRes = PylonDeviceGetIntegerFeatureMax(hdev, "Width", &maxWidth);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "Width", maxWidth);
CHECK(errRes);
/* Set the height to 500 */
errRes = PylonDeviceSetIntegerFeature(hdev, "Height", 500);
CHECK(errRes);
/* Set the offset to 0,0 */
errRes = PylonDeviceSetIntegerFeature(hdev, "OffsetX", 0);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "OffsetY", 0);
CHECK(errRes);

Other Cameras#

// Set the width to the maximum value
int64_t maxWidth = camera.WidthMax.GetValue();
camera.Width.SetValue(maxWidth);
// Set the height to 500
camera.Height.SetValue(500);
// Set the offset to 0
camera.OffsetX.SetValue(0);
camera.OffsetY.SetValue(0);
INodeMap& nodemap = camera.GetNodeMap();
// Set the width to the maximum value
int64_t maxWidth = CIntegerParameter(nodemap, "WidthMax").GetValue();
CIntegerParameter(nodemap, "Width").SetValue(maxWidth);
// Set the height to 500
CIntegerParameter(nodemap, "Height").SetValue(500);
// Set the offset to 0
CIntegerParameter(nodemap, "OffsetX").SetValue(0);
CIntegerParameter(nodemap, "OffsetY").SetValue(0);
// Set the width to the maximum value
Int64 maxWidth = camera.Parameters[PLCamera.WidthMax].GetValue();
camera.Parameters[PLCamera.Width].SetValue(maxWidth);
// Set the height to 500
camera.Parameters[PLCamera.Height].SetValue(500);
// Set the offset to 0
camera.Parameters[PLCamera.OffsetX].SetValue(0);
camera.Parameters[PLCamera.OffsetY].SetValue(0);
/* Macro to check for errors */
#define CHECK(errc) if (GENAPI_E_OK != errc) printErrorAndExit(errc)
GENAPIC_RESULT errRes = GENAPI_E_OK;  /* Return value of pylon methods */
int64_t maxWidth = 0;
/* Set the width to the maximum value */
errRes = PylonDeviceGetIntegerFeature(hdev, "WidthMax", &maxWidth);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "Width", maxWidth);
CHECK(errRes);
/* Set the height to 500 */
errRes = PylonDeviceSetIntegerFeature(hdev, "Height", 500);
CHECK(errRes);
/* Set the offset to 0 */
errRes = PylonDeviceSetIntegerFeature(hdev, "OffsetX", 0);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "OffsetY", 0);
CHECK(errRes);

You can also use the pylon Viewer to easily set the parameters.

Back to top