Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Drawing » DrawRectangles_SingleColor

DrawRectangles_SingleColor

Basic

Module: FoundationLite

Draws rectangles on an image with a single color.

Name Type Description
Input value inImage Image Input image
Input value inRectangles Rectangle2D?Array?
Input value inRectangleAlignment CoordinateSystem2D*
Input value inColor Pixel
Input value inDrawingStyle DrawingStyle
Input value inForceRgb Bool Filter will convert monochromatic image to RGB if needed
Output value outImage Image Output image

Description

Filter draws rectangles on an input image.

If an rectangle dimensions exceeds image size it will not be drawn or will be drawn partially.

To indicate the Rectangle orientation set inDrawingStyle.PointShape and inDrawingStyle.Size.

Rectangle drawn with set orientation indicator inDrawingStyle.PointShape = Circle and inDrawingStyle.Size = 10.

Hints

  • Connect an image source to the inImage input. Drawing will be done on this image.
    • If you want to draw on an empty background, use EmptyImage filter before.
  • Define inRectangles. This will be the primitives to be drawn.
  • Define inColor. Please note, that on an N-channel image only first N components of the color will be used.
  • Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.
  • Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.

Examples

Description of usage of this filter can be found in examples and tutorial: Cap (Easy), Dynamic Template Matching, Waffles, Cap (Advanced), Parallel Image Saving.

Example usage of the DrawRectangles_SingleColor on an empty image.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of DrawRectangles filter group.

See Also