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機能を使用すると、センサーアレイに領域を定義できます。領域の最大数は、カメラのモデルによって異なります。

画像を取得すると、領域内のピクセル情報のみがセンサーから読み取られ、単一の画像として送信されます。

領域のサイズと位置を個別に定義する代わりに、センサー配列に行と列を定義します。その後、列と行の各交差によって領域が作成されます。

次の例では、2つの行と2つの列が定義されています。これにより、次の4つの領域が作成されます：

Region 11、Region 21、Region12、およびRegion 22内のピクセル情報は、1つの画像として送信されます。

Configuring the Rows and Columns#

行と列は次のように設定します。

1. カメラがアイドル状態であること、つまり画像をキャプチャしていないことを確認します。
2. Reverse X and Reverse Y機能が無効になっていること
   を確認します。行と列を設定した後で、画像ミラーリングを再度有効にできます。
3. 列を設定します。
   1. 単一の列を定義する場合、
      1. BslMultipleROIColumnsEnableパラメーターをfalseに設定します。
      2. OffsetXパラメーターを列の目的の水平オフセットに設定します。この値はすべての領域に適用されます。
      3. Widthパラメーターを列の希望の幅に設定します。この値はすべての領域に適用されます。
   2. 複数の列を定義する場合：
      1. BslMultipleROIColumnsEnableパラメーターをtrueに設定します。
      2. BslMultipleROIColumnSelectorパラメーターを、目的の列（Column1など）に設定します。
      3. BslMultipleROIColumnOffsetパラメーターを目的の列の水平方向のオフセット（例：100）に設定します。
      4. BslMultipleROIColumnSizeパラメーターを目的の列の幅（例：50）に設定します。
      5. 設定するすべての列について、上記の手順を繰り返します。
         注：望ましくない副作用を避けるため、列は常に昇順に設定してください。つまり、列1から始めて、列2を設定して続けます。
4. 行を設定する：
   1. 1つの行を定義する場合：
      1. BslMultipleROIRowsEnableパラメーターをfalseに設定します。
      2. OffsetYパラメーターを行の垂直オフセットに設定します。この値はすべての領域に適用されます。
      3. Heightパラメーターを行の高さに設定します。この値はすべての領域に適用されます。
   2. 複数の行を定義する場合：
      1. BslMultipleROIRowsEnableパラメーターをtrueに設定します。
      2. BslMultipleROIRowSelectorパラメーターを、目的の行（Row1など）に設定します。
      3. BslMultipleROIRowOffsetパラメーターを行の目的の垂直オフセット（例：100）に設定します。
      4. BslMultipleROIRowSizeパラメーターを行の高さ（例：50）に設定します。
      5. 設定するすべての行について、上記の手順を繰り返します。
         注： 望ましくない副作用を避けるため、行は常に昇順に設定してください。つまり、行1から始めて、行2を設定して続けます。
5. 必要に応じて、Reverse X and Reverse Yを再度有効にします。
   これにより、列と行の位置がミラー画像に自動的に調整されます。

Considerations When Using the Multiple ROI Feature#

• センサー固有の最小幅および高さは、すべての領域（Multiple ROI機能によって作成された画像）に合わせてあります。設定中、カメラは最小幅および高さに合わせてパラメーターの値と範囲を自動的に調整します。最後の列は、常に最小合計幅に達するために使用されます。BslMultipleROIColumnSizeパラメーターの増分も考慮されるため、結果的に合計幅が最小幅よりも大きくなる場合があります。
  例：カメラのセンサーの合計幅は530以上で、最大2列まで設定できます。列1の幅を200に設定すると、カメラは列2の最小幅を330に自動的に設定します。
  例2：上記の例と同じセンサーを使用しているとします。また、そのセンサーの解像度が1920 x 1200であると仮定します。ここで、列0の垂直オフセットを900に設定した場合、最小幅要件を満たす領域を定義するのに十分なスペースがありません。したがって、カメラは、任意の列の最大垂直オフセットを自動的に670に設定します（1200のセンサー幅から530の最小合計領域幅を差し引いた値）。
• 上記の制約のため、Baslerでは、列と行を昇順に設定することを強くお勧めします。つまり、列1から始めて、列2を設定して続けます。
• カラーカメラでは、ピクセルフォーマットがデベイヤリングを伴うフォーマット（RGBまたはYCbCrのピクセルフォーマット）に設定されている場合、デベイヤリング領域のサイズ以上の領域（3x3ピクセルなど）では、カメラが意味のあるカラー情報のみを計算できることを考慮してください。

• BslMultipleROIColumnsEnableパラメーターがtrueに設定されている場合、次のパラメーターは読み取り専用になります。

  • OffsetX：このパラメーターは、列1の水平オフセットに設定されます。
  • Width：このパラメーターは、Multiple ROIすべての領域の合計幅（機能によって作成された画像の幅）に設定されます。

• BslMultipleROIRowsEnableパラメーターがtrueに設定されている場合、次のパラメーターは読み取り専用になります。

  • OffsetY：このパラメーターは、行1の垂直オフセットに設定されます。
  • Height：このパラメーターは、すべての領域の合計高さ（Multiple ROI機能によって作成された画像の高さ）に設定されます。

• 画像サイズに影響を与えるその他のカメラ機能（BinningまたはPixel Beyond）は、Multiple ROI機能の後に適用されます。したがって、行と列を構成するときに、これらの機能の効果を考慮する必要はありません。

• オートファンクションROIの位置とサイズは、Multiple ROI機能の出力に自動的に適応します。たとえば、すべての領域の幅が500の場合、AutoFunctionROIWidthパラメーターの最大値は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を使用して、パラメーターを簡単に設定することもできます。