Back to Adaptive Vision Library website
You are here: Start » Function Reference » Image Drawing » DrawSegments_TwoColors
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Draws segments on an image with two colors, depending on the status of each segment (usually: green or red for pass/fail status).
Syntax
void avs::DrawSegments_TwoColors ( const avl::Image& inImage, const atl::Conditional<atl::Array<atl::Conditional<avl::Segment2D> > >& inSegments, atl::Optional<const avl::CoordinateSystem2D&> inSegmentAlignment, const avl::Pixel& inColorIfTrue, const avl::Pixel& inColorIfFalse, const atl::Conditional< atl::Array<atl::Conditional<bool> > >& inConditions, const avl::DrawingStyle& inDrawingStyle, const avl::MarkerType::Type& inMarkerType, const float inMarkerSize, const bool inForceRgb, avl::Image& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | Input image | |||
inSegments | const Conditional<Array<Conditional<Segment2D> > >& | { } | |||
inSegmentAlignment | 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 | const Conditional< Array<Conditional<bool> > >& | { } | |||
inDrawingStyle | const DrawingStyle& | DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f ) | |||
inMarkerType | const MarkerType::Type& | Arrow | |||
inMarkerSize | const float | 0.0 - | 5.0f | ||
inForceRgb | const bool | True | Filter will convert monochromatic image to RGB if needed | ||
outImage | Image& | Output image |
Description
The operation draws an array of segments on the inImage using common drawing parameters for all of them. Segments may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.
Hints
- Define inSegments. 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
Errors
Error type | Description |
---|---|
DomainError | Inconsistent input array sizes in DrawSegments_TwoColors. |