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

AlignRegion

Header:	FIL.h
Namespace:	fil
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

void fil::AlignRegion
(
	const fil::Region& inRegion,
	const fil::CoordinateSystem2D& inAlignment,
	bool inInverse,
	ftl::Optional<int> inFrameWidth,
	ftl::Optional<int> inFrameHeight,
	fil::Region& outAlignedRegion
)

Parameters

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

In-place Processing

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

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.