Back to FabImage Library website

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

DrawShapeRegions_TwoColors_Deprecated


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 ShapeRegion objects on an image with two colors, depending on the status of each ShapeRegion.

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

Syntax

void fis::DrawShapeRegions_TwoColors_Deprecated
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::ShapeRegionDeprecated> > &> inShapeRegions,
	ftl::Optional<const fil::CoordinateSystem2D&> inShapeRegionAlignment,
	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
Input value inImage const Image& Input image
Input value inShapeRegions Conditional<const Array<Conditional<ShapeRegionDeprecated> > &> { }
Input value inShapeRegionAlignment 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&
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.

Hints

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

Examples

Example usage of the DrawShapeRegions_TwoColors_Deprecated on an empty image.

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent input array sizes in DrawShapeRegions_TwoColors_Deprecated.