Back to FabImage Studio website
You are here: Start » Filter Reference » Image » Image Drawing » DrawShapeRegions_MultiColor
Module: | FoundationLite |
---|
Draws shape regions on an image with multiple colors.
Name | Type | Description | |
---|---|---|---|
inImage | Image | Input image | |
inRois | ShapeRegion?Array? | ||
inRegionAlignment | CoordinateSystem2D* | ||
inColorIds | Hash?Array* | ||
inPalette | PixelArray* | ||
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.
- 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
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
- DrawBoxes – group of filters.
- DrawRectangles – group of filters.
- DrawCircles – group of filters.
- DrawRegions – group of filters.