Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Drawing » DrawDimensionLines_MultiColor

DrawDimensionLines_MultiColor


Module: FoundationLite

Draws dimension lines on an image with multiple colors.

Name Type Range Description
Input value inImage Image Input image
Input value inSegments Segment2D?Array?
Input value inSegmentAlignment CoordinateSystem2D*
Input value inColorIds Hash?Array*
Input value inPalette PixelArray*
Input value inDrawingStyle DrawingStyle
Input value inHeadSize Real 0.0 -
Input value inScale Real 0.0 - px / mm
Input value inMetricUnit MetricUnit
Input value inFractionalDigitCount Integer 0 - 100 How many characters the fractional part of the number should have
Input value inTextSize Real 10.0 -
Input value inForceRgb Bool Filter will convert monochromatic image to RGB if needed
Output value outImage Image Output image

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 inSegments. 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

Example usage of the DrawDimensionLines_MultiColor on an empty image.

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 inSegments has objects to draw in DrawDimensionLines_MultiColor.
DomainError No palette defined with inPalette for specified inColorIds in DrawDimensionLines_MultiColor.
DomainError The sizes inSegments and inColorIds do not match in DrawDimensionLines_MultiColor.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawDimensionLines filter group.