Back to Aurora Vision Library Lite website
You are here: Start » All Functions » Image Drawing » DrawShapeRegions_TwoColors
DrawShapeRegions_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 shape regions on an image with two colors, depending on the status of each region.
Applications: Usually: green or red for pass/fail status.
Syntax
void avs::DrawShapeRegions_TwoColors ( const avl::Image& inImage, atl::Conditional<const atl::Array<atl::Conditional<avl::ShapeRegion>>&> inRois, atl::Optional<const avl::CoordinateSystem2D&> inRegionAlignment, 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 | |
---|---|---|---|---|
inImage | const Image& | Input image | ||
inRois | Conditional<const Array<Conditional<ShapeRegion>>&> | { } | ||
inRegionAlignment | 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
Read more about In-place Computation.
Description
The operation draws an array of shape regions on the inImage using common drawing parameters for all of them.
Regions may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.
Hints
- If you want to draw on an empty background, use EmptyImage function before.
- Define inRois. 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
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | The sizes inRois and inConditions do not match in DrawShapeRegions_TwoColors. |
See Also
- DrawBox – Draws a box on an image.
- DrawRectangle – Draws a rectangle on an image.
- DrawCircle – Draws a circle on an image.
- DrawRegion – Draws a region on an image.