Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Image Drawing » DrawPoints_TwoColors

DrawPoints_TwoColors


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: AVL.h
Namespace: avs

Draws points on an image with two colors, depending on the status of each point.

Applications: Usually: green or red for pass/fail status.

Syntax

void avs::DrawPoints_TwoColors
(
	const avl::Image& inImage,
	atl::Conditional<const atl::Array<atl::Conditional<avl::Point2D>>&> inPoints,
	atl::Optional<const avl::CoordinateSystem2D&> inPointAlignment,
	const avl::Pixel& inColorIfTrue,
	const avl::Pixel& inColorIfFalse,
	atl::Conditional<const atl::Array<atl::Conditional<bool>>&> inConditions,
	const avl::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inPoints Conditional<const Array<Conditional<Point2D>>&> { }
Input value inPointAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColorIfTrue const Pixel& Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f )
Input value inColorIfFalse const Pixel& Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f )
Input value inConditions Conditional<const Array<Conditional<bool>>&> { }
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Output value outImage Image& Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Read more about In-place Computation.

Description

The operation draws an array of points on the inImage image using common drawing parameters for all of them. The points may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.

Hints

  • Define inPoints. 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

Example usage of the DrawPoints_TwoColors on an empty image.

Errors

List of possible exceptions:

Error type Description
DomainError The sizes inPoints and inConditions do not match in DrawPoints_TwoColors.

See Also

  • DrawLine – Draws a line on an image.
  • DrawPath – Draws a path on an image.