Back to Adaptive Vision Library website

You are here: Start » Function Reference » Region Basics » CreateRingRegion

CreateRingRegion


Creates a ring-shaped region with given parameters.

Syntax

C++
C#
 
void avl::CreateRingRegion
(
	const avl::Circle2D& inCircle,
	atl::Optional<const avl::CoordinateSystem2D&> inCircleAlignment,
	float inRingWidth,
	avl::BorderPosition::Type inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	avl::Region& outRegion,
	atl::Optional<avl::Circle2D&> outAlignedCircle = atl::NIL
)

Parameters

Name Type Range Default Description
inCircle const Circle2D& Input circle
inCircleAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the circle to the position of the inspected object
inRingWidth float 0.0 - 1.0f
inBorderPosition BorderPosition::Type Centered
inFrameWidth int 0 - Width of the created region's frame
inFrameHeight int 0 - Height of the created region's frame
outRegion Region& Output region
outAlignedCircle Optional<Circle2D&> NIL The input circle transformed to the absolute coordinate system

Errors

Error type Description
DomainError Incorrect BorderPosition in CreateRingRegion.