Multiple ROI#

相机的 Multiple ROI 功能允许您在传感器阵列上定义多个分区，这些分区将作为单个图像传输。

仅会传输这些分区的像素数据，这样可以提高相机的帧速率。

The Multiple ROI feature is similar to the Stacked ROI feature, which is only available on Basler ace cameras.

该功能的使用#

运作原理#

Multiple ROI 功能允许您在传感器阵列上定义分区。最大分区数量取决于您的相机型号。

采集图像时，仅从传感器读出分区内的像素信息，然后作为单个图像发送。

无需单独定义分区的大小和位置，而是在传感器阵列上定义行和列。然后，在行和列的每个交叉点创建一个分区。

在下例中，已定义了两行和两列。这将创建四个分区：

将 Region 11、Region 21、Region 12 和 Region 22 中的像素信息作为单个图像发送。

配置行和列#

配置行和列：

1. 确保相机空闲，即未在捕获图像。
2. 确保 Reverse X and Reverse Y 功能已禁用。
   配置行和列后，可以重新启用图像镜像。
3. 配置列：
   1. 如果要定义单个列：
      1. 设置 BslMultipleROIColumnsEnable parameter to false.
      2. 设置 OffsetX parameter to the desired horizontal offset of the column. This value is applied to all regions.
      3. 设置 Width parameter to the desired width of the column. This value is applied to all regions.
   2. 如果要定义多个列：
      1. 设置 BslMultipleROIColumnsEnable parameter to true.
      2. 设置 BslMultipleROIColumnSelector parameter to the desired column, e.g., Column1.
      3. 设置 BslMultipleROIColumnOffset parameter to the desired horizontal offset of the column, e.g., 100.
      4. 设置 BslMultipleROIColumnSize parameter to the desired width of the column, e.g., 50.
      5. 对要配置的每一列重复上述步骤。
         注意：为避免意外的边缘效应，请始终按升序配置列，即从第 1 列开始配置，然后配置第 2 列，依此类推。
4. 配置行：
   1. 如果要定义单个行：
      1. 设置 BslMultipleROIRowsEnable parameter to false.
      2. 设置 OffsetY parameter to the desired vertical offset of the row. This value is applied to all regions.
      3. 设置 Height parameter to the desired height of the row. This value is applied to all regions.
   2. 如果要定义多个行：
      1. 设置 BslMultipleROIRowsEnable parameter to true.
      2. 设置 BslMultipleROIRowSelector parameter to the desired row, e.g., Row1.
      3. 设置 BslMultipleROIRowOffset parameter to the desired vertical offset of the row, e.g., 100.
      4. 设置 BslMultipleROIRowSize parameter to the desired height of the row, e.g., 50.
      5. 对要配置的每一行重复上述步骤。
         注意：为避免意外的边缘效应，请始终按升序配置行，即从第 1 行开始配置，然后配置第 2 行，依此类推。
5. 如果需要，请重新启用 Reverse X and Reverse Y。
   这将使列和行的位置自动适应镜像图像。

Multiple ROI 功能使用注意事项#

• There's a sensor-specific minimum width and height for all regions combined, i.e., for the images created by the Multiple ROI feature. During configuration, the camera automatically adjusts the parameter values and ranges to meet the minimum width and height. The last column is always used to reach the minimum total width. Because the increment of the BslMultipleROIColumnSize parameter is also taken into account, the resulting total width may be larger than the minimum.
  示例： The sensor of your camera has a minimum total width of 530 and allows you to configure up to two columns. If you set the width of column 1 to 200, the camera automatically sets the minimum width of column 2 to 330.
  Example 2: Assume you are using the same sensor as in the example above. Also assume the resolution of that sensor is 1920 x 1200. Now, if you'd set the vertical offset of column 0 to 900, there wouldn't be enough space to define a region that meets the minimum width requirement. Therefore, the camera automatically sets the maximum vertical offset for any column to 670 (1200 sensor width minus 530 minimum total region width).
