Start » Filter Reference » Image » Image Drawing » DrawCircles_MultiColor
Module: | FoundationLite |
---|
Draws circles on an image with multiple colors.
Name | Type | Description | |
---|---|---|---|
inImage | Image | Input image | |
inCircles | Circle2D?Array? | ||
inCircleAlignment | 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 circles on the inImage using common drawing parameters for all of them.
Circles 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 inCircles. This will be the primitives to be drawn.
- Leave inPalette and inColorIds not set to have all the primitives drawn with random colors. Set a custom palette 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.
- Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.
Examples
Description of usage of this filter can be found in examples and tutorial: Fertilizer Granulation, Fuses.
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 inCircles has objects to draw in DrawCircles_MultiColor. |
DomainError | No palette defined with inPalette for specified inColorIds in DrawCircles_MultiColor. |
DomainError | The sizes inCircles and inColorIds do not match in DrawCircles_MultiColor. |
Complexity Level
This filter is available on Advanced Complexity Level.
Filter Group
This filter is member of DrawCircles filter group.
See Also
- DrawPoints – group of filters.
- DrawLines – group of filters.