Back to Adaptive Vision Library Lite website

You are here: Start » Region Basics » CreatePolygonRegion


Header: AVL.h
Namespace: avl

Creates a polygonal region corresponding to a given closed path.


void avl::CreatePolygonRegion
	const avl::Path& inPolygon,
	atl::Optional<const avl::CoordinateSystem2D&> inPolygonAlignment,
	int inFrameWidth,
	int inFrameHeight,
	avl::Region& outRegion,
	atl::Optional<avl::Path&> outAlignedPolygon = atl::NIL


Name Type Range Default Description
inPolygon const Path&
inPolygonAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the polygon to the position of the inspected object
inFrameWidth int 0 - 65535 Width of the created region's frame
inFrameHeight int 0 - 65535 Height of the created region's frame
outRegion Region& Output region
outAlignedPolygon Optional<Path&> NIL The input polygon transformed to the absolute coordinate system

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outAlignedPolygon.

Read more about Optional Outputs.


The operation creates a region containing pixels lying inside the shape described by inPolygon.

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 polygon exceeds these dimensions, the output region will be cropped.


  • Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.



  • inPolygon has to be a closed path, otherwise an error with appropriate description occurs.


List of possible exceptions:

Error type Description
DomainError Open path on input in CreatePolygonRegion.

See Also

  • CreateBoxRegion – Creates a rectangular region corresponding to a given box.