Back to Adaptive Vision Library website
You are here: Start » Function Reference » Region Basics » CreateCircleRegion
Creates a circular region corresponding to a given circle.
Syntax
C++
C#
void avl::CreateCircleRegion ( const avl::Circle2D& inCircle, atl::Optional<const avl::CoordinateSystem2D&> inCircleAlignment, int inFrameWidth, int inFrameHeight, avl::Region& outRegion, atl::Optional<avl::Circle2D&> outAlignedCircle = atl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inCircle | const Circle2D& | ||||
inCircleAlignment | Optional<const CoordinateSystem2D&> | NIL | Adjusts the circle to the position of the inspected object | ||
inFrameWidth | int | 0 - | Width of the created region's frame (not to be confused with the size of the circle!) | ||
inFrameHeight | int | 0 - | Height of the created region's frame (not to be confused with the size of the circle!) | ||
outRegion | Region& | Output region | |||
outAlignedCircle | Optional<Circle2D&> | NIL | The input circle transformed to the absolute coordinate system |
Description
The operation creates a region containing pixels lying inside the given circle.
The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input circle exceeds these dimensions, the output region will be cropped.
Hints
- Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.