Back to Aurora Vision Studio website
You are here: Start » Filter Reference » Image » Image Drawing » DrawShapeRegions_TwoColors
Module: | FoundationLite |
---|
Draws shape regions on an image with two colors, depending on the status of each region.
Applications
Usually: green or red for pass/fail status.
Name | Type | Description | |
---|---|---|---|
inImage | Image | Input image | |
inRois | ShapeRegion?Array? | ||
inRegionAlignment | CoordinateSystem2D* | ||
inColorIfTrue | Pixel | ||
inColorIfFalse | Pixel | ||
inConditions | Bool?Array? | ||
inDrawingStyle | DrawingStyle | ||
inForceRgb | Bool | Filter will convert monochromatic image to RGB if needed | |
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.
- Define inConditions with the boolean values indicating the class (usually: OK/NOK) for each input primitive.
- Set the inColorIfTrue and inColorIfFalse inputs to define the two colors used for drawing.
- 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: Button Presence.
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 | The sizes inRois and inConditions do not match in DrawShapeRegions_TwoColors. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filter is member of DrawShapeRegions filter group.
See Also
- DrawBoxes – group of filters.
- DrawRectangles – group of filters.
- DrawCircles – group of filters.
- DrawRegions – group of filters.