• 由于上述限制，Basler 强烈建议按升序配置列和行，即从第 1 列开始配置，然后配置第 2 列，依此类推。
• 在彩色相机上，如果像素格式设置为涉及去马赛克处理的格式（即 RGB 或 YCbCr 像素格式），则认为只有当区域至少具有去马赛克区域的大小（例如 3x3 像素）时，相机才能计算有意义的颜色信息。

• If the BslMultipleROIColumnsEnable parameter is set to true, the following parameters become read-only:

  • OffsetX: The parameter is set to the horizontal offset of column 1.
  • Width: The parameter is set to the total width of all regions, i.e., the width of the images created by the Multiple ROI feature.

• If the BslMultipleROIRowsEnable parameter is set to true, the following parameters become read-only:

  • OffsetY: The parameter is set to the vertical offset of row 1.
  • Height: The parameter is set to the total height of all regions, i.e., the height of the images created by the Multiple ROI feature.

• 其他影响图像尺寸的相机功能，例如，Binning 或 Pixel Beyond，是在 Multiple ROI 功能之后应用。因此，在配置行和列时，您不必考虑这些功能的影响。

• 即： auto function ROI positions and sizes automatically adapt to the output of the Multiple ROI feature. For example, if the width of all regions combined is 500, the maximum value of the AutoFunctionROIWidth parameter will be 500.

详情#

显示所有相机型号

示例代码#

// ** In this example, we define two regions in horizontal direction
// that will be transmitted as a single image. **
// Enable the ability to configure multiple columns
camera.BslMultipleROIColumnsEnable.SetValue(true);
// Select column 1
camera.BslMultipleROIColumnSelector.SetValue(BslMultipleROIColumnSelector_Column1);
// The first region should have a horizontal offset of 100 and a width of 300 pixels
camera.BslMultipleROIColumnOffset.SetValue(100);
camera.BslMultipleROIColumnSize.SetValue(300);
// Select column 2
camera.BslMultipleROIColumnSelector.SetValue(BslMultipleROIColumnSelector_Column2);
// The second region should have a horizontal offset of 500 and a width of 400 pixels
camera.BslMultipleROIColumnOffset.SetValue(500);
camera.BslMultipleROIColumnSize.SetValue(400);
// We only need one row, so disable the ability to configure multiple rows
camera.BslMultipleROIRowsEnable.SetValue(false);
// Both regions should have a vertical offset of 200 and a height of 500
camera.OffsetY.SetValue(200);
camera.Height.SetValue(500);

INodeMap& nodemap = camera.GetNodeMap();
// ** In this example, we define two regions in horizontal direction
// that will be transmitted as a single image. **
// Enable the ability to configure multiple columns
CBooleanParameter(nodemap, "BslMultipleROIColumnsEnable").SetValue(true);
// Select column 1
CEnumParameter(nodemap, "BslMultipleROIColumnSelector").SetValue("Column1");
// The first region should have a horizontal offset of 100 and a width of 300 pixels
CIntegerParameter(nodemap, "BslMultipleROIColumnOffset").SetValue(100);
CIntegerParameter(nodemap, "BslMultipleROIColumnSize").SetValue(300);
// Select column 2
CEnumParameter(nodemap, "BslMultipleROIColumnSelector").SetValue("Column2");
// The second region should have a horizontal offset of 500 and a width of 400 pixels
CIntegerParameter(nodemap, "BslMultipleROIColumnOffset").SetValue(500);
CIntegerParameter(nodemap, "BslMultipleROIColumnSize").SetValue(400);
// We only need one row, so disable the ability to configure multiple rows
CBooleanParameter(nodemap, "BslMultipleROIRowsEnable").SetValue(false);
// Both regions should have a vertical offset of 200 and a height of 500
CIntegerParameter(nodemap, "OffsetY").SetValue(200);
CIntegerParameter(nodemap, "Height").SetValue(500);

// ** In this example, we define two regions in horizontal direction
// that will be transmitted as a single image. **
// Enable the ability to configure multiple columns
camera.Parameters[PLCamera.BslMultipleROIColumnsEnable].SetValue(true);
// Select column 1
camera.Parameters[PLCamera.BslMultipleROIColumnSelector].SetValue(PLCamera.BslMultipleROIColumnSelector.Column1);
// The first region should have a horizontal offset of 100 and a width of 300 pixels
camera.Parameters[PLCamera.BslMultipleROIColumnOffset].SetValue(100);
camera.Parameters[PLCamera.BslMultipleROIColumnSize].SetValue(300);
// Select column 2
camera.Parameters[PLCamera.BslMultipleROIColumnSelector].SetValue(PLCamera.BslMultipleROIColumnSelector.Column2);
// The second region should have a horizontal offset of 500 and a width of 400 pixels
camera.Parameters[PLCamera.BslMultipleROIColumnOffset].SetValue(500);
camera.Parameters[PLCamera.BslMultipleROIColumnSize].SetValue(400);
// We only need one row, so disable the ability to configure multiple rows
camera.Parameters[PLCamera.BslMultipleROIRowsEnable].SetValue(false);
// Both regions should have a vertical offset of 200 and a height of 500
camera.Parameters[PLCamera.OffsetY].SetValue(200);
camera.Parameters[PLCamera.Height].SetValue(500);

/* 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 */
/* ** In this example, we define two regions in horizontal direction */
/* that will be transmitted as a single image. ** */
/* Enable the ability to configure multiple columns */
errRes = PylonDeviceSetBooleanFeature(hdev, "BslMultipleROIColumnsEnable", 1);
CHECK(errRes);
/* Select column 1 */
errRes = PylonDeviceFeatureFromString(hdev, "BslMultipleROIColumnSelector", "Column1");
CHECK(errRes);
/* The first region should have a horizontal offset of 100 and a width of 300 pixels */
errRes = PylonDeviceSetIntegerFeature(hdev, "BslMultipleROIColumnOffset", 100);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "BslMultipleROIColumnSize", 300);
CHECK(errRes);
/* Select column 2 */
errRes = PylonDeviceFeatureFromString(hdev, "BslMultipleROIColumnSelector", "Column2");
CHECK(errRes);
/* The second region should have a horizontal offset of 500 and a width of 400 pixels */
errRes = PylonDeviceSetIntegerFeature(hdev, "BslMultipleROIColumnOffset", 500);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "BslMultipleROIColumnSize", 400);
CHECK(errRes);
/* We only need one row, so disable the ability to configure multiple rows */
errRes = PylonDeviceSetBooleanFeature(hdev, "BslMultipleROIRowsEnable", 0);
CHECK(errRes);
/* Both regions should have a vertical offset of 200 and a height of 500 */
errRes = PylonDeviceSetIntegerFeature(hdev, "OffsetY", 200);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "Height", 500);
CHECK(errRes);

# ** In this example, we define two regions in horizontal direction
# that will be transmitted as a single image. **
# Enable the ability to configure multiple columns
camera.BslMultipleROIColumnsEnable.Value = True
# Select column 1
camera.BslMultipleROIColumnSelector.Value = "Column1"
# The first region should have a horizontal offset of 100 and a width of 300 pixels
camera.BslMultipleROIColumnOffset.Value = 100
camera.BslMultipleROIColumnSize.Value = 300
# Select column 2
camera.BslMultipleROIColumnSelector.Value = "Column2"
# The second region should have a horizontal offset of 500 and a width of 400 pixels
camera.BslMultipleROIColumnOffset.Value = 500
camera.BslMultipleROIColumnSize.Value = 400
# We only need one row, so disable the ability to configure multiple rows
camera.BslMultipleROIRowsEnable.Value = False
# Both regions should have a vertical offset of 200 and a height of 500
camera.OffsetY.Value = 200
camera.Height.Value = 500

您也可以使用 pylon Viewer 轻松设置参数。