Back to Aurora Vision Studio website

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

DrawRectangles_MultiColor

Advanced

Module: FoundationLite

Draws rectangles on an image with multiple colors.

Name Type Description
Input value inImage Image Input image
Input value inRectangles Rectangle2D?Array?
Input value inRectangleAlignment CoordinateSystem2D*
Input value inColorIds Hash?Array*
Input value inPalette PixelArray*
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.
  • Leave inPalette and inColorIds not set to have all the primitives drawn with random colors. Set a custom palette of colors here to decide explicitly how each of the primitives should be drawn using inColorIds.
  • 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: Bottle Inspector Part 3: Foam Detection.

Example usage of the DrawRectangles_MultiColor on an empty image.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty inPalette while inRectangles has objects to draw in DrawRectangles_MultiColor.
DomainError No palette defined with inPalette for specified inColorIds in DrawRectangles_MultiColor.
DomainError The sizes inRectangles and inColorIds do not match in DrawRectangles_MultiColor.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawRectangles filter group.

See Also