Start » Filter Reference » Image » Image Drawing » DrawBoxes_TwoColors
Module: | FoundationLite |
---|
Draws boxes on an image with two colors, depending on the status of each box.
Applications
Usually: green or red for pass/fail status.
Name | Type | Range | Description | |
---|---|---|---|---|
inImage | Image | Input image | ||
inBoxes | Box?Array? | |||
inColorIfTrue | Pixel | |||
inColorIfFalse | Pixel | |||
inConditions | Bool?Array? | |||
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
- 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 inBoxes. 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
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 of inBoxes and inConditions do not match in DrawBoxes_TwoColors. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filter is member of DrawBoxes filter group.
See Also
- DrawRegions – group of filters.