You are here: Start » AVL.NET » AVL.CreatePolygonRegion Method

AVL.CreatePolygonRegion Method

Creates a polygonal region corresponding to a given closed path.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

public static void CreatePolygonRegion(
	AvlNet.Path inPolygon,
	AvlNet.CoordinateSystem2D? inPolygonAlignment,
	int inFrameWidth,
	int inFrameHeight,
	out AvlNet.Region outRegion,
	out AvlNet.Path outAlignedPolygon
)

Parameters

Name Type Range Default Description
inPolygonAvlNet.Path
inPolygonAlignmentAvlNet.CoordinateSystem2D?Adjusts the polygon to the position of the inspected object. Default value: atl::NIL, or null.
inFrameWidthint<0, INF>Width of the created region's frame.
inFrameHeightint<0, INF>Height of the created region's frame.
outRegionAvlNet.RegionOutput region.
outAlignedPolygonAvlNet.PathThe input polygon transformed to the absolute coordinate system

Description

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.

Examples

Remarks

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

Errors

Error type Description
DomainError Open path on input in CreatePolygonRegion.
DomainError Output region too big in CreatePolygonRegion.

See also