Back to Aurora Vision Library website

You are here: Start » Function Reference » Region » Region Spatial Transforms » AlignRegion

AlignRegion


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Aligns a region to a coordinate system.

Applications: Most typically used, when there is a region extracted after performing CropImageToRectangle. This filter makes it possible to align the region with the original image.

Syntax

C++
C#
 
void avl::AlignRegion
(
	const avl::Region& inRegion,
	const avl::CoordinateSystem2D& inAlignment,
	bool inInverse,
	atl::Optional<int> inFrameWidth,
	atl::Optional<int> inFrameHeight,
	avl::Region& outAlignedRegion
)

Parameters

Name Type Range Default Description
Input value inRegion const Region& Input region
Input value inAlignment const CoordinateSystem2D& Coordinate system to align to
Input value inInverse bool Switches to the inverse transform
Input value inFrameWidth Optional<int> 0 - 65535 NIL Output region's frame width
Input value inFrameHeight Optional<int> 0 - 65535 NIL Output region's frame height
Output value outAlignedRegion Region&

In-place Processing

This function supports in-place data processing - you can pass the same reference to inRegion and outAlignedRegion

Read more about In-place Computation.

Description

AlignRegion applies inAlignment transform to an input region.

Examples

AlignRegion performed on the sample region, inAlignment.Origin = (280, -120), inAlignment.Angle = 45, inAlignment.Scale = 1.0 and inInverse = False. The inAlignment.Origin is drawn on the first image in blue.

Remarks

Region is a pixel-precise object, so geometrical transform may cause its deformation. Consider using a closed Path instead, which can be converted to a region in the last step.

See Also

  • MirrorRegion – Mirrors a region across vertical or horizontal axis.
  • TransposeRegion – Flips and rotates a region so that x-coordinates are exchanged with y-coordinates.
  • RotateRegion – Rotates a region around a specified point.