Overlay

NI Vision Assistant

Overlay

Overlay figures, text, and bitmaps onto an image without destroying the underlying image data. Use the Overlay step to select and configure the overlay elements you want to display on images within Vision Assistant.

Note  The Overlay function does not modify the image pixels.

Main Tab

The following controls are available on the Main tab.

  • Step Name—Name to give the step.

Overlay Tab

The following controls are available on the Overlay tab.

SelectionSelection Tool—Selects an overlay element in the image.
LineLine Tool—Overlays a line.
Broken LineBroken Line Tool—Overlays a broken line.
Freehand LineFreehand Line Tool—Overlays a freehand line.
Rotated RectangleRotated Rectangle Tool—Overlays a rotated rectangle.
OvalOval Tool—Overlays an oval.
PolygonPolygon Tool—Overlays a polygon.
Freehand RegionFreehand Region Tool—Overlays a freehand region.
BitmapBitmap Tool—Overlays a bitmap.
TextText Tool—Overlays text.
  • Overlays—Lists the overlay elements that you create.
  • Delete—Deletes the selected overlay element.

Line Parameters

  • Start Point—Point coordinates that define the starting point of the line.
    • X—X-coordinate of the start point.
    • Y—Y-coordinate of the start point.
  • End Point—Point coordinates that define the ending point of the line.
    • X—X-coordinate of the end point.
    • Y—Y-coordinate of the end point.
  • Color—Color of the overlay.

Broken Line Parameters

  • Points—Array of point coordinates that define the ends of the line.
    • X—X-coordinate of a point in the array.
    • Y—Y-coordinate of a point in the array.
  • Color—Color of the overlay.

Freehand Line Parameters

  • Points—Array of point coordinates that define the ends of the line.
    • X—X-coordinate of a point in the array.
    • Y—Y-coordinate of a point in the array.
  • Color—Color of the overlay.

Rotated Rectangle Parameters

  • Left—X-coordinate of the upper left corner of the rectangle.
  • Top—Y-coordinate of the upper left corner of the rectangle.
  • Right—X-coordinate of the bottom right corner of the rectangle.
  • Bottom—Y-coordinate of the bottom right corner of the rectangle.
  • Rotation—Rotation angle, in degrees, of the rectangle with its center as point of rotation. If the rotation angle does not equal 0, the Left, Top, Right, and Bottom coordinates are not the actual coordinates of the upper left and bottom right corner of the rectangle, but their positions if the rotation angle equaled 0.
  • Drawing Mode—Specifies whether to draw only the frame of the rectangle or fill the rectangle with color.
  • Color—Color of the overlay.

Oval Parameters

Note  The position of an oval is specified by the coordinates of the bounding rectangle that contains the oval.
  • Left—X-coordinate of the upper left corner of the bounding rectangle.
  • Top—Y-coordinate of the upper left corner of the bounding rectangle.
  • Right—X-coordinate of the bottom right corner of the bounding rectangle.
  • Bottom—Y-coordinate of the bottom right corner of the bounding rectangle.
  • Drawing Mode—Specifies whether to draw only the frame of the oval or fill the oval with color.
  • Color—Color of the overlay.

Polygon and Freehand Region Parameters

  • Points—Array of point coordinates that define the ends of the line.
    • X—X-coordinate of a point in the array.
    • Y—Y-coordinate of a point in the array.
  • Drawing Mode—Specifies whether to draw only the frame of the polygon or fill the polygon with color.
  • Color—Color of the overlay.

Bitmap Parameters

  • Image File Path—Complete pathname—including drive, directory, and filename—of the bitmap to overlay.
  • Insertion Point—Location in the image where the top, left point of the bitmap is overlaid.
    • X—X-coordinate of the point.
    • Y—Y-coordinate of the point.
  • Use Keying Color—Specifies whether to use a keying color.
  • Keying Color—Color in the overlaid bitmap that you want to be transparent.

Text Parameters

  • Text—Text to overlay.
  • Text Properties Text Properties—Launches a dialog box in which you select the specific font characteristics of the text to overlay.
  • Origin—Location in the image where the bottom, left point of the first character is overlaid.
    • X—X-coordinate of the point.
    • Y—Y-coordinate of the point.
  • Text Color—Color of the text.
  • Background Color—Color of the text background.

Layer Management Tab

The following controls are available on the Layer Management tab.

  • Overlay Elements—Lists the overlay elements created. You can use the Up and Down buttons to arrange the order in which elements are overlaid on the image. The first overlay element in the list is the topmost layer.
  • Color—Foreground color of the selected overlay element.
  • X—X-coordinate location of the first point of the selected overlay element.
  • Y—Y-coordinate location of the first point of the selected overlay element.
    Note  When you modify the x-coordinate and y-coordinates of an element shown in the Overlay Elements table, the coordinates of the other points in the element are offset by the same amount so that the element maintains its shape.
  • Up—Moves the selected overlay element up the drawing order.
  • Down—Moves the selected overlay element down the drawing order.
  • Delete—Deletes the selected overlay element.