You are here: Start » Function Reference » All Functions » Image Drawing » DrawCircles_TwoColors

DrawCircles_TwoColors

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

Header:	FIL.h
Namespace:	fis
Module:	FoundationLite

Draws circles on an image with two colors, depending on the status of each circle.

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

Syntax

void fis::DrawCircles_TwoColors
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Circle2D>>&> inCircles,
	ftl::Optional<const fil::CoordinateSystem2D&> inCircleAlignment,
	const fil::Pixel& inColorIfTrue,
	const fil::Pixel& inColorIfFalse,
	ftl::Conditional<const ftl::Array<ftl::Conditional<bool>>&> inConditions,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

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

In-place Processing

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

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

Define inCircles. 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 DrawCircles_TwoColors on an empty image.

Errors

List of possible exceptions:

Error type	Description
DomainError	The sizes inCircles and inConditions do not match in DrawCircles_TwoColors.