Back to Adaptive Vision Studio website

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

DrawBoxes_MultiColor

Advanced

Module: FoundationLite

Draws boxes on an image with multiple colors.

Name Type Range Description
inImage Image Input image
inBoxes Box?Array?
inColorIds Hash?Array*
inPalette PixelArray*
inOpacity Real 0.0 - 1.0
inForceRgb Bool Filter will convert monochromatic image to RGB if needed
outImage Image Output image

Description

The operation draws an array of boxes on the inImage using common drawing parameters for all of them. Boxes may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed. Note that drawing is conducted in a pixel-precise way as the Box type is pixel-precise.

Hints

  • If you want to draw on an empty background, use EmptyImage filter before.
  • Define inBoxes. 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.

Examples

Example usage of the DrawBoxes_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 inBoxes has objects to draw in DrawBoxes_MultiColor.
DomainError No palette defined with inPalette for specified inColorIds in DrawBoxes_MultiColor.
DomainError The sizes inBoxes and inColorIds do not match in DrawBoxes_MultiColor.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawBoxes filter group.

See Also