Back to Adaptive Vision Library website
You are here: Start » Function Reference » Image Drawing » DrawRegionsOfInterest_Palette
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Draws regions of interest on an image with multiple colors.
Header: | AVL.h |
---|
Syntax
void avs::DrawRegionsOfInterest_Palette ( const avl::Image& inImage, const atl::Conditional<atl::Array<atl::Conditional<avl::RegionOfInterest> > >& inRois, atl::Optional<const avl::CoordinateSystem2D&> inRegionAlignment, const atl::Optional<atl::Array<avl::Pixel> >& inColors, const float inOpacity, const bool inForceRgb, avl::Image& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | Input image | |||
inRois | const Conditional<Array<Conditional<RegionOfInterest> > >& | { } | |||
inRegionAlignment | Optional<const CoordinateSystem2D&> | NIL | |||
inColors | const Optional<Array<Pixel> >& | NIL | |||
inOpacity | const float | 0.0 - 1.0 | 1.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 regions of interest 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.
- Leave the inColors input not set to have all the primitives drawn with random colors. Set a custom array of colors here to decide explicitly how each of the primitives should be drawn.
- Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.
Examples
See Also
- DrawBox – Draws a box on an image.
- DrawCircle – Draws a circle on an image.
- DrawRectangle – Draws a rectangle on an image.
- DrawRegion – Draws a region on an image.