Back to Aurora Vision Studio website

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

DrawShapeRegions_MultiColor


Module: FoundationLite

Draws shape regions on an image with multiple colors.

Name Type Description
Input value inImage Image Input image
Input value inRois ShapeRegion?Array?
Input value inRegionAlignment 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

The operation draws an array of shape regions on the inImage using common drawing parameters for all of them. Regions may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.

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 inRois This will be the primitives to be drawn.
  • Leave the inPalette and inColorIds not set to have all the primitives drawn with random colors. Set a custom array 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

Description of usage of this filter can be found in examples and tutorial: Blister Inspection (NET GmbH).

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

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawShapeRegions filter group.

See Also