Start » Filter Reference » Image » Image Drawing » DrawRectangles_TwoColors
Module: | FoundationLite |
---|
Draws rectangles on an image with two colors, depending on the status of each rectangle.
Applications
Usually: green or red for pass/fail status.
Name | Type | Description | |
---|---|---|---|
inImage | Image | Input image | |
inRectangles | Rectangle2D?Array? | ||
inRectangleAlignment | 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
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.
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 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.
- Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.
Examples
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 inRectangles and inConditions do not match in DrawRectangles_TwoColors. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filter is member of DrawRectangles filter group.
See Also
- DrawLines – group of filters.
- DrawPaths – group of filters.
- DrawCircles – group of filters.
- DrawPoints – group of filters